Docs » Configure application receivers » Configure application receivers for languages » Java metrics receiver

Java metrics receiver 🔗

Description 🔗

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

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

This receiver is available on Linux and Windows.

Note

To enable metrics collection in the OpenTelemetry Java agent, see Enable metrics collection.

Benefits 🔗

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

  • View metrics using the built-in dashboard. 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 Metric Finder and search for metrics sent by the monitor. For information about Metric Finder, see Use the Metric Finder.

Installation 🔗

Follow these steps to deploy this integration:

  1. Follow the steps to deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform:

  2. Configure the monitor, as described in the Configuration section.

  3. Restart the Splunk Distribution of OpenTelemetry Collector.

Configuration 🔗

This monitor is available in the Smart Agent Receiver, which is part of the Splunk Distribution of OpenTelemetry Collector. You can use existing Smart Agent monitors as OpenTelemetry Collector metric receivers with the Smart Agent Receiver.

This monitor requires a properly configured environment on your system, in which you’ve installed a functional Smart Agent release bundle. The Splunk Distribution of OpenTelemetry Collector provides this bundle in the installation paths for x86_64/amd64.

To activate this monitor in the Splunk Distribution of OpenTelemetry Collector, add the following lines to your configuration (YAML) file. See https://github.com/signalfx/splunk-otel-collector/tree/main/cmd/otelcol/config/collector on GitHub for the configuration (YAML) files.

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-server]

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.

Troubleshooting 🔗

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

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