GITBOOK-80: No subject

digma-ai · Apr 1, 2024 · 728e751 · 728e751
1 parent b4b60e8
commit 728e751
Show file tree

Hide file tree

Showing 42 changed files with 65 additions and 32 deletions.
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
diff --git a/.gitbook/assets/image (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).png
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
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
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
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
diff --git a/.gitbook/assets/image (1) (1) (1) (1) (1).png b/.gitbook/assets/image (1) (1) (1) (1) (1).png
diff --git a/.gitbook/assets/image (1) (1) (1) (1).png b/.gitbook/assets/image (1) (1) (1) (1).png
diff --git a/.gitbook/assets/image (1) (1) (1).png b/.gitbook/assets/image (1) (1) (1).png
diff --git a/.gitbook/assets/image (1) (1).png b/.gitbook/assets/image (1) (1).png
diff --git a/.gitbook/assets/image (1).png b/.gitbook/assets/image (1).png
diff --git a/.gitbook/assets/image (2) (1) (1) (1) (1) (1).png b/.gitbook/assets/image (2) (1) (1) (1) (1) (1).png
diff --git a/.gitbook/assets/image (2) (1) (1) (1) (1).png b/.gitbook/assets/image (2) (1) (1) (1) (1).png
diff --git a/.gitbook/assets/image (2) (1) (1) (1).png b/.gitbook/assets/image (2) (1) (1) (1).png
diff --git a/.gitbook/assets/image (2) (1) (1).png b/.gitbook/assets/image (2) (1) (1).png
diff --git a/.gitbook/assets/image (2) (1).png b/.gitbook/assets/image (2) (1).png
diff --git a/.gitbook/assets/image (2).png b/.gitbook/assets/image (2).png
diff --git a/.gitbook/assets/image (3) (1) (1) (1) (1).png b/.gitbook/assets/image (3) (1) (1) (1) (1).png
diff --git a/.gitbook/assets/image (3) (1) (1) (1).png b/.gitbook/assets/image (3) (1) (1) (1).png
diff --git a/.gitbook/assets/image (3) (1) (1).png b/.gitbook/assets/image (3) (1) (1).png
diff --git a/.gitbook/assets/image (3) (1).png b/.gitbook/assets/image (3) (1).png
diff --git a/.gitbook/assets/image (3).png b/.gitbook/assets/image (3).png
diff --git a/.gitbook/assets/image (4) (1) (1) (1).png b/.gitbook/assets/image (4) (1) (1) (1).png
diff --git a/.gitbook/assets/image (4) (1) (1).png b/.gitbook/assets/image (4) (1) (1).png
diff --git a/.gitbook/assets/image (4) (1).png b/.gitbook/assets/image (4) (1).png
diff --git a/.gitbook/assets/image (4).png b/.gitbook/assets/image (4).png
diff --git a/.gitbook/assets/image (5) (1) (1).png b/.gitbook/assets/image (5) (1) (1).png
diff --git a/.gitbook/assets/image (5) (1).png b/.gitbook/assets/image (5) (1).png
diff --git a/.gitbook/assets/image (5).png b/.gitbook/assets/image (5).png
diff --git a/.gitbook/assets/image.png b/.gitbook/assets/image.png
diff --git a/README (1).md b/README (1).md
@@ -16,7 +16,7 @@ description: >-
 
 The Digma Plugin is available on the IntelliJ Marketplace.&#x20;
 
-<figure><img src=".gitbook/assets/image (2) (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
+<figure><img src=".gitbook/assets/image (2) (1) (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
 
 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. &#x20;
 
@@ -26,15 +26,15 @@ Digma runs locally on your machine. To process all of the captured traces, analy
 
 After the plugin installs you'll get to choose the preferred way to install the Digma Engine.  Several options are available:
 
-<figure><img src=".gitbook/assets/image (5) (1).png" alt="" width="240"><figcaption></figcaption></figure>
+<figure><img src=".gitbook/assets/image (5) (1) (1).png" alt="" width="240"><figcaption></figcaption></figure>
 
 <details>
 
 <summary>Auto install  (Default)</summary>
 
 This is the default option. After installation, the plugin will try to start the Digme Engine containers on your local Docker environment and will offer clear controls to allow you to `Stop` `Start` or `Remove` it.  The benefit of using this approach is that Digma will be able to also update the Engine automatically when a new release becomes available.&#x20;
 
-![](<.gitbook/assets/image (4) (1) (1).png>)
+![](<.gitbook/assets/image (4) (1) (1) (1).png>)
 
 </details>
 
@@ -112,13 +112,13 @@ If you need to change the default collector port (:5050),  the change also requi
 
 Finally, update the new ports in the plugin settings page which you can access via the IntellIJ settings page.
 
-<figure><img src=".gitbook/assets/image.png" alt=""><figcaption></figcaption></figure>
+<figure><img src=".gitbook/assets/image (5).png" alt=""><figcaption></figcaption></figure>
 
 ### How do I know Digma is Running?
 
 If you've run Digma via any of the first two options, you can check that the Analytics Engine containers are up and running. In the IDE you should see both the Observability side panel and the Insights side panel showing up with no errors and waiting to receive data.
 
-<figure><img src=".gitbook/assets/image (5).png" alt=""><figcaption></figcaption></figure>
+<figure><img src=".gitbook/assets/image (5) (1).png" alt=""><figcaption></figcaption></figure>
 
 
 
diff --git a/SUMMARY.md b/SUMMARY.md
@@ -20,8 +20,8 @@
 
 ## Use Cases (WIP)
 
-* [Design and write code more efficiently by understanding the system flows](use-cases-wip/design-and-write-code-more-efficiently-by-understanding-the-system-flows.md)
-* [Get early feedback about code changes](use-cases-wip/get-early-feedback-about-code-changes.md)
+* [Design and write code more efficiently by understanding the system flows](use-cases-wip/understand-the-application-flows-better-for-faster-development.md)
+* [Get early feedback on bottlenecks and code issues](use-cases-wip/get-early-feedback-on-bottlenecks-and-code-issues.md)
 * [Prioritize Technical Debt](use-cases-wip/prioritize-technical-debt.md)
 
 ## Digma Core Concepts

diff --git a/digma-core-concepts/assets.md b/digma-core-concepts/assets.md
@@ -8,7 +8,7 @@ description: >-
 
 Asset categories include HTTP Endpoints, code locations, consumers, database queries, and more. In most cases, an asset correlates to a [Span](https://opentelemetry.io/docs/concepts/signals/traces/#spans) that has been categorized and processed in a specific way.&#x20;
 
-<figure><img src="../.gitbook/assets/image (3) (1) (1).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../.gitbook/assets/image (3) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
 
 Another reason for categorizing spans into assets is to be able to better compare them. There is no sense in comparing an endpoint to a database query, for example. In each category, it is possible to sort the assets based on duration, performance impact, errors, and other criteria.&#x20;
 

diff --git a/installation/central-on-prem-install.md b/installation/central-on-prem-install.md
@@ -70,7 +70,7 @@ To check everything is working properly we can check the pod status and make sur
 
 For example, this is the expected output:
 
-<figure><img src="../.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
 
 **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
@@ -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.
 
-<figure><img src="../../.gitbook/assets/image (2) (1) (1).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../.gitbook/assets/image (2) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
 
 Clicking the link will add the needed dependencies to your `pom.xml` or `build.gradle` files.
 

diff --git a/...tomatic-instrumentation-in-the-ide/spring-spring-boot-dropwizard-and-default.md b/...tomatic-instrumentation-in-the-ide/spring-spring-boot-dropwizard-and-default.md
@@ -11,14 +11,14 @@ description: >-
 
 <div align="left">
 
-<figure><img src="../../.gitbook/assets/image (2) (1).png" alt="" width="113"><figcaption></figcaption></figure>
+<figure><img src="../../.gitbook/assets/image (2) (1) (1).png" alt="" width="113"><figcaption></figcaption></figure>
 
 
 
-<figure><img src="../../.gitbook/assets/image (3) (1).png" alt="" width="123"><figcaption></figcaption></figure>
+<figure><img src="../../.gitbook/assets/image (3) (1) (1).png" alt="" width="123"><figcaption></figcaption></figure>
 
 
 
-<figure><img src="../../.gitbook/assets/image (4) (1).png" alt="" width="188"><figcaption></figcaption></figure>
+<figure><img src="../../.gitbook/assets/image (4) (1) (1).png" alt="" width="188"><figcaption></figcaption></figure>
 
 </div>
diff --git a/...ng-boot-dropwizard-and-default/covering-more-of-your-code-with-observability.md b/...ng-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.
 
-<figure><img src="../../.gitbook/assets/image (1) (1).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../.gitbook/assets/image (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
 
 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.
 
@@ -29,4 +29,4 @@ Digma is unrolling a new feature to allow developers to automatically instrument
 
 To enable `Extended Observability` open the Digma plugin settings page and type in the name of your application package under the `Extended Observability (beta)` property.
 
-<figure><img src="../../.gitbook/assets/image (3).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../.gitbook/assets/image (3) (1).png" alt=""><figcaption></figcaption></figure>
diff --git a/...dropwizard-and-default/instrumenting-your-code-in-ci-staging-or-the-terminal.md b/...dropwizard-and-default/instrumenting-your-code-in-ci-staging-or-the-terminal.md
@@ -42,7 +42,7 @@ This information will be used when identifying issues. For example, here is the
 
 
 
-<figure><img src="../../.gitbook/assets/image (1).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../.gitbook/assets/image (1) (1).png" alt=""><figcaption></figcaption></figure>
 
 
 

diff --git a/use-cases-wip/get-early-feedback-about-code-changes.md b/use-cases-wip/get-early-feedback-about-code-changes.md
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
@@ -0,0 +1,26 @@
+---
+description: >-
+  One thing that Digma tries to do is make observability proactive. This means
+  that if there are any issues you shouldn't encounter them when it's already
+  late in the dev/release process
+---
+
+# Get early feedback on bottlenecks and code issues
+
+### Learn of code-related issues, from multiple environments
+
+As the code gets executed, either in your local environment, in CI staging, or in production - Digma learns about how it performs, scales, and identifies any process issues or anti-patterns that should be dealt with.&#x20;
+
+As you work on your code, any newly detected issues will appear in the issues side panel as `unread`.&#x20;
+
+<figure><img src="../.gitbook/assets/image (4).png" alt=""><figcaption></figcaption></figure>
+
+Additionally, the code itself will be highlighted to signify whether any critical issues are present:
+
+<figure><img src="../.gitbook/assets/image.png" alt=""><figcaption></figcaption></figure>
+
+### 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.
+
+<figure><img src="../.gitbook/assets/image (1).png" alt=""><figcaption></figcaption></figure>
diff --git a/use-cases-wip/prioritize-technical-debt.md b/use-cases-wip/prioritize-technical-debt.md
@@ -1,2 +1,24 @@
 # Prioritize Technical Debt
 
+Beyond simply identifying issues. Digma also analyzes their effect on the application to determine their criticality.&#x20;
+
+### Issue criticality
+
+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.&#x20;
+
+<figure><img src="../.gitbook/assets/image (2).png" alt=""><figcaption></figcaption></figure>
+
+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:
+
+<figure><img src="../.gitbook/assets/image (3).png" alt=""><figcaption></figcaption></figure>
+
+### Asset performance impact
+
+Digma assesses each asset (query, code location, endpoint etc.) to determine its performance impact on the application. This helps identify the best candidates for optimization that would carry the most 'punch for the bucks' if their performance is improved. Assessment of performance impact is available only in shared environments such as CI/staging or production and relies on measuring actual usage.
+
+For example, a slow query that is rarely used or has a marginal effect on the overall request would be ranked lower than a slow query that is heavily used and critically affects multiple flows.
+
+
+
+
+
diff --git a/...ntly-by-understanding-the-system-flows.md → ...on-flows-better-for-faster-development.md b/...ntly-by-understanding-the-system-flows.md → ...on-flows-better-for-faster-development.md
@@ -4,7 +4,7 @@ description: >-
   out changes faster and without issues.
 ---
 
-# Understand the application flows better for faster development
+# Design and write code more efficiently by understanding the system flows
 
 ### See runtime usages
Original file line number	Diff line number	Diff line change
Expand Up		@@ -42,7 +42,7 @@ This information will be used when identifying issues. For example, here is the



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



Expand Down