-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add Graph Insights and Watchdog Explains docs (#24141)
* Add Graph Insights and Watchdog Explains docs * Fix title * Fix reference link * Add info div to graph insight for individual feature * Add filter features and images * Add suggestions from PM review * Update images * Fix links * Apply suggestions from code review * Fix broken link * Apply suggestions from code review Co-authored-by: Jen Gilbert <[email protected]> --------- Co-authored-by: Jen Gilbert <[email protected]>
- Loading branch information
Showing
8 changed files
with
116 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
--- | ||
title: Graph Insights | ||
disable_toc: false | ||
further_reading: | ||
- link: "/watchdog/insights/" | ||
tag: "Documentation" | ||
text: "Learn more about Watchdog Insights" | ||
--- | ||
|
||
## Overview | ||
|
||
Graph insights can help you find potential root causes for an observed issue by searching for other metrics that exhibited irregular behavior around the same time. Metric Correlations scans your metrics from different sources, such as dashboards, integrations, APM, and custom metrics. | ||
|
||
## Metric Correlations | ||
|
||
<div class="alert alert-info">Metric Correlations is available for <a href="https://docs.datadoghq.com/dashboards/widgets/timeseries/">Timeseries widgets</a> with the <strong>Metric</strong> data source.</div> | ||
|
||
To target the search more effectively, Metric Correlations uses information about related dashboards and services. Correlations can sift through metrics from various sources, including APM, integrations, and dashboards, as well as arbitrary metric namespaces you select. It searches for irregularities in other metrics over the corresponding time period, enabling Datadog to automatically provide clues that facilitate a more efficient root cause analysis. | ||
|
||
For more information, see the [Metric Correlations][1] documentation. | ||
|
||
## Watchdog Explains | ||
|
||
<div class="alert alert-info">Watchdog Explains is available for <a href="https://docs.datadoghq.com/dashboards/widgets/timeseries/">Timeseries widgets</a> with the <strong>Metric</strong> data source.</div> | ||
|
||
Datadog collects various types of data to provide insights into application performance, including metrics, traces, and logs, which tell you what, how, and why something is happening. Watchdog Explains analyzes high-level trends such as latency, error rates, or request count evolution to detect critical signals. Upon observing a spike in these graphs, Watchdog Explains helps you investigate the immediate questions: | ||
- What is the source of the spike? | ||
- Does this anomaly affect everyone or is an isolated incident? | ||
|
||
For more information, see the [Watchdog Explains][2] documentation. | ||
|
||
## Further reading | ||
|
||
{{< partial name="whats-next/whats-next.html" >}} | ||
|
||
[1]: /dashboards/graph_insights/correlations/ | ||
[2]: /dashboards/graph_insights/watchdog_explains/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
--- | ||
title: Watchdog Explains | ||
aliases: | ||
- /graphing/correlations/ | ||
- /dashboards/correlations/ | ||
further_reading: | ||
- link: "/watchdog/insights/" | ||
tag: "Documentation" | ||
text: "Learn more about Watchdog Insights" | ||
--- | ||
|
||
## Overview | ||
|
||
{{< beta-callout url="https://www.datadoghq.com/private-beta/watchdog-explains-graph-insights/">}} | ||
Watchdog Explains is available in Private Beta. To request access, complete the form. | ||
{{< /beta-callout >}} | ||
|
||
<div class="alert alert-info">Watchdog Explains is available for <a href="https://docs.datadoghq.com/dashboards/widgets/timeseries/">Timeseries widgets</a> with the <strong>Metric</strong> data source.</div> | ||
|
||
{{< img src="dashboards/graph_insights/watchdog_explains/watchdog_explains_walkthrough.mp4" alt="A walkthrough of the Watchdog Explains product" video=true >}} | ||
|
||
Watchdog Explains is an investigation assitant that guides you to the root cause of anomalies on any timeseries graph. | ||
|
||
In Datadog, an investigation typically starts with graphs, then branches out into investigating individual assets. Watchdog Explains makes investigations more efficient by automatically showing which individual tags account could be responsible for a given spike. This allows you to focus your investigation on problematic areas of your infrastructure or software stack. | ||
|
||
## How does it work? | ||
|
||
1. **Watchdog Explains runs anomaly detection** and determines if the graph shape or value changed from the historical pattern. It scans metric-based graphs to look for anomalies and dissects the anomaly to show which tags are responsible. | ||
|
||
2. **Then, it runs the same query filtered on each applicable tag group**. It compares the same timeseries data across each applicable tag group against the source graph to identify which ones represent that anomalous behavior. | ||
- If a graph’s shape changes significantly by removing an individual tag group, it infers that the tag is mostly likely the cause of the spike. | ||
- Watchdog Explains shows you evidence to quantify exactly how influential a given tag is. | ||
|
||
|
||
## Investigate anomalies | ||
|
||
Start your investigation from any timeseries metric graph. Open a graph in full screen to trigger Watchdog Explains. | ||
|
||
{{< img src="dashboards/graph_insights/watchdog_explains/graph_anomaly_detection.png" alt="Watchdog Explains highlights the anomalous parts of a graph based on historical data" style="width:90%;" >}} | ||
|
||
Watchdog Explains highlights anomalies with a pink box. On the right side panel, you can view the tags that are responsible for the spike. Click on a tag to see evidence of how it contributes to the graph shape. | ||
|
||
{{< img src="dashboards/graph_insights/watchdog_explains/graph_filter_tag.png" alt="Filter out the offending tag, in this case researcher-query, to compare the original against what the graph would look like without the offending tag" style="width:90%;" >}} | ||
|
||
|
||
## Further reading | ||
|
||
{{< partial name="whats-next/whats-next.html" >}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file added
BIN
+144 KB
.../images/dashboards/graph_insights/watchdog_explains/graph_anomaly_detection.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+148 KB
static/images/dashboards/graph_insights/watchdog_explains/graph_filter_tag.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+22.5 MB
static/images/dashboards/graph_insights/watchdog_explains/watchdog_explains_walkthrough.mp4
Binary file not shown.