diff --git a/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png b/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png new file mode 100644 index 0000000..3590fb8 Binary files /dev/null and b/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png differ diff --git a/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png b/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png index 3590fb8..89b59e6 100644 Binary files a/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png and b/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png differ diff --git a/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png b/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png index 89b59e6..89958db 100644 Binary files a/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png and b/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png differ diff --git a/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png b/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png index 89958db..d786c1c 100644 Binary files a/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png and b/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png differ diff --git a/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png b/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png index d786c1c..2cd95b5 100644 Binary files a/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png and b/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png differ diff --git a/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png b/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png index 2cd95b5..a197784 100644 Binary files a/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png and b/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png differ diff --git a/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png b/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png index a197784..7a819e7 100644 Binary files a/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png and b/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png differ diff --git a/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1).png b/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1).png index 7a819e7..1466b20 100644 Binary files a/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1).png and b/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1).png differ diff --git a/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1).png b/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1).png index 1466b20..b105b7f 100644 Binary files a/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1).png and b/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1).png differ diff --git a/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1).png b/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1).png index b105b7f..349c624 100644 Binary files a/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1).png and b/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1).png differ diff --git a/.gitbook/assets/image (1) (1) (1) (1) (1) (1).png b/.gitbook/assets/image (1) (1) (1) (1) (1) (1).png index 349c624..7b91d18 100644 Binary files a/.gitbook/assets/image (1) (1) (1) (1) (1) (1).png and b/.gitbook/assets/image (1) (1) (1) (1) (1) (1).png differ diff --git a/.gitbook/assets/image (1) (1) (1) (1) (1).png b/.gitbook/assets/image (1) (1) (1) (1) (1).png index 7b91d18..cab7a93 100644 Binary files a/.gitbook/assets/image (1) (1) (1) (1) (1).png and b/.gitbook/assets/image (1) (1) (1) (1) (1).png differ diff --git a/.gitbook/assets/image (1) (1) (1) (1).png b/.gitbook/assets/image (1) (1) (1) (1).png index cab7a93..f60b559 100644 Binary files a/.gitbook/assets/image (1) (1) (1) (1).png and b/.gitbook/assets/image (1) (1) (1) (1).png differ diff --git a/.gitbook/assets/image (1) (1) (1).png b/.gitbook/assets/image (1) (1) (1).png index f60b559..dd3ab5e 100644 Binary files a/.gitbook/assets/image (1) (1) (1).png and b/.gitbook/assets/image (1) (1) (1).png differ diff --git a/.gitbook/assets/image (1).png b/.gitbook/assets/image (1).png index dd3ab5e..f148d6e 100644 Binary files a/.gitbook/assets/image (1).png and b/.gitbook/assets/image (1).png differ diff --git a/.gitbook/assets/image (2) (1) (1) (1) (1) (1) (1) (1) (1).png b/.gitbook/assets/image (2) (1) (1) (1) (1) (1) (1) (1) (1).png new file mode 100644 index 0000000..68628de Binary files /dev/null and b/.gitbook/assets/image (2) (1) (1) (1) (1) (1) (1) (1) (1).png differ diff --git a/.gitbook/assets/image (2) (1) (1) (1) (1) (1) (1) (1).png b/.gitbook/assets/image (2) (1) (1) (1) (1) (1) (1) (1).png index 68628de..52411fd 100644 Binary files a/.gitbook/assets/image (2) (1) (1) (1) (1) (1) (1) (1).png and b/.gitbook/assets/image (2) (1) (1) (1) (1) (1) (1) (1).png differ diff --git a/.gitbook/assets/image (2) (1) (1) (1) (1) (1) (1).png b/.gitbook/assets/image (2) (1) (1) (1) (1) (1) (1).png index 52411fd..f2ea8df 100644 Binary files a/.gitbook/assets/image (2) (1) (1) (1) (1) (1) (1).png and b/.gitbook/assets/image (2) (1) (1) (1) (1) (1) (1).png differ diff --git a/.gitbook/assets/image (2) (1) (1) (1) (1) (1).png b/.gitbook/assets/image (2) (1) (1) (1) (1) (1).png index f2ea8df..832e335 100644 Binary files a/.gitbook/assets/image (2) (1) (1) (1) (1) (1).png and b/.gitbook/assets/image (2) (1) (1) (1) (1) (1).png differ diff --git a/.gitbook/assets/image (2) (1) (1) (1) (1).png b/.gitbook/assets/image (2) (1) (1) (1) (1).png index 832e335..1466b20 100644 Binary files a/.gitbook/assets/image (2) (1) (1) (1) (1).png and b/.gitbook/assets/image (2) (1) (1) (1) (1).png differ diff --git a/.gitbook/assets/image (2) (1) (1) (1).png b/.gitbook/assets/image (2) (1) (1) (1).png index 1466b20..8901fb5 100644 Binary files a/.gitbook/assets/image (2) (1) (1) (1).png and b/.gitbook/assets/image (2) (1) (1) (1).png differ diff --git a/.gitbook/assets/image (2) (1) (1).png b/.gitbook/assets/image (2) (1) (1).png index 8901fb5..5fdc6d5 100644 Binary files a/.gitbook/assets/image (2) (1) (1).png and b/.gitbook/assets/image (2) (1) (1).png differ diff --git a/.gitbook/assets/image (2) (1).png b/.gitbook/assets/image (2) (1).png index 5fdc6d5..f60b559 100644 Binary files a/.gitbook/assets/image (2) (1).png and b/.gitbook/assets/image (2) (1).png differ diff --git a/.gitbook/assets/image (2).png b/.gitbook/assets/image (2).png index f60b559..39625bf 100644 Binary files a/.gitbook/assets/image (2).png and b/.gitbook/assets/image (2).png differ diff --git a/.gitbook/assets/image.png b/.gitbook/assets/image.png index 39625bf..c45dd6f 100644 Binary files a/.gitbook/assets/image.png and b/.gitbook/assets/image.png differ diff --git a/README (1).md b/README (1).md index afff1ce..e066754 100644 --- a/README (1).md +++ b/README (1).md @@ -28,7 +28,7 @@ colima start --memory 3 The Digma Plugin is available on the IntelliJ Marketplace. -
+
You can install the plugin from your IDE or open the plugin [page](https://plugins.jetbrains.com/plugin/19470-digma-continuous-feedback) in your browser. @@ -80,7 +80,7 @@ You can install the Digma Extension from the Docker Marketplace or by visiting t -
+
### How do I know Digma is Running? diff --git a/digma-core-concepts/environments.md b/digma-core-concepts/environments.md index bba6b73..026c76f 100644 --- a/digma-core-concepts/environments.md +++ b/digma-core-concepts/environments.md @@ -31,11 +31,11 @@ Beyond the default environments, creating additional private or shared environme Private environments are easy to create in your local deployment from the Observability Panel and through the `Add Environment` button. -
+
-### Retrieving the Environment ID +### Tagging the application data to the new environment -Each Digma environment has a unique identifier that can be referenced in order to tag observability data to that environment, in whichever way you instrument your code. You can find the environment identifier by selecting the `How to Setup` option from the environment tab in the Observability panel: +To learn how to save the application observability data under the environment you've created, click on the 'How to setup' option in the environment tab context menu: -
+
diff --git a/digma-quickstart.md b/digma-quickstart.md index 1702099..65825c6 100644 --- a/digma-quickstart.md +++ b/digma-quickstart.md @@ -8,7 +8,7 @@ description: Couch to Continuous Feedback in less than five minutes You can find the Digma Plugin in the IntelliJ Plugin Marketplace in your IDE by searching for `Digma` or visit the [plugin page ](https://plugins.jetbrains.com/plugin/19470-digma-continuous-feedback)to get it directly from there. -
+
Installing the plugin will also kick off the Digma Local Engine installation. If you have Docker installed and running on your machine that should happen automatically! You can also run Digma yourself using a simple Docker Compose file. See [README (1).md]( "mention")for more info. diff --git a/installation/central-on-prem-install.md b/installation/central-on-prem-install.md index b87c7b3..ec8e282 100644 --- a/installation/central-on-prem-install.md +++ b/installation/central-on-prem-install.md @@ -120,7 +120,7 @@ To check everything is working properly we can check the pod status and make sur For example, this is the expected output: -
+
**Step 4: Get the IP/DNS value for the Digma deployment** diff --git a/instrumentation/automatic-instrumentation-in-the-ide/quarkus-micronaut.md b/instrumentation/automatic-instrumentation-in-the-ide/quarkus-micronaut.md index 0d1c7af..8a55d5b 100644 --- a/instrumentation/automatic-instrumentation-in-the-ide/quarkus-micronaut.md +++ b/instrumentation/automatic-instrumentation-in-the-ide/quarkus-micronaut.md @@ -6,7 +6,7 @@ If you're using Quarkus then the recommended way to enable tracing is not via th Once you've loaded a project that contains Quarkus modules, the Digma plugin will automatically pick up on that, and within a few seconds present you with an option to configure the dependencies for you. -
+
Clicking the link will add the needed dependencies to your `pom.xml` or `build.gradle` files. diff --git a/instrumentation/automatic-instrumentation-in-the-ide/spring-spring-boot-dropwizard-and-default.md b/instrumentation/automatic-instrumentation-in-the-ide/spring-spring-boot-dropwizard-and-default.md index 72b5b50..1d9140e 100644 --- a/instrumentation/automatic-instrumentation-in-the-ide/spring-spring-boot-dropwizard-and-default.md +++ b/instrumentation/automatic-instrumentation-in-the-ide/spring-spring-boot-dropwizard-and-default.md @@ -9,7 +9,7 @@ description: >-
-
+
diff --git a/instrumentation/spring-spring-boot-dropwizard-and-default/covering-more-of-your-code-with-observability.md b/instrumentation/spring-spring-boot-dropwizard-and-default/covering-more-of-your-code-with-observability.md index 08ee54e..31297c5 100644 --- a/instrumentation/spring-spring-boot-dropwizard-and-default/covering-more-of-your-code-with-observability.md +++ b/instrumentation/spring-spring-boot-dropwizard-and-default/covering-more-of-your-code-with-observability.md @@ -6,7 +6,7 @@ Beyond the automatic instrumentation of server and client libraries, you may wis Digma makes it easy to add additional observability coverage to any location. Placing the cursor inside any method you can click on the Observability icon in the Insights side panel to quickly add an annotation that will include its data in the traces. -
+
Note: If you're using the Micrometer Tracing observability strategy in Digma, clicking on `Add Observability` will add an @Observe annotation. Otherwise, the @WithSpan annotation will be used. diff --git a/instrumentation/spring-spring-boot-dropwizard-and-default/instrumenting-your-application-in-docker-compose.md b/instrumentation/spring-spring-boot-dropwizard-and-default/instrumenting-your-application-in-docker-compose.md index af57696..98df81a 100644 --- a/instrumentation/spring-spring-boot-dropwizard-and-default/instrumenting-your-application-in-docker-compose.md +++ b/instrumentation/spring-spring-boot-dropwizard-and-default/instrumenting-your-application-in-docker-compose.md @@ -2,17 +2,23 @@ This is just a neat trick that allows you to collect observability data from your application running via Docker Compose _without_ changing the original docker-compose.yml file. We accomplish this by using an override file that will add the OTEL agent and set the appropriate environment variables which we can use in dev/test. -1. Download the latest OTEL agent +### Prerequisite: Create an environment in Digma + +Follow [these](../../digma-core-concepts/environments.md#how-to-create-environments) instructions to create a private or CI/prod environment depending on your use case and required visibility for the new environment. + +### 1. Download the latest OTEL and Digma agents {% code overflow="wrap" %} ``` curl --create-dirs -O -L --output-dir ./otel https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/download/v2.1.0/opentelemetry-javaagent.jar curl --create-dirs -O -L --output-dir ./otel https://github.com/digma-ai/otel-java-instrumentation/releases/latest/download/digma-otel-agent-extension.jar + +curl --create-dirs -O -L --output-dir /tmp/otel https://github.com/digma-ai/digma-agent/releases/latest/download/digma-agent.jar ``` {% endcode %} -2. Add a Docker Compose override file +### 2. Add a Docker Compose override file Create a supplementary Docker Compose file that will include the agent files and provide the environment variables to export tracing data to Digma. @@ -23,22 +29,27 @@ services: [your-service]: volumes: - "./otel/opentelemetry-javaagent.jar:/otel/opentelemetry-javaagent.jar" + - "./otel/digma-agent.jar:/otel/digma-agent.jar" - "./otel/digma-otel-agent-extension.jar:/otel/digma-otel-agent-extension.jar" environment: - - JAVA_TOOL_OPTIONS=-javaagent:/otel/opentelemetry-javaagent.jar -Dotel.javaagent.extensions=/otel/digma-otel-agent-extension.jar + - JAVA_TOOL_OPTIONS=-javaagent:/tmp/otel/digma-agent.jar -javaagent:/otel/opentelemetry-javaagent.jar -Dotel.javaagent.extensions=/otel/digma-otel-agent-extension.jar - OTEL_SERVICE_NAME=[your-service] - OTEL_EXPORTER_OTLP_ENDPOINT=http://host.docker.internal:5050 - OTEL_METRICS_EXPORTER=none - OTEL_LOGS_EXPORTER=none - OTEL_EXPORTER_OTLP_PROTOCOL=grpc - OTEL_RESOURCE_ATTRIBUTES=digma.environment.id=[ENVIRONMENT_ID] + - OTEL_INSTRUMENTATION_COMMON_EXPERIMENTAL_CONTROLLER_TELEMETRY_ENABLED=true + - OTEL_INSTRUMENTATION.EXPERIMENTAL_VIEW_TELEMETRY_ENABLED=true + - OTEL_INSTRUMENTATION.EXPERIMENTAL_SPAN_SUPPRESSION_STRATEGY=none + - OTEL_INSTRUMENTATION_JDBC_DATASOURCE_ENABLED=true extra_hosts: - "host.docker.internal:host-gateway" To retrieve the environment identifier see the instructions on the [environment page](https://docs.digma.ai/digma-developer-guide/digma-core-concepts/environments#retrieving-the-environment-id). -3. Run your original Docker Compose file along with the override file +### 3. Run your original Docker Compose file along with the override file ```bash docker compose -f docker-compose.yml -f docker-compose.override.otel.yml up -d diff --git a/instrumentation/spring-spring-boot-dropwizard-and-default/instrumenting-your-code-in-ci-staging-or-the-terminal.md b/instrumentation/spring-spring-boot-dropwizard-and-default/instrumenting-your-code-in-ci-staging-or-the-terminal.md index f7b6ed2..d6a8689 100644 --- a/instrumentation/spring-spring-boot-dropwizard-and-default/instrumenting-your-code-in-ci-staging-or-the-terminal.md +++ b/instrumentation/spring-spring-boot-dropwizard-and-default/instrumenting-your-code-in-ci-staging-or-the-terminal.md @@ -62,7 +62,7 @@ This information will be used when identifying issues. For example, here is the -
+
diff --git a/troubleshooting/digma-overload-warning.md b/troubleshooting/digma-overload-warning.md index 7ddd283..3898ff0 100644 --- a/troubleshooting/digma-overload-warning.md +++ b/troubleshooting/digma-overload-warning.md @@ -1,6 +1,6 @@ # Digma Overload Warning -
+
### Overload when using Digma locally diff --git a/use-cases-wip/get-early-feedback-on-bottlenecks-and-code-issues.md b/use-cases-wip/get-early-feedback-on-bottlenecks-and-code-issues.md index e615941..80c1656 100644 --- a/use-cases-wip/get-early-feedback-on-bottlenecks-and-code-issues.md +++ b/use-cases-wip/get-early-feedback-on-bottlenecks-and-code-issues.md @@ -17,10 +17,10 @@ As you work on your code, any newly detected issues will appear in the issues si Additionally, the code itself will be highlighted to signify whether any critical issues are present: -
+
### Recheck issues after fixing the source problems Once an issue Digma detected is fixed, you can use the `recheck` option on the issue card. Digma will start re-examining the problem based on new data to determine whether the issue is indeed fixed. This is not mandatory for detecting whether an issue is fixed but can expedite the detection process. -
+
diff --git a/use-cases-wip/prioritize-technical-debt.md b/use-cases-wip/prioritize-technical-debt.md index 08e3fc7..f87555d 100644 --- a/use-cases-wip/prioritize-technical-debt.md +++ b/use-cases-wip/prioritize-technical-debt.md @@ -6,7 +6,7 @@ Beyond simply identifying issues. Digma also analyzes their effect on the applic Each issue is assessed for criticality based on its overall effect on the application. In local environments, this is merely measured by the severity of the issue and the scope of different application flows affected by it. In shared environments such as CI, staging, or production, however, actual usage is also measured to determine the true impact of the issue. -
+
The criticality of each issue is reflected by the color coding of the issue icon. Hovering over the icon will also reveal the criticality score. When reviewing the overall issue list, you can choose to sort by latest or by the most critical issues to help prioritize the backlog and avoid micro-optimizations: