Skip to content

Commit

Permalink
GITBOOK-44: No subject
Browse files Browse the repository at this point in the history
  • Loading branch information
doppleware authored and gitbook-bot committed Mar 18, 2024
1 parent 1e20720 commit 99a1f2f
Showing 1 changed file with 13 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,7 @@ To get started, make sure that that `Obervability` toggle is set to on. You can

<figure><img src="../../.gitbook/assets/image (16).png" alt=""><figcaption></figcaption></figure>

By default, when you enable the observability toggle, Digma will download and add the OTEL Java agent to the runtime configuration when you launch your application in the IDE. In addition, the Digma agent extension is also downloaded and referenced to add additional instrumentation data.&#x20;

With the observability toggle enabled, auto-instrumentation will automatically be added to the following run configurations:

1. Java applications configuration type
2. Spring applications using the Spring plugin
3. Specific common Maven / Gradle tasks for running application
4. Other plugins (Tomcat, others)
By default, when you enable the observability toggle, Digma will download and add the OTEL Java Agent and dynamically add it to your runtime configuration when you launch your application in the IDE. In addition, the Digma Agent extension is also downloaded and referenced to add additional instrumentation data.&#x20;

### How to tell if your code is automatically instrumented with the Java Agent

Expand All @@ -25,8 +18,19 @@ If everything works well, after triggering several actions on your applications

<figure><img src="../../.gitbook/assets/image (18).png" alt=""><figcaption></figcaption></figure>

### How do I know if my Java stack is supported?

The Java OTEL Agent [supported libraries page](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/docs/supported-libraries.md) maintains an exhaustive list of frameworks and libraries currently automatically instrumented by the Java OTEL agent. For any of these frameworks, without any code changes, Digma will automatically receive and process tracing data that includes endpoint information, database queries, consumer data, and more. &#x20;

### What if your Run Configuration is not automatically instrumented

Digma purposely will not instrument \*everything\* as it can be harmful to add the agent instrumentation to utility or build tasks. If Digma is not automatically adding instrumentation to your custom Gradle or Maven task, you can add the `DIGMA_OBSERVABILITY=true` environment variable. This will ensure the Digma Plugin will instrument the run configuration configuration.
With the observability toggle enabled, auto-instrumentation will automatically be added to the following run configurations:

1. Java applications configuration type
2. Spring applications using the Spring plugin
3. Specific common Maven / Gradle tasks for running application
4. Other plugins (Tomcat, others)

However, Digma will purposely not instrument \*every\* Run Configuration, as it can be harmful to add the agent instrumentation to utility or build tasks. If Digma is not automatically adding instrumentation to your custom Gradle or Maven task, you can add the `DIGMA_OBSERVABILITY=true` environment variable. This will ensure the Digma Plugin will instrument the run configuration configuration.

<figure><img src="../../.gitbook/assets/image (19).png" alt=""><figcaption></figcaption></figure>

0 comments on commit 99a1f2f

Please sign in to comment.