fix a guide so we can reference it's subsections (#13455)
Tasos Katsoulas committed
Jul 29, 2022 at 16:48 UTC
82649b6e78891510c92573b80bf3e721d584a325
1 file changed
+6
-6
docs/guides/monitor/anomaly-detection.md
+6
-6
@@ -10,7 +10,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/moni
10
11
12
13
-# Overview
13
+## Overview
14
15
As of [`v1.32.0`](https://github.com/netdata/netdata/releases/tag/v1.32.0), Netdata comes with some ML powered [anomaly detection](https://en.wikipedia.org/wiki/Anomaly_detection) capabilities built into it and available to use out of the box, with zero configuration required (ML was enabled by default in `v1.35.0-29-nightly` in [this PR](https://github.com/netdata/netdata/pull/13158), previously it required a one line config change).
16
@@ -32,7 +32,7 @@ The fundamentals of Netdata's anomaly detection approach and implmentation are c
32
33
This guide will explain how to get started using these ML based anomaly detection capabilities within Netdata.
34
35
-# Anomaly Advisor
35
+## Anomaly Advisor
36
37
The [Anomaly Advisor](https://learn.netdata.cloud/docs/cloud/insights/anomaly-advisor) is the flagship anomaly detection feature within Netdata. In the "Anomalies" tab of Netdata you will see an overall "Anomaly Rate" chart that aggregates node level anomaly rate for all nodes in a space. The aim of this chart is to make it easy to quickly spot periods of time where the overall "[node anomaly rate](https://learn.netdata.cloud/docs/agent/ml#node-anomaly-rate)" is evelated in some unusual way and for what node or nodes this relates to.
38
@@ -42,7 +42,7 @@ Once an area on the Anomaly Rate chart is highlighted netdata will append a "hea
42
43
44
45
-# Embedded Anomaly Rate Charts
45
+## Embedded Anomaly Rate Charts
46
47
Charts in both the [Overview](https://learn.netdata.cloud/docs/cloud/visualize/overview) and [single node dashboard](https://learn.netdata.cloud/docs/cloud/visualize/overview#jump-to-single-node-dashboards) tabs also expose the underlying anomaly rates for each dimension so users can easily see if the raw metrics are considered anomalous or not by Netdata.
48
@@ -50,7 +50,7 @@ Pressing the anomalies icon (next to the information icon in the chart header) w
50
51
52
53
-# Anomaly Rate Based Alerts
53
+## Anomaly Rate Based Alerts
54
55
It is possible to use the `anomaly-bit` when defining traditional Alerts within netdata. The `anomaly-bit` is just another `options` parameter that can be passed as part of an [alarm line lookup](https://learn.netdata.cloud/docs/agent/health/reference#alarm-line-lookup).
56
@@ -61,7 +61,7 @@ You can see some example ML based alert configurations below:
61
- [Anomaly rate based node level alarm](https://learn.netdata.cloud/docs/agent/health/reference#example-10---anomaly-rate-based-node-level-alarm)
62
- More examples in the [`/health/health.d/ml.conf`](https://github.com/netdata/netdata/blob/master/health/health.d/ml.conf) file that ships with the agent.
63
64
-# Learn More
64
+## Learn More
65
66
Check out the resources below to learn more about how Netdata is approaching ML:
67
@@ -72,4 +72,4 @@ Check out the resources below to learn more about how Netdata is approaching ML:
72
- Netdata Approach to ML [blog post](https://www.netdata.cloud/blog/our-approach-to-machine-learning/).
73
- `areal/ml` related [GitHub Discussions](https://github.com/netdata/netdata/discussions?discussions_q=label%3Aarea%2Fml).
74
- Netdata Machine Learning Meetup [deck](https://docs.google.com/presentation/d/1rfSxktg2av2k-eMwMbjN0tXeo76KC33iBaxerYinovs/edit?usp=sharing) and [YouTube recording](https://www.youtube.com/watch?v=eJGWZHVQdNU).
75
-- Netdata Anomaly Advisor [YouTube Playlist](https://youtube.com/playlist?list=PL-P-gAHfL2KPeUcCKmNHXC-LX-FfdO43j).
\ No newline at end of file
75
+- Netdata Anomaly Advisor [YouTube Playlist](https://youtube.com/playlist?list=PL-P-gAHfL2KPeUcCKmNHXC-LX-FfdO43j).