Adding apminsight.conf properties as the JVM's application properties

Add APM Insight configuration properties as JVM system properties

The APM Insight Java agent allows you to specify the configuration properties from the apminsight.conf file as JVM system properties. This provides an alternative to maintaining configuration values in the configuration file.

This approach is especially useful when multiple Java applications are running on the same server. Instead of creating separate copies of the Java agent for each application, you can provide application-specific properties (such as the application name and agent server port) as JVM system properties while sharing the same agent installation.

Specify these properties along with the primary -javaagent argument by prefixing each property with -D.

Please find the names and examples of the properties below.

apminsight.conf file entry

System property key
Example/Format

license.key

apminsight.license.key
1234567890abcdef

application.name

apminsight.application.name
My Application

agent.server.port

apminsight.agent.server.port
8080

Proxy config

apminsight.agent.proxy
user:pswd@host:port

apminsight.log.dir

apminsight.log.dir
/usr/local/qa-123/logs
Notes
You can specify all or only the required configuration properties as JVM system properties.

Example:
  1. -javaagent:/usr/local/qa-123/site24x7/apminsight-javaagent.jar -Dapminsight.application.name=qa_zylker -Dapminsight.license.key=1234567890abcdef 
You can add additional JVM system properties in the same manner, for example:
  1. -Dapminsight.agent.server.port=8080 -Dapminsight.log.dir=/usr/local/qa-123/logs -Dapminsight.agent.proxy=user:password@proxy.example.com:8080


When should you use JVM system properties?

Using JVM system properties is recommended in the following scenarios:
  1. When multiple Java applications are running on the same server and share a single APM Insight Java agent installation.
  2. When you want to avoid maintaining multiple copies of the Java agent with different apminsight.conf files in the server.
  3. When application-specific configuration is managed as part of the application’s startup command or deployment process.

    • Related Articles

    • DC migration steps for APM Insight agents

      For Server based installations 1. Obtain the new device key. 2. Update the license.key value in the APM Insight configuration file (or the environment variable mentioned) with the new device key. The location varies for each agent, as listed below: ...

    • How to add APM Insight Java agent without application restart?

      In general, after installing the APM Insight Java agent, you have to restart your application for the agent to capture monitoring data. But in case of critical issues in the app, like sudden application slowness, where you haven't installed APM ...

    • How to rename an APM Insight application?

      Site24x7 APM Insight doesn't support renaming applications/monitors from the web client. However, the application name of an existing application instance can be renamed in the apminsight.conf file and the agent associated with that instance will ...

    • How to identify and resolve conflicts between other APM products and the APM Insight .NET agent

      Problem statement: You are experiencing either of the below issues and suspect that another APM product is interfering with the Site24x7 .NET agent. 1. The .NET monitor is not created under APM > APM Insight > Applications, even after the .NET agent ...

    • How to add a PHP instance that was deleted earlier

      For agent versions 4.0 and above For every instance, there will be a corresponding configuration file present inside the conf folder of the S247DataExporter installation path. Delete the appropriate configuration file and restart the S247DataExporter ...