Digma Quick Start
Guide for JAVA

Get Digma up and running

  1. Install the Digma IDE plugin 
  1. Run the following from the terminal/command line to start the Digma backend:

(You’ll need Docker and Docker Compose installed)

Linux & MacOS:

curl -L https://get.digma.ai/ --output docker-compose.yml

Windows (PowerShell):

iwr https://get.digma.ai/ -outfile docker-compose.yml
  1. Then run:
docker compose up -d

Prefer to use a helm file? Check out these instructions instead:

Set Up Tracing

If you’re already using OpenTelemetry… 

  1. Add Digma to your collector: 

Modify your collector configuration file to add Digma’s backend as a target. For example:

otlp/digma:
    endpoint: "localhost:5050"
    tls:
      insecure: true
service:
  pipelines:
    traces:
      exporters: [otlp/digma, ...]
  1. Connect Digma to your OTEL setup 

If you’re using automatic instrumentation, download the Digma agent extension:

curl -L -O https://github.com/digma-ai/otel-java-instrumentation/releases/latest/download/digma-otel-agent-extension.jar

Finally, add the Digma agent extension to your launch configuration, for example (adjust the path to the Digma agent JAR as needed):

java -javaagent:opentelemetry-javaagent.jar \
-Dotel.javaagent.extensions=digma-otel-agent-extension.jar \
-jar myapp.jar

Not yet on the OTEL train? No worries! 

  1. You can launch your JAR file with automatic instrumentation. First, download the OTEL agent as well as the Digma OTEL agent extension. 
curl -L -O https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/latest/download/opentelemetry-javaagent.jar

curl -L -O https://github.com/digma-ai/otel-java-instrumentation/releases/latest/download/digma-otel-agent-extension.jar
  1. Modify your run configuration to include the following parameters:
java -javaagent:opentelemetry-javaagent.jar \
-Dotel.traces.exporter=otlp \
-Dotel.exporter.otlp.traces.endpoint=http://localhost:5050 \
-Dotel.javaagent.extensions=digma-otel-agent-extension.jar \
-jar myapp.jar

That’s IT, YOUR CODE IS BEING OBSERVED!

Get More Out of Digma

Check out our sample application to get experimenting right away!

To find out about adding environments, commit info, and other configuration options, check out the Digma instrumentation page.

New to observability? OpenTelemetry has extensive documentation explaining how to get started. [ Get started with OpenTelemetry ]

Java Quick Start Guide - separator