The official Splunk documentation for this page is Metrics and attributes of the Java agent. For instructions on how to contribute to the docs, see CONTRIBUTING.md.
🚧 Status: Experimental - exported metric data and configuration properties may change.
The Splunk Distribution of OpenTelemetry Java agent gathers basic application metrics.
Because these splunk-specific metrics are still experimental they are not enabled by default.
To enable metrics, add -Dsplunk.metrics.enabled=true to the JVM
arguments or set the environment variable SPLUNK_METRICS_ENABLED to true.
For more information, please see the advanced configuration
for details.
The following metrics are currently gathered by the agent:
| Library/Framework | Instrumentation name | Versions |
|---|---|---|
| JVM metrics | jvm-metrics-splunk |
Java runtimes version 8 and higher |
| Tomcat thread pool metrics | tomcat |
8.5 and higher |
| WebSphere Liberty web request thread pool | liberty |
20.0.0.12 |
| WebLogic thread pools | weblogic |
12.x and 14.x |
We use OpenTelemetry JVM Metrics. Besides OpenTelemetry JVM Metrics we include the following JVM metrics.
These metrics are enabled only when memory profiler is enabled.
| Metric name | Instrument | Description |
|---|---|---|
jvm.memory.allocated |
Counter | Approximate sum of heap allocations. |
jvm.gc.pause.count |
Counter | Number of gc pauses. This metric will be removed in a future release. |
jvm.gc.pause.totalTime |
Counter | Time spent in GC pause. This metric will be removed in a future release. |
Splunk Distribution of OpenTelemetry Java instruments several thread pool implementations:
Each of the supported connection pools reports a subset of the following metrics:
| Metric name | Instrument | Description |
|---|---|---|
executor.threads |
Gauge | The current number of threads in the pool. |
executor.threads.active |
Gauge | The number of threads that are currently busy. |
executor.threads.idle |
Gauge | The number of threads that are currently idle. |
executor.threads.core |
Gauge | Core thread pool size - the number of threads that are always kept in the pool. |
executor.threads.max |
Gauge | The maximum number of threads in the pool. |
executor.tasks.submitted |
Counter | The total number of tasks that were submitted to this executor. |
executor.tasks.completed |
Counter | The total number of tasks completed by this executor. |
All thread pool metrics have the following attributes:
| Attribute name | Attribute value |
|---|---|
executor.name |
The name of the thread pool. |
executor.type |
The type/implementation of the thread pool: e.g. tomcat, liberty, weblogic. |
🚧 Status: Experimental
The Splunk Distribution of OpenTelemetry Java captures information about the application server that is being used and
adds the following attributes to SERVER spans:
| Span attribute | Example | Description |
|---|---|---|
webengine.name |
tomcat |
The name of the application server. |
webengine.version |
7.0.107.0 |
The version of the application server. |
All application servers from this list are supported.