Monitoring Configuration

The monitoring data is gathered by the Kieker monitoring component. At the moment, we are only support monitoring Java applications. Other languages will appear shortly.

Version 1.3.0 and later (latest version)

Monitoring Setup

1. Download the monitoring example configuration (related Repo).

2. Currently the following Kieker aspects are configured:

• aspectj.operationExecution.FullInstrumentationNoGetterAndSetter (Java application calls)
• aspectj.database.Fullinstrumentation (JDBC related database calls)

Attention

This set up is provided to instrument directly executed Java applications. The set up for application servers is under revision right now and will be released later.

3. Start the monitoring: ./runMonitoredApplication.sh (Unix) or ./runMonitoredApplication.bat (Windows)

The monitoring script is running until termination.

First, the monitored application needs to be set within the script, e.g. -jar myApp.jar. Afterwards, the Kieker configuration has to be configured according to the following options.

Configuration Options

Monitoring scope

Path: META-INF/aop.{...}.xml

• Choose the packages, which should be monitored

  <include within="net.explorviz.sampleApplication..*"/>

• Exclude packages, which should not be monitored

  <exclude within="org.apache.commons.logging..*" />

Application name

Path: META-INF/kieker.monitoring.{...}.properties

• Change the name of the application

  kieker.monitoring.applicationName=sampleApplication

• Change the ip address of the ExplorViz server

  kieker.monitoring.writer.tcp.SingleSocketTcpWriter.hostname=localhost

  (only necessary, if the server and monitoring are running on different hosts)

Version 1.1.1 and earlier

Monitoring Setup

This section deals with the monitoring configuration regarding to which components of the software are analyzed and afterwards visualized.

1. Download the monitoring component from here.

2. The monitoring configuration file aop.xml resides in the folder META-INF which is stored in your application server’s (lib) folder.

3. Open the jar file with an extractor for example winzip or winrar. Navigate to the folder META-INF and extract the file aop.xml.

   Hint: You can use an editor to open the file.

4. Open the extracted file aop.xml and update the <include within="*"/> statement according to your needs. For instance replace it with: <include within="com.ibatis..*" /> to monitor only method calls in the com.ibatis package and its subpackages. Add further <include within="more.packages..*“/> statements below to include more than one package. The mentioned statement and especially the last advice is shown in the picture below.

5. After modifying the file just replace it in the jar file.

Configuration Options

1. The ExplorViz configuration file explorviz.live_trace_processing.default.properties also resides in the file explorviz-monitoring.jar which is stored in your server’s lib folder.

2. Open the jar file with an extractor for example with winzip or winrar. Navigate to the META-INF folder and extract the file explorviz.live_trace_processing.default.properties.

3. Open the extracted file explorviz.live_trace_processing.default.properties and look up the the options in the table below.

   Hint: You can use an editor to open the file. If you have formatting problems using windows editor alternatively use WordPad.

4. After modifying the file just replace it in the jar file.

Parameter	Default Value	Description
writer_target_ip	127.0.0.1	Defines the target ip where the analysis component/visualization server is running.
writer_target_port	10133	Defines the target port where the analysis component/visualization server is running.
writer_load_balancing_enabled	false	Used for cloud scaling. If true, the writer_target_ip paramter is ignored. Instead the monitoring queries the load balancer for an ip adress.
system_name	<UNKNOWN-SYSTEM>	The name of the system belonging to the application
ip_address	one ip address of the server	The IP address of the server where the application is running
host_name	hostname of the server	The hostname of the server where the application is running
application_name	<UNKNOWN-APPLICATION>	The displayed name of the application
programming_language	Java	The programming language of the application