Skip to content

Latest commit

 

History

History
56 lines (41 loc) · 2.54 KB

README.md

File metadata and controls

56 lines (41 loc) · 2.54 KB

Digma - OpenTelemetry Agent Extension

Quickstart

This module is an extension to existing OpenTelemetry JavaAgent

How to apply the OpenTelemetry agent at all

  1. Download the latest version of opentelemetry-javaagent.jar .
  2. Add the agent definition to your application run command as follows:
java -javaagent:path/to/opentelemetry-javaagent.jar \
     -jar myapp.jar

How to apply Digma extension

  1. Download the latest version of digma-otel-agent-extension.jar
  2. Add the extension definition as follows:
java -javaagent:path/to/opentelemetry-javaagent.jar \
     -Dotel.javaagent.extensions=path/to/digma-otel-agent-extension.jar \
     -jar myapp.jar

Supported technologies

  • SpringMVC - supports instrumenting annotation of @Controller and @RestController. it includes SpringBoot applications which use those common annotations.
  • JAX-RS 2.0
  • GRPC 1.6 - see GRPC Library
    Known issue: currently (as of 0.5.30), if you have your own server side interceptors, Digma interceptor won't work correctly. (see issue #19).

Configuring the environment

The extension supports overriding default values through environment variables or SystemProperties. here are the available config entries:

Description Environment Variable System Property default value
Allows defining environment name.
values for example: PROD, CI		 DEPLOYMENT_ENV DEPLOYMENT_ENV [local]
Package prefixes of you application/service. value is comma separated.
value for example: com.mycomp.myservice,aaa.bbb.ccc		 CODE_PACKAGE_PREFIXES CODE_PACKAGE_PREFIXES

Origins

This OpenTelemetry agent-extension is based on the Otel Extension Example