Java metrics receiver 🔗

Description 🔗

The Splunk Distribution of OpenTelemetry Collector provides this integration as the java-monitor receiver for the Smart Agent Receiver.

Use the Java receiver to retrieve metrics from a Java application.

This receiver is available on Linux and Windows.

Note

To activate metrics collection in the OpenTelemetry Java agent, see Activate metrics collection.

Benefits 🔗

After you configure the integration, you can access these features:

View metrics. You can create your own custom dashboards, and most monitors provide built-in dashboards as well. For information about dashboards, see View dashboards in Observability Cloud.
View a data-driven visualization of the physical servers, virtual machines, AWS instances, and other resources in your environment that are visible to Infrastructure Monitoring. For information about navigators, see Splunk Infrastructure Monitoring navigators.
Access the Metric Finder and search for metrics sent by the monitor. For information, see Use the Metric Finder.

Installation 🔗

Follow these steps to deploy this integration:

Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform:
Configure the monitor, as described in the Configuration section.
Restart the Splunk Distribution of OpenTelemetry Collector.

Configuration 🔗

To use this Smart Agent monitor with the Collector, include the smartagent receiver and service pipeline in your configuration file. The Smart Agent receiver is fully supported only on x86_64/amd64 platforms.

Read more in Use Smart Agent monitors with the Collector.
Learn about config options in Collector default configuration.

See the examples below for more details.

receivers:
  smartagent/java-monitor:
    type: java-monitor
    ... # Additional config

To complete the receiver activation, you must also include the receiver in a metrics pipeline. To do this, add the receiver to the service > pipelines > metrics > receivers section of your configuration file. For example:

service:
  pipelines:
    metrics:
      receivers: [java-monitor]

Configuration settings 🔗

The following table shows the configuration options for the java-monitor receiver:

Option	Required	Type	Description
`host`	no	`string`	Host is filled in by auto-discovery if the receiver has a discovery rule.
`port`	no	`integer`	Port is filled in by auto-discovery if the receiver has a discovery rule. Default value is `0`.
`jarFilePath`	no	`string`	Path to the jar file that implements the monitoring logic.
`javaBinary`	no	`string`	By default, the agent use its bundled Java runtime (Java 8). If you wish to use a Java runtime that already exists on the system, specify the full path to the `java` binary here in `/usr/bin/java`.
`mainClass`	no	`string`	The class within the specified `jarFilePath` that contains a main method to execute.
`classPath`	no	`list of strings`	Additional class paths to set on the invoked Java subprocess.
`extraJavaArgs`	no	`list of strings`	Additional flags to the Java subprocess

Metrics 🔗

The following metrics are available for this integration:

The agent doesn’t do any built-in filtering of metrics coming out of this receiver.

Get help 🔗

If you are not able to see your data in Splunk Observability Cloud, try these tips:

Submit a case in the Splunk Support Portal
- Available to Splunk Observability Cloud customers
Call Splunk Customer Support
- Available to Splunk Observability Cloud customers
Ask a question and get answers through community support at Splunk Answers
- Available to Splunk Observability Cloud customers and free trial users
Join the Splunk #observability user group Slack channel to communicate with customers, partners, and Splunk employees worldwide
- Available to Splunk Observability Cloud customers and free trial users
- To learn how to join, see Get Started with Splunk Community - Chat groups

To learn about even more support options, see Splunk Customer Success.

Related Topics