framework-cf_metrics_exporter.md

cf-metrics-exporter (Agent Mode)

This framework integrates the cf-metrics-exporter as a Java agent in the Java buildpack.

Enabling the Exporter

Set the following environment variable in the cloud foundry env to enable the agent (via manifest.yml or cf set-env):

CF_METRICS_EXPORTER_ENABLED=true

Configuration

• CF_METRICS_EXPORTER_ENABLED: Set to true to enable the agent (default: disabled).
• CF_METRICS_EXPORTER_PROPS: (Optional) Properties string to pass to the agent, e.g. enableLogEmitter,rpsType=tomcat-bean.

How it Works

• The agent JAR is downloaded during the buildpack supply phase.
• The agent is injected into the JVM at runtime using the -javaagent option.
• If CF_METRICS_EXPORTER_PROPS is set, its value is appended to the -javaagent option.

Example

CF_METRICS_EXPORTER_ENABLED=true
CF_METRICS_EXPORTER_PROPS="enableLogEmitter,rpsType=tomcat-bean"

Version

• Default version: 0.7.1
• Default download URI: https://github.com/rabobank/cf-metrics-exporter/releases/download/0.7.1/cf-metrics-exporter-0.7.1.jar

Notes

• The agent is injected with priority 43 in JAVA_OPTS (after other APM agents).