Configure Spring Insight Operations

You configure Spring Insight Operations by editing the insight.properties files for each Spring Insight Dashboard and Spring Insight Agent instance. The insight.properties file is a standard Java properties file. Each property is on its own line. Properties have the form property: value. Comments begin with #. The properties differ for Spring Insight Dashboard and Spring Insight Agent.

Prerequisites

Procedure

  1. On the computer that is running Spring Insight Dashboard, edit the insight.properties file. Refer to the table in Properties File for Spring Insight Dashboard for information about valid property names and values.

    For example: /home/tcserver/tc-server-standard-edition/myInstance/insight/insight.properties

    Restart the tc Runtime instance after saving your edits.

  2. On a computer that is running Spring Insight Agent, edit the insight.properties file. Refer to the table in Properties File for Spring Insight Agent for information about valid property names and values.

    For example: /home/tcserver/tc-server-standard-edition/myInstance/insight/insight.properties

    Restart the tc Runtime instance after saving your edits.

  3. Repeat step 2 to edit the insight.properties file for each tc Server instance that is running Spring Insight Agent.

Properties File for Spring Insight Dashboard

You set properties for an Insight Dashboard instance in the insight.properties file for that instance.

Note

Regarding the database properties in the table, Spring Insight bundles the H2 Java SQL database and uses it internally to persist its data. A tc Runtime instance configured with Spring Insight is automatically configured to connect to and use the H2 database.

Table 4. Properties of the Spring Insight Dashboard insight.properties File

PropertyDescription
insight.data.dirFull pathname of the directory in which Spring Insight persists its data. Default: INSTANCE_DIR/insight/data.
dashboard.jms.data.dirDirectory in which JMS data is persisted. This property appears only in the insight.properties files for Insight Dashboard.
dashboard.jms.bind.uriProtocol, host name or IP number, and port number for the Insight Dashboard instance to which Insight Agent instances connect and send application trace data. This property appears only in the insight.properties files for Insight Dashboard. The property corresponds to the dashboard.jms.connect.uri property in the Insight Agent insight.properties file.

You specify the value for this parameter in the format protocol://host:port.

  • protocol:tcp, nio, or ssl.

  • host: Computer name or IP number of the host where the Dashboard instance is executing.

  • port: Port number for the connection. The default port is 21234.

agent.auth.loginLogin name and password an Agent instance uses to log in to a Dashboard instance. The login portion of the property is the login name. The value is the password. The default, which specifies the login name agent and password insight is:

agent.auth.agent: insight

Customizing login names does not modify the names of agents connecting to Insight Dashboard, only their ability to connect to the Dashboard. The ability to modify settings is useful if you are managing several deployment environments through a single Dashboard instance and want to selectively enable or disable connections from sets of agents, based on the login they use.

application.context. ignore.identifier(Optional) Application contexts that you want Spring Insight to ignore. Spring Insight does not instrument these applications, which improves the startup time of the application.

The default insight.properties file excludes the Spring Insight application itself from being instrumented by adding the following entry:

application.context.ignore.dashboard: localhost|insight

The identifier part of the property name (such as dashboard in the example above) is not used internally by Spring Insight but must be unique within the properties file. Use this part of the property name to separate multiple entries. Specify an identifier that has meaning to you.

The value of this property must be of the form localhost|context where context refers to the URL context that invokes the application. The value of context refers to the URL context you specify in a browser to invoke the application. By default, this is the name of the WAR file in which the application is packaged, but you can specify a different name in the web.xml file.

The following example ignores the Tomcat Manager application, which has the application context manager.

application.context.ignore.mgr: localhost|manager

database.url

URL of the database that Spring Insight uses to persist its data. This value defaults to the H2 Java SQL database that is bundled with Spring Insight.

database.driverClassName

Class name of the JDBC Driver that Spring Insight uses to connect to the database. Default: org.h2.Driver.

database.usernameName of the user who connects to the database that Spring Insight uses to persist its data. Default: insight.
database.passwordPassword of the user who connects to the database that Spring Insight uses to persist its data. Default: admin.
trace.exclude.path.typeList of patterns that are matched against requests. When a trace matches a path in this list, the trace is discarded. This setting lets you ignore requests to static content such as .css or .js files. Specify this property multiple times, one for each type of pattern you want to exclude.

For example:

trace.exclude.path.png: /**/*.png trace.exclude.path.gif: /**/*.gif trace.exclude.path.jpg: /**/*.jpg trace.exclude.path.css: /**/*.css trace.exclude.path.js: /**/*.js


Properties File for Spring Insight Agent

You set properties for a Spring Insight Agent instance in the insight.properties file for that Instance.

Table 5. Properties of the Spring Insight Agent insight.properties File

PropertyDescription
dashboard.jms.connect.uriProtocol, host name or IP number, and port number of the Insight Dashboard instance to which Insight Agent instances connect and send application trace data. The property appears only in the insight.properties files for Agents and the value must match the dashboard.jms.bind.uri property in the Dashboard insight.properties file.

You specify the value for this property in the format protocol://host:port.

  • protocol:tcp, nio, or ssl.

  • host: Host name or IP number of the computer running the Dashboard instance.

  • port: Available port number for the connection. Default: 21234.

agent.auth and agent.auth.passwordCredentials used to connect to Insight Dashboard.

The value of agent.auth must match the login value of the agent.auth.login property in the Insight Dashboard insight.properties file. Default: agent .

The agent.auth.password is the value specified by the Insight Dashboard agent.auth.login property. Default: insight.
application.name.overrideName that overrides the default name for a deployed application in data sent to Insight Dashboard. This override can be useful when you deploy different applications with the same name on different Insight Agent instances. Multiple overrides are allowed. Overrides take the form application.name.override.hostName|contextName: hostName|contextName.

The initial hostName|contextName specifies the default application host and application context name. The second hostName|contextName are the host name and context name to substitute in data forwarded to Insight Dashboard.

Strip out forward slashes from context names.

agent.heartbeat.intervalFrequency, in seconds, with which the Insight Agent instance sends a heartbeat to Insight Dashboard. Default: 15.
agent.trace.bufferMaximum number of traces to store in memory before analysis. Default: 20000.
agent.traces.rate.initialInitial maximum number of traces to send per minute to Insight Dashboard. Default: 200.
agent.name.overrideUnique fixed ID for the Insight Agent instance. By default, the name is constructed from the hostname and pid of the Agent's JVM process. Therefore, Insight Dashboard treats each newly started Insight Agent instance as a new Agent, to accommodate rapidly changing application server clusters. If you prefer, you can set the value of this property to a fixed name for the Agent.
trace.filter.similar.per.hourRate per hour that similar traces are filtered. If a trace has the same end point and tag signature as another recent trace, it is not sent to Insight Dashboard. (Only one trace with a given signature will be sent every 5 minutes.) A value of 4 filters traces so that only one trace with a given signature is sent every 15 minutes. Default: 12.
application.context.ignoreApplication context that the Insight Agent should not instrument. Ignoring applications improves the startup time for the application. No traces for these applications are sent to Insight Dashboard. Multiple entries are allowed.

The format for this property is application.context.ignore.name: hostName|contextName.

name: Value that makes the property name unique in the properties file; for example, the context name for the application you want to ignore.

hostName and contextName: Host name of the application host and the application context name.

The Insight Agent application is automatically added, to prevent instrumenting and sending traces from the Agent application:

application.context.ignore.agent: localhost|insight-agent