AQG Java Tracer getting started guide↑

This guide explains how to use the AQG Java Tracer to obtain a cryptography trace from an application.

Prerequisites↑

Before using the AQG Java Tracer, make sure you’ve followed the installation instructions.

You’ll also need a Java application that you can run in a terminal with the java command. For other Java applications, refer to the AQG Java Tracer reference.

Tracing the application↑

Navigate to a directory where you have write permissions and execute your app with the java command as you typically would, but this time, include the -javaagent:/path/to/cs-java-tracer.jar command-line parameter.

For instance, you can run the following command if your application doesn’t require any other command-line parameters:

java -javaagent:/path/to/cs-java-tracer.jar -jar /path/to/application.jar

When your application has finished executing, the cs-tracer directory will contain the generated trace file(s):

cs-tracer
└── cs-trace_2022-06-02-13-30-53-113_79629.cst.gz

Note

When an application shuts down properly, the trace will stop and finalize before the shutdown process begins, meaning the shutdown itself will not be included in the trace. If the application is terminated abruptly, the resulting gzip file may be missing a trailer and appear corrupted. However, AQtive Guard should still be able to analyze the trace contents.

Tip

Additional configuration is required for Java applications launched from within application servers. See Using the tracer in application frameworks for details.

Upload a trace↑

Refer to these instructions for uploading a trace using the web UI or API.