CRS Configuration Options

Usage Example

 
java -XX:AzCRSMode=on -jar MyApp.jar

Applying Tags

Tag keys must begin with a letter. Both key and value may contain lower and upper case letters, and numbers. These additional characters are also allowed:

 
ALLOWED_KEY_EXTRA_CHARS = "-_."
ALLOWED_VALUE_EXTRA_CHARS = "-_. :/@" <-- Includes space

Tags can be provided both as environment variable and in command line options. When using both, the results are combined. It’s recommended to use environment variables as it allows AZ_CRS_ARGUMENTS to be mostly the same for each JVM.

Special Tags

This tag is handled in a specific way with the system:

How to Use Tags

Tags can be specified with a command line argument or environment variable:

 
# With command line option
-Dcom.azul.crs.instance.tags="system-prop.tag_1=system prop/value@1; system_prop_tag.2=system prop:value/2"

# With environment variable
export CRS_TAGS="env.tag-1=value:1; env_Tag_2=value 2"

For example, using the command line option:

 
java -XX:AzCRSMode=on \
    -XX:AzCRSArguments=api.url=https://<FORWARDER_IP:PORT> \
    -Dcom.azul.crs.instance.tags="AppEnv=MyApplicationTag" \
    -jar MyApp.jar

Recommended Tagging Practice

It is important that you properly tag your instances. As a general rule, tagging should reflect the way you categorize your Java applications. For example, you can use "west-coast", "east-coast", and so on to distinguish between different availability zones/locations.

When you use Forwarder 2.0.0, review your AppEnv tagging strategy before enabling production traffic. If unrelated applications share the same AppEnv, deduplication groups their events together and report accuracy can degrade.

Automated Tags

Some instance properties are detected automatically. For example, you don’t have to tag the Java version, because it’s detected by CRS.

Usage Examples

 
# Environment variable for Azul Intelligence Cloud Agent
export JDK_JAVA_OPTIONS="-javaagent:${AGENTDIR}/ic-agent.jar=expression1,expression2,expression3 \
  -DaagentDir=${AGENTDIR} \
  -Djava.security.policy=${AGENTDIR}/agent.all.policy"

# Command line option for Azul JDK or JRE
java -XX:AzCRSArguments=expression1,expression2,expression3 \
  -jar MyApp.jar

# Environment variable for Azul JDK or JRE
export AZ_CRS_ARGUMENTS=expression1,expression2,expression3

JVM Command Line Arguments

Pass configuration parameters to the CRS (Connected Runtime Service) in the Azul JVM by using the -XX:AzCRSArguments command line argument:

 
java -XX:AzCRSMode=on \
    -XX:AzCRSArguments=api.url=https://<FORWARDER_IP:PORT> \
    MyApp

 
java -XX:AzCRSMode=on \
    -XX:AzCRSArguments=api.url=https://<FORWARDER_IP:PORT>,log=debug,delayTermination=120000,delayInitiation=0 \
    -Dcom.azul.crs.instance.tags={tags} \
    MyApp

Environment Variables

You can use dedicated environment variables to enable and control all JVM processes for Azul Zulu and Zing distributions. When the environment variables are present, they automatically apply to any newly started JVM, enabling CRS.

Substitute your forwarder_endpoint in the following example.

 
export CRS_TAGS={your_crs_tags}
export AZ_CRS_ARGUMENTS=enable,api.url=https://<FORWARDER_IP:PORT>,log=debug,delayTermination=120000,delayInitiation=0
java MyApp

Properties File

A third way to set the CRS parameters is to use a local .properties file. There are two default locations where CRS looks for the properties file, and you can specify a custom properties file as a command line argument. CRS looks for the properties file in the following order: