diff --git a/docs/docs/analyzer/concepts.mdx b/docs/docs/analyzer/concepts.mdx index e094889c54..3551fc710d 100644 --- 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 index b4d1d0819f..bf001bcd48 100644 --- 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 index a99629243b..1509c447eb 100644 --- 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 index 4397da305f..a8b6dbdd70 100644 --- 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 new file mode 100644 index 0000000000..d2209f870a Binary files /dev/null and b/docs/docs/img/516816935/common-problems.png differ diff --git a/docs/docs/img/516816935/otel-semantic-conventions.png b/docs/docs/img/516816935/otel-semantic-conventions.png new file mode 100644 index 0000000000..f6c04d6e95 Binary files /dev/null and b/docs/docs/img/516816935/otel-semantic-conventions.png differ diff --git a/docs/docs/img/516816935/security.png b/docs/docs/img/516816935/security.png new file mode 100644 index 0000000000..224b73078b Binary files /dev/null and b/docs/docs/img/516816935/security.png differ diff --git a/docs/docs/img/analyzer-results-0.14.png b/docs/docs/img/analyzer-results-0.14.png new file mode 100644 index 0000000000..ce8539f4fa Binary files /dev/null and b/docs/docs/img/analyzer-results-0.14.png differ diff --git a/docs/docs/img/common-problems.png b/docs/docs/img/common-problems.png new file mode 100644 index 0000000000..d2209f870a Binary files /dev/null and b/docs/docs/img/common-problems.png differ diff --git a/docs/docs/img/otel-semantic-conventions.png b/docs/docs/img/otel-semantic-conventions.png new file mode 100644 index 0000000000..f6c04d6e95 Binary files /dev/null and b/docs/docs/img/otel-semantic-conventions.png differ diff --git a/docs/docs/img/security.png b/docs/docs/img/security.png new file mode 100644 index 0000000000..224b73078b Binary files /dev/null and b/docs/docs/img/security.png differ