docs: Add Trace Analyzer Images (#3781)

Add Trace Analyzer Images
kubeshop · Apr 10, 2024 · b481593 · b481593
1 parent 8166642
commit b481593
Show file tree

Hide file tree

Showing 11 changed files with 14 additions and 2 deletions.
diff --git a/docs/docs/analyzer/concepts.mdx b/docs/docs/analyzer/concepts.mdx
@@ -11,10 +11,16 @@ keywords:
 image: https://res.cloudinary.com/djwdcmwdz/image/upload/v1698686403/docs/Blog_Thumbnail_14_rsvkmo.jpg
 ---
 
-The Tracetest Analyzer is a plugin-based framework used to analyze OpenTelemetry traces to help teams improve their instrumentation data, find potential problems and provide tips to fix the problems.
+The Trace Analyzer is a plugin-based framework used to analyze OpenTelemetry traces to help teams improve their instrumentation data, find potential problems and provide tips to fix the problems.
+
+When viewing a test in the Tracetest Web UI, the **Analyzer Results** pane is on the **Trace** tab.
+
+![Analyzer Results](../img/analyzer-results-0.14.png)
 
 ## Plugins
 
+The following plugins are available in the Trace Analyzer:
+
 - [OpenTelemetry Semantic Conventions](/analyzer/plugins/otel-semantic-conventions)
 - [Security](/analyzer/plugins/security)
 - [Common Problems](/analyzer/plugins/common-problems)

diff --git a/docs/docs/analyzer/plugins/common-problems.mdx b/docs/docs/analyzer/plugins/common-problems.mdx
@@ -13,6 +13,8 @@ image: https://res.cloudinary.com/djwdcmwdz/image/upload/v1698686403/docs/Blog_T
 
 The `Common Problems` plugin is responsible of analyzing the spans that are part of a trace in order to identify frequent mistakes in the distributed system.
 
+![Common Problems](../../img/common-problems.png)
+
 ## Rules
 
 - [prefer-dns](/analyzer/rules/prefer-dns)
diff --git a/docs/docs/analyzer/plugins/otel-semantic-conventions.mdx b/docs/docs/analyzer/plugins/otel-semantic-conventions.mdx
@@ -13,9 +13,11 @@ image: https://res.cloudinary.com/djwdcmwdz/image/upload/v1698686403/docs/Blog_T
 
 The `OpenTelemetry Semantic Conventions` plugin analyzes the spans that are part of a trace in order to identify problematic patterns. The set of rules follows the OpenTelemetry conventions to ensure the quality of the telemetry data.
 
+![OTel Semantic Conventions](../../img/otel-semantic-conventions.png)
+
 ## Rules
 
 - [span-naming](/analyzer/rules/span-naming)
-- [attribute-naming](/analyzer/rules/attribute-naming)
 - [required-attributes](/analyzer/rules/required-attributes)
+- [attribute-naming](/analyzer/rules/attribute-naming)
 - [no-empty-attributes](/analyzer/rules/no-empty-attributes)
diff --git a/docs/docs/analyzer/plugins/security.mdx b/docs/docs/analyzer/plugins/security.mdx
@@ -13,6 +13,8 @@ image: https://res.cloudinary.com/djwdcmwdz/image/upload/v1698686403/docs/Blog_T
 
 The `Security` plugin is responsible for analyzing the spans that are part of a trace in order to identify security problems in the distributed system.
 
+![Security](../../img/security.png)
+
 ## Rules
 
 - [secure-https-protocol](/analyzer/rules/secure-https-protocol)

diff --git a/docs/docs/img/516816935/common-problems.png b/docs/docs/img/516816935/common-problems.png
diff --git a/docs/docs/img/516816935/otel-semantic-conventions.png b/docs/docs/img/516816935/otel-semantic-conventions.png
diff --git a/docs/docs/img/516816935/security.png b/docs/docs/img/516816935/security.png
diff --git a/docs/docs/img/analyzer-results-0.14.png b/docs/docs/img/analyzer-results-0.14.png
diff --git a/docs/docs/img/common-problems.png b/docs/docs/img/common-problems.png
diff --git a/docs/docs/img/otel-semantic-conventions.png b/docs/docs/img/otel-semantic-conventions.png
diff --git a/docs/docs/img/security.png b/docs/docs/img/security.png