Trace analytics update (opensearch-project#7362)

* update the integration page to reflect the integration catalog and additional capabilities Signed-off-by: YANGDB <[email protected]> * update the integration documentation Signed-off-by: YANGDB <[email protected]> * Update schema section Signed-off-by: Simeon Widdis <[email protected]> * update the metrics analytics documentation Signed-off-by: YANGDB <[email protected]> * update the trace analytics documentation Signed-off-by: YANGDB <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Signed-off-by: Melissa Vagi <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Signed-off-by: Melissa Vagi <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Signed-off-by: Melissa Vagi <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Signed-off-by: Melissa Vagi <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Signed-off-by: Melissa Vagi <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Signed-off-by: Melissa Vagi <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Signed-off-by: Melissa Vagi <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Signed-off-by: Melissa Vagi <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Signed-off-by: Melissa Vagi <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Signed-off-by: Melissa Vagi <[email protected]> * Update ta-dashboards.md Signed-off-by: Melissa Vagi <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Signed-off-by: Melissa Vagi <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Signed-off-by: Melissa Vagi <[email protected]> * update service correlation index naming convention Signed-off-by: YANGDB <[email protected]> * Update ta-dashboards.md Signed-off-by: Melissa Vagi <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update ta-dashboards.md Signed-off-by: Melissa Vagi <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update ta-dashboards.md Signed-off-by: Melissa Vagi <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update ta-dashboards.md Signed-off-by: Melissa Vagi <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update ta-dashboards.md Signed-off-by: Melissa Vagi <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update ta-dashboards.md Signed-off-by: Melissa Vagi <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update ta-dashboards.md Signed-off-by: Melissa Vagi <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Signed-off-by: Melissa Vagi <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Signed-off-by: Melissa Vagi <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: YANGDB <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: YANGDB <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: YANGDB <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: YANGDB <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: YANGDB <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: YANGDB <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: YANGDB <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: YANGDB <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: YANGDB <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: YANGDB <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: YANGDB <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: YANGDB <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: YANGDB <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: YANGDB <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: YANGDB <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: YANGDB <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: YANGDB <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: YANGDB <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: YANGDB <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: YANGDB <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: YANGDB <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Signed-off-by: Melissa Vagi <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Signed-off-by: Melissa Vagi <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Signed-off-by: Melissa Vagi <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Signed-off-by: Melissa Vagi <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Signed-off-by: Melissa Vagi <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Signed-off-by: Melissa Vagi <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Signed-off-by: Melissa Vagi <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Signed-off-by: Melissa Vagi <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Signed-off-by: Melissa Vagi <[email protected]> * Update _observing-your-data/trace/ta-dashboards.md Signed-off-by: Melissa Vagi <[email protected]> --------- Signed-off-by: YANGDB <[email protected]> Signed-off-by: Simeon Widdis <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> Co-authored-by: Simeon Widdis <[email protected]> Co-authored-by: Melissa Vagi <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: [email protected] <[email protected]>
leanneeliatra · Jul 24, 2024 · b6edaf3 · b6edaf3
1 parent 9a59362
commit b6edaf3
Show file tree

Hide file tree

Showing 10 changed files with 128 additions and 9 deletions.
diff --git a/_observing-your-data/trace/ta-dashboards.md b/_observing-your-data/trace/ta-dashboards.md
@@ -1,25 +1,144 @@
 ---
 layout: default
-title: OpenSearch Dashboards plugin
+title: Trace Analytics plugin for OpenSearch Dashboards
 parent: Trace Analytics
 nav_order: 50
 redirect_from:
   - /observability-plugin/trace/ta-dashboards/
   - /monitoring-plugins/trace/ta-dashboards/
 ---
 
-# Trace Analytics OpenSearch Dashboards plugin
+# Trace Analytics plugin for OpenSearch Dashboards
 
-The Trace Analytics plugin for OpenSearch Dashboards provides at-a-glance visibility into your application performance, along with the ability to drill down on individual traces. For installation instructions, see [Standalone OpenSearch Dashboards plugin install]({{site.url}}{{site.baseurl}}/install-and-configure/install-dashboards/plugins/).
+The Trace Analytics plugin offers at-a-glance visibility into application performance based on [OpenTelemetry (OTel)](https://opentelemetry.io/) protocol data that standardizes instrumentation for collecting telemetry data from cloud-native software. 
 
-The **Dashboard** view groups traces together by HTTP method and path so that you can see the average latency, error rate, and trends associated with a particular operation. For a more focused view, try filtering by trace group name.
+## Installing the plugin
 
-![Dashboard view]({{site.url}}{{site.baseurl}}/images/ta-dashboard.png)
+See [Standalone OpenSearch Dashboards plugin install]({{site.url}}{{site.baseurl}}/install-and-configure/install-dashboards/plugins/) for instructions on how to install the Trace Analytics plugin.
 
-To drill down on the traces that make up a trace group, choose the number of traces in the column on the right. Then choose an individual trace for a detailed summary.
+## Setting up the OpenTelemetry Demo
 
-![Detailed trace view]({{site.url}}{{site.baseurl}}/images/ta-trace.png)
+The [OpenTelemetry Demo with OpenSearch](https://github.com/opensearch-project/opentelemetry-demo) simulates a distributed application generating real-time telemetry data, providing you with a practical environment in which to explore features available with the Trace Analytics plugin before implementing it in your environment.
 
-The **Services** view lists all services in the application, plus an interactive map that shows how the various services connect to each other. In contrast to the dashboard, which helps identify problems by operation, the service map helps identify problems by service. Try sorting by error rate or latency to get a sense of potential problem areas of your application.
 
-![Service view]({{site.url}}{{site.baseurl}}/images/ta-services.png)
+**Step 1: Set up the OpenTelemetry Demo**
+
+  - Clone the [OpenTelemetry Demo with OpenSearch](https://github.com/opensearch-project/opentelemetry-demo) repository: `git clone https://github.com/opensearch-project/opentelemetry-demo`.
+  - Follow the [Getting Started](https://github.com/opensearch-project/opentelemetry-demo/blob/main/tutorial/GettingStarted.md) instructions to deploy the demo application using Docker, which runs multiple microservices generating telemetry data.
+
+**Step 2: Ingest telemetry data**
+
+  - Configure the OTel collectors to send telemetry data (traces, metrics, logs) to your OpenSearch cluster, using the [preexisting setup](https://github.com/opensearch-project/opentelemetry-demo/tree/main/src/otelcollector).
+  - Confirm that [Data Prepper](https://github.com/opensearch-project/opentelemetry-demo/tree/main/src/dataprepper) is set up to process the incoming data, handle trace analytics and service map pipelines, submit data to required indexes, and perform preaggregated calculations.
+
+**Step 3: Explore Trace Analytics in OpenSearch Dashboards**
+
+The **Trace Analytics** application includes two options: **Services** and **Traces**:
+
+  - **Services** lists all services in the application, plus an interactive map that shows how the various services connect to each other. In contrast to the dashboard (which helps identify problems by operation), the **Service map** helps you identify problems by service based on error rates and latency. To access this option, go to **Trace Analytics** > **Services**.
+  - **Traces** groups traces together by HTTP method and path so that you can see the average latency, error rate, and trends associated with a particular operation. For a more focused view, try filtering by trace group name. To access this option, go to **Trace Analytics** > **Traces**. From the **Trace Groups** panel, you can review the traces that comprise a trace group. From the **Traces** panel you can analyze individual traces for a detailed summary.
+
+ **Step 4: Perform correlation analysis**
+  - Select **Services correlation** to display connections between various telemetry signals. This allows you to navigate from the logical service level to the associated metrics and logs for that specific service.
+
+---
+
+## Schema dependencies and assumptions
+
+The plugin requires you to use [Data Prepper]({{site.url}}{{site.baseurl}}/data-prepper/) to process and visualize OTel data and relies on the following Data Prepper pipelines for OTel correlations and service map calculations:
+
+- [Trace analytics pipeline]({{site.url}}{{site.baseurl}}/data-prepper/common-use-cases/trace-analytics/)
+- [Service map pipeline]({{site.url}}{{site.baseurl}}/data-prepper/pipelines/configuration/processors/service-map-stateful/)
+
+### Standardized telemetry data
+
+The plugin requires telemetry data to follow the OTel schema conventions, including the structure and naming of spans, traces, and metrics as specified by OTel, and to be implemented using the [Simple Schema for Observability]({{site.url}}{{site.baseurl}}/observing-your-data/ss4o/).
+
+### Service names and dependency map
+
+For accurate service mapping and correlation analysis, adhere to the following guidelines:
+
+- Service names must be unique and used consistently across application components.
+- The `serviceName` field must be populated using the Data Prepper pipeline.
+- Services must be ingested with predefined upstream and downstream dependencies to construct accurate service maps and understand service relationships.
+
+### Trace and span IDs
+
+Traces and spans must have consistently generated and maintained unique identifiers across distributed systems to enable end-to-end tracing and accurate performance insights.
+
+### RED metrics adherence
+
+The plugin expects metric data to include rate, error, and duration (RED) indicators for each service, either preaggregated using the Data Prepper pipeline or calculated dynamically based on spans. This allows you to effectively compute and display key performance indicators.
+
+### Correlation fields
+
+Certain fields, such as `serviceName`, must be present to perform correlation analysis. These fields enable the plugin to link related telemetry data and provide a holistic view of service interactions and dependencies.
+
+### Correlation indexes
+
+Navigating from the service dialog to its corresponding traces or logs requires the existence of correlating fields and that the target indexes (for example, logs) follow the specified naming conventions, as described at [Simple Schema for Observability](https://opensearch.org/docs/latest/observing-your-data/ss4o/).  
+
+---
+
+## Trace analytics with OTel protocol analytics
+Introduced 2.15
+{: .label .label-purple }
+
+Trace analytics with OTel protocol analytics provide comprehensive insights into distributed systems. You can visualize and analyze the following assets:
+
+- [Service](https://opentelemetry.io/docs/specs/semconv/resource/#service): The components of a distributed application. These components are significant logical terms used to measure and monitor the application's building blocks in order to validate the system's health.
+- [Traces](https://opentelemetry.io/docs/concepts/signals/traces/): A visual representation of a request's path across services into requests' journeys across services, offering insights into latency and performance issues.
+- [RED metrics](https://opentelemetry.io/docs/specs/otel/metrics/api/): Metrics for service health and performance, measured as requests per second (rate), failed requests (errors), and request processing time (duration). 
+
+### Trace analytics visualizations
+
+**Services** visualizations, such as a table or map, help you logically analyze service behavior and accuracy. The following visualizations can help you identify anomalies and errors:
+
+- **Services table**
+  - A RED indicator, along with connected upstream and downstream services and other actions, is indicated in each table column. An example **Services** table is shown in the following image.
+
+  ![Services table]({{site.url}}{{site.baseurl}}/images/trace-analytics/services-table.png)
+
+  - General-purpose filter selection is used for field or filter composition. The following image shows this filter.
+
+  ![Services filter selection]({{site.url}}{{site.baseurl}}/images/trace-analytics/services-filter-selection.png)
+
+  - The **Services** throughput tooltip provides an at-a-glance overview of a service's incoming request trend for the past 24 hours. The following image shows an example tooltip.
+
+  ![Services throughput tooltip ]({{site.url}}{{site.baseurl}}/images/trace-analytics/service-throughput-tooltip.png)
+
+  - The **Services** correlation dialog window provides an at-a-glance overview of a service's details, including its 24-hour throughput trend. You can use these details to analyze correlated logs or traces by filtering based on the `serviceName` field. The following image shows this window.
+
+  ![Services correlation dialog window]({{site.url}}{{site.baseurl}}/images/trace-analytics/single-service-correlation-dialog.png)
+
+  - The **Services** RED metrics dialog window provides an at-a-glance overview of a service's RED metrics indicators, including 24-hour error, duration, and throughput rate. The following image shows this window.
+
+  ![Services RED metrics for duration]({{site.url}}{{site.baseurl}}/images/trace-analytics/single-service-RED-metrics.png)
+
+  - The **Span details** dialog window provides the details of a trace. You can use this information to further analyze a trace's elements, such as attributes and associated logs. The following image shows this window.
+
+  ![Services Span details dialog window]({{site.url}}{{site.baseurl}}/images/trace-analytics/span-details-fly-out.png)
+
+- **Service map**
+  - The **Service map** displays nodes, each representing a service. The node color indicates the RED indicator severity for that service and its dependencies. The following image shows a map.
+
+  ![Services map tooltip]({{site.url}}{{site.baseurl}}/images/trace-analytics/service-details-tooltip.png)
+
+  - You can select a node to open a detailed dialog window for its associated service. This interactive map visualizes service interconnections, helping identify problems by service, unlike dashboards that identify issues by operation. You can sort by error rate or latency to pinpoint potential problem areas.
+
+  - In the **Service map** dialog window, nodes represent connected downstream services dependent on the selected service. The node color indicates the RED indicator severity for that service and its downstream dependencies. The following image shows this dialog window.
+
+  ![Service map dialog window]({{site.url}}{{site.baseurl}}/images/trace-analytics/single-service-fly-out.png)
+
+- **Trace groups**
+  - Traces are grouped by their HTTP API name, allowing clustering based on their business functional unit. Traces are grouped by HTTP method and path, displaying the average latency, error rate, and trends associated with a particular operation. You can filter by trace group name. The following image shows the **Trace Groups** window.
+
+  ![Trace Groups window]({{site.url}}{{site.baseurl}}/images/trace-analytics/trace-group-RED-metrics.png)
+
+  - In the **Trace Groups** window, you can filter by group name and other filters. You can also analyze associated traces. To drill down on the traces that comprise a group, select the number of traces in the right-hand column and then choose an individual trace to see a detailed summary.
+
+  ![Trace group dialog window]({{site.url}}{{site.baseurl}}/images/ta-dashboard.png)
+
+  - The **Trace details** window displays a breakdown of a single trace, including its corresponding spans, associated service names, and a waterfall chart of the spans' time and duration interactions. The following image shows this view.
+
+  ![Trace details window]({{site.url}}{{site.baseurl}}/images/ta-trace.png)
diff --git a/images/trace-analytics/service-details-tooltip.png b/images/trace-analytics/service-details-tooltip.png
diff --git a/images/trace-analytics/service-throughput-tooltip.png b/images/trace-analytics/service-throughput-tooltip.png
diff --git a/images/trace-analytics/services-filter-selection.png b/images/trace-analytics/services-filter-selection.png
diff --git a/images/trace-analytics/services-table.png b/images/trace-analytics/services-table.png
diff --git a/images/trace-analytics/single-service-RED-metrics.png b/images/trace-analytics/single-service-RED-metrics.png
diff --git a/images/trace-analytics/single-service-correlation-dialog.png b/images/trace-analytics/single-service-correlation-dialog.png
diff --git a/images/trace-analytics/single-service-fly-out.png b/images/trace-analytics/single-service-fly-out.png
diff --git a/images/trace-analytics/span-details-fly-out.png b/images/trace-analytics/span-details-fly-out.png
diff --git a/images/trace-analytics/trace-group-RED-metrics.png b/images/trace-analytics/trace-group-RED-metrics.png