search

signalfx / splunk-otel-java

Splunk Distribution of OpenTelemetry Java
https://docs.splunk.com/Observability/gdi/get-data-in/application/java/get-started.html
Apache License 2.0
64 stars 34 forks source link
instrumentation java java-agent jvm metrics opentelemetry tracing

readme

Important

Splunk OpenTelemetry Java Instrumentation 2.x is available and recommended to collect and export telemetry for Splunk Observability Cloud. Refer to the official documentation for details.

Caution ⚠️ Deprecation Notice

The Splunk Distribution of OpenTelemetry Java version 1.x is deprecated as of June 25, 2024 and will reach End of Support on June 30, 2025. Until then, only critical security fixes and bug fixes will be provided. New customers should use the latest version of the Splunk Distribution of OpenTelemetry Java. Existing customers should consider migrating to version 2.5.0 or higher. To learn how to migrate, see Migration guide for OpenTelemetry Java 2.x metrics.

Get Started   •   Get Involved   •   Migrate from SignalFx Java Agent

Stable OpenTelemetry Instrumentation for Java Version Splunk GDI specification GitHub release (latest SemVer) Maven Central Build Status

Examples   •   About the distribution   •   Security   •   Supported Libraries   •   Troubleshooting

Splunk Distribution of OpenTelemetry Java

The Splunk Distribution of OpenTelemetry Instrumentation for Java provides a Java Virtual Machine (JVM) agent that automatically instruments your Java application to capture and report distributed traces to Splunk APM.

This distribution comes with the following defaults:

If you're currently using the SignalFx Java Agent and want to migrate to the Splunk Distribution of OpenTelemetry Java, see Migrate from the SignalFx Java Agent.

The following documentation refers to the in-development version of splunk-otel-java. Docs for the latest version (v2.9.0) can be found here.

Requirements

The agent works with Java runtimes version 8 and higher. For the full list of requirements and supported libraries and versions, see Requirements for the Java agent in the official Splunk documentation.

Get started

For complete instructions on how to get started with the Splunk Distribution of OpenTelemetry Java, see Instrument Java services for Observability Cloud in the official Splunk documentation.

To see the Java Agent in action with sample applications, see the OpenTelemetry examples.

Advanced configuration

To fully configure the agent of the Splunk Distribution of OpenTelemetry Java, see Configure the Java agent in the official Splunk documentation.

Correlating traces with logs

The Splunk Distribution of OpenTelemetry Java provides a way to correlate traces with logs. For more information see Connect Java application trace data with logs in the Splunk Observability Cloud user documentation.

Manually instrument a Java application

Documentation on how to manually instrument a Java application is available in the OpenTelemetry official documentation. To learn how to add custom metrics to your application see Manual instrumentation.

To extend the instrumentation with the OpenTelemetry Instrumentation for Java, you have to use a compatible API version.

The Splunk Distribution of OpenTelemetry Java version 2.8.0 is compatible with:

Snapshot builds

We publish snapshot builds with every merge to the main branch. Snapshots are primarily intended to test new functionality and are not recommended for production use.

Upgrades

For information and best practices around upgrades, see the Upgrading documentation.

Troubleshooting

For troubleshooting information and known issues, see Troubleshooting Java instrumentation in the Splunk Observability Cloud user documentation.

License

The Splunk Distribution of OpenTelemetry Java is a distribution of OpenTelemetry Instrumentation for Java. It is licensed under the terms of the Apache Software License version 2.0. For more details, see the license file.

ℹ️  SignalFx was acquired by Splunk in October 2019. See Splunk SignalFx for more information.