Get Started (Supplemental)

In the following sections, learn how to get Java autoinstrumentation for specific technical environments.

Azure App Service

For more information, see Application monitoring for Azure App Service and Java.

Azure Functions

For more information, see Monitoring Azure Functions with Azure Monitor Application Insights.

Azure Spring Apps

For more information, see Use Application Insights Java In-Process Agent in Azure Spring Apps.

Containers

Docker entry point

If you're using the exec form, add the parameter -javaagent:"path/to/applicationinsights-agent-3.6.0.jar" to the parameter list somewhere before the "-jar" parameter, for example:

ENTRYPOINT ["java", "-javaagent:path/to/applicationinsights-agent-3.6.0.jar", "-jar", "<myapp.jar>"]

If you're using the shell form, add the Java Virtual Machine (JVM) arg -javaagent:"path/to/applicationinsights-agent-3.6.0.jar" somewhere before -jar, for example:

ENTRYPOINT java -javaagent:"path/to/applicationinsights-agent-3.6.0.jar" -jar <myapp.jar>

Docker file

A Dockerfile example:

FROM ...

COPY target/*.jar app.jar

COPY agent/applicationinsights-agent-3.6.0.jar applicationinsights-agent-3.6.0.jar 

COPY agent/applicationinsights.json applicationinsights.json

ENV APPLICATIONINSIGHTS_CONNECTION_STRING="CONNECTION-STRING"
        
ENTRYPOINT["java", "-javaagent:applicationinsights-agent-3.6.0.jar", "-jar", "app.jar"]

In this example, you copy the applicationinsights-agent-3.6.0.jar and applicationinsights.json files from an agent folder (you can choose any folder of your machine). These two files have to be in the same folder in the Docker container.

Partner container images

If you're using a partner container image that you can't modify, mount the Application Insights Java agent jar into the container from outside. Set the environment variable for the container JAVA_TOOL_OPTIONS=-javaagent:/path/to/applicationinsights-agent.jar.

Spring Boot

For more information, see Using Azure Monitor Application Insights with Spring Boot.

Java Application servers

For information on setting up the Application Insights Java agent, see Enabling Azure Monitor OpenTelemetry for Java. The following sections provide details that might be helpful when configuring the -javaagent:... JVM arg on different application servers.

Tomcat 8 (Linux)

Tomcat installed via apt-get or yum

If you installed Tomcat via apt-get or yum, you should have a file /etc/tomcat8/tomcat8.conf. Add this line to the end of that file:

JAVA_OPTS="$JAVA_OPTS -javaagent:path/to/applicationinsights-agent-3.6.0.jar"

Tomcat installed via download and unzip

If you installed Tomcat via download and unzip from https://tomcat.apache.org, you should have a file <tomcat>/bin/catalina.sh. Create a new file in the same directory named <tomcat>/bin/setenv.sh with the following content:

CATALINA_OPTS="$CATALINA_OPTS -javaagent:path/to/applicationinsights-agent-3.6.0.jar"

If the file <tomcat>/bin/setenv.sh already exists, modify that file and add -javaagent:path/to/applicationinsights-agent-3.6.0.jar to CATALINA_OPTS.

Tomcat 8 (Windows)

Run Tomcat from the command line

Locate the file <tomcat>/bin/catalina.bat. Create a new file in the same directory named <tomcat>/bin/setenv.bat with the following content:

set CATALINA_OPTS=%CATALINA_OPTS% -javaagent:path/to/applicationinsights-agent-3.6.0.jar

Quotes aren't necessary, but if you want to include them, the proper placement is:

set "CATALINA_OPTS=%CATALINA_OPTS% -javaagent:path/to/applicationinsights-agent-3.6.0.jar"

If the file <tomcat>/bin/setenv.bat already exists, modify that file and add -javaagent:path/to/applicationinsights-agent-3.6.0.jar to CATALINA_OPTS.

Run Tomcat as a Windows service

Locate the file <tomcat>/bin/tomcat8w.exe. Run that executable and add -javaagent:path/to/applicationinsights-agent-3.6.0.jar to the Java Options under the Java tab.

JBoss Enterprise Application Platform 7

In Red Hat JBoss Enterprise Application Platform (EAP) 7, you can set up a standalone server or a domain server.

Standalone server

Add -javaagent:path/to/applicationinsights-agent-3.6.0.jar to the existing JAVA_OPTS environment variable in the file JBOSS_HOME/bin/standalone.conf (Linux) or JBOSS_HOME/bin/standalone.conf.bat (Windows):

    JAVA_OPTS="-javaagent:path/to/applicationinsights-agent-3.6.0.jar -Xms1303m -Xmx1303m ..."
    ...

Domain server

Add -javaagent:path/to/applicationinsights-agent-3.6.0.jar to the existing jvm-options in JBOSS_HOME/domain/configuration/host.xml:

...
<jvms>
    <jvm name="default">
        <heap size="64m" max-size="256m"/>
        <jvm-options>
            <option value="-server"/>
            <!--Add Java agent jar file here-->
            <option value="-javaagent:path/to/applicationinsights-agent-3.6.0.jar"/>
            <option value="-XX:MetaspaceSize=96m"/>
            <option value="-XX:MaxMetaspaceSize=256m"/>
        </jvm-options>
    </jvm>
</jvms>
...

If you're running multiple managed servers on a single host, you need to add applicationinsights.agent.id to the system-properties for each server:

...
<servers>
    <server name="server-one" group="main-server-group">
        <!--Edit system properties for server-one-->
        <system-properties> 
            <property name="applicationinsights.agent.id" value="..."/>
        </system-properties>
    </server>
    <server name="server-two" group="main-server-group">
        <socket-bindings port-offset="150"/>
        <!--Edit system properties for server-two-->
        <system-properties>
            <property name="applicationinsights.agent.id" value="..."/> 
        </system-properties>
    </server>
</servers>
...

The specified applicationinsights.agent.id value must be unique. You use the value to create a subdirectory under the Application Insights directory. Each JVM process needs its own local Application Insights config and local Application Insights log file. Also, if reporting to the central collector, multiple managed servers share the applicationinsights.properties file, so the specified applicationinsights.agent.id is needed to override the agent.id setting in that shared file. The applicationinsights.agent.rollup.id can be similarly specified in the server's system-properties if you need to override the agent.rollup.id setting per managed server.

Jetty 9

Add these lines to start.ini:

--exec
-javaagent:path/to/applicationinsights-agent-3.6.0.jar

Payara 5

Add -javaagent:path/to/applicationinsights-agent-3.6.0.jar to the existing jvm-options in glassfish/domains/domain1/config/domain.xml:

...
<java-config ...>
    <!--Edit the JVM options here-->
    <jvm-options>
        -javaagent:path/to/applicationinsights-agent-3.6.0.jar>
    </jvm-options>
        ...
</java-config>
...

WebSphere 8

1. Open Management Console.

2. Go to Servers > WebSphere application servers > Application servers. Choose the appropriate application servers and select Java and Process Management > Process definition > Java Virtual Machine.

3. In Generic JVM arguments, add the following JVM argument.

   -javaagent:path/to/applicationinsights-agent-3.6.0.jar
   

4. Save and restart the application server.

OpenLiberty 18

Create a new file jvm.options in the server directory (for example, <openliberty>/usr/servers/defaultServer), and add this line:

-javaagent:path/to/applicationinsights-agent-3.6.0.jar

Others

See your application server documentation on how to add JVM args.