mcpField
O
observability-edot-java-instrument

observability-edot-java-instrument

github.com/elasticCloud & DevOps6022.7k installsUpdated today
Repository

About observability-edot-java-instrument

A setup skill for adding Elastic Distribution of OpenTelemetry (EDOT) Java instrumentation. It guides developers through agent attachment and the required OTLP settings while avoiding conflicts with the classic Elastic APM agent.

Key features

  1. 01Attach the Java agent
  2. 02Set required OTLP environment variables
  3. 03Use a managed OTLP endpoint or EDOT Collector
  4. 04Avoid running both Elastic agents

Use cases

  1. 01Instrument a Java application with EDOT
  2. 02Configure telemetry export for a Java service

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/elastic/agent-skills --skill observability-edot-java-instrument

After installing, type/observability-edot-java-instrumentin Claude Code to confirm it loaded.

Details

From the project README

EDOT Java Instrumentation

Read the setup guide before making changes:

Guidelines

  1. Use elastic-otel-javaagent.jar (download from Maven Central, not a Maven/Gradle compile dependency)
  2. Attach via -javaagent:/path/to/elastic-otel-javaagent.jar or JAVA_TOOL_OPTIONS="-javaagent:/path/to/elastic-otel-javaagent.jar" — without this the agent does nothing
  3. Set exactly three required environment variables:
    • OTEL_SERVICE_NAME
    • OTEL_EXPORTER_OTLP_ENDPOINT — must be the managed OTLP endpoint or EDOT Collector URL. Never use an APM Server URL (no apm-server, no :8200, no /intake/v2/events)
    • OTEL_EXPORTER_OTLP_HEADERS — "Authorization=ApiKey <key>" or "Authorization=Bearer <token>"
  4. Do NOT set OTEL_TRACES_EXPORTER, OTEL_METRICS_EXPORTER, or OTEL_LOGS_EXPORTER — the defaults are already correct
  5. Never run both classic Elastic APM agent and EDOT agent on the same JVM

Examples

See the EDOT Java setup guide for complete Dockerfile and docker-compose examples.

Comments

Markdown supported