Snyk Documentation

Installing the Snyk runtime agent for Java

Install the Snyk runtime agent for Java:

  1. Download the runtime agent from this link and unzip the archive.
  2. From the extracted files, copy snyk-java-runtime-agent.jar alongside your application files.
  3. Create a snyk-agent.properties file at the same location as the agent jar file. The properties file should contain the Snyk project ID. For example:
    projectId=0462e42b-c92f-4b48-bac8-81eb3ff7f43e
  4. Add the agent as a command-line argument to the Java command that you use to start your application. For example:
    java -javaagent:path/to/snyk-java-runtime-agent.jar -jar my-app.jar
  5. If you are using Apache Maven, add the following jar file to your Maven options environment variable as follows:
    -javaagent:path/to/snyk-java-runtime-agent.jar
  6. If you are using JavaEE containers such as GlassFish, add the following jar file to the JVM Options:
    -javaagent:path/to/snyk-java-runtime-agent.jar.
  7. Once you have successfully added the agent, logging begins to appear in the stderr (standard error) file shortly after the JVM (Java virtual machine) starts up, as in the following example:
snyk-agent initialisation: startup
snyk-agent initialisation: trying: /opt/app-1/agent/snyk-agent.properties
snyk-agent initialisation: switching logging to: /opt/app-1/agent/snyk-logs/agent-log-2001-02-03T04:05:06.log

Example of Java code when Snyk runtime agent is added successfully

Related topics