summaryrefslogtreecommitdiffstats
path: root/ml
diff options
context:
space:
mode:
authorAndrew Maguire <andrewm4894@gmail.com>2022-06-17 08:07:07 +0100
committerGitHub <noreply@github.com>2022-06-17 08:07:07 +0100
commit7ebbf65e93b95e72d29db30ba1f0af83b5c8c0cc (patch)
tree11cc964c0fb895a344b0f78fa58238b90eb0912a /ml
parente6ccb2f9ad031bcc466260b9da288c01bcb2e63a (diff)
enable ml by default (#13158)
* enabled ml by default
Diffstat (limited to 'ml')
-rw-r--r--ml/Config.cc2
-rw-r--r--ml/README.md12
2 files changed, 8 insertions, 6 deletions
diff --git a/ml/Config.cc b/ml/Config.cc
index 951cc039f2..4afa7c033b 100644
--- a/ml/Config.cc
+++ b/ml/Config.cc
@@ -22,7 +22,7 @@ static T clamp(const T& Value, const T& Min, const T& Max) {
void Config::readMLConfig(void) {
const char *ConfigSectionML = CONFIG_SECTION_ML;
- bool EnableAnomalyDetection = config_get_boolean(ConfigSectionML, "enabled", false);
+ bool EnableAnomalyDetection = config_get_boolean(ConfigSectionML, "enabled", true);
/*
* Read values
diff --git a/ml/README.md b/ml/README.md
index cb8384a66b..428071417c 100644
--- a/ml/README.md
+++ b/ml/README.md
@@ -8,9 +8,9 @@ keywords: [machine learning, anomaly detection, Netdata ML]
## Overview
-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 minimal configuration required.
+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).
-🚧 **Note**: This functionality is still under active development and considered experimental. Changes might cause the feature to break. We dogfood it internally and among early adopters within the Netdata community to build the feature. If you would like to get involved and help us with some feedback, email us at analytics-ml-team@netdata.cloud, comment on the [beta launch post](https://community.netdata.cloud/t/anomaly-advisor-beta-launch/2717) in the Netdata community, or come join us in the [🤖-ml-powered-monitoring](https://discord.gg/4eRSEUpJnc) channel of the Netdata discord.
+🚧 **Note**: If you would like to get involved and help us with some feedback, email us at analytics-ml-team@netdata.cloud, comment on the [beta launch post](https://community.netdata.cloud/t/anomaly-advisor-beta-launch/2717) in the Netdata community, or come join us in the [🤖-ml-powered-monitoring](https://discord.gg/4eRSEUpJnc) channel of the Netdata discord.
Once ML is enabled, Netdata will begin training a model for each dimension. By default this model is a [k-means clustering](https://en.wikipedia.org/wiki/K-means_clustering) model trained on the most recent 4 hours of data. Rather than just using the most recent value of each raw metric, the model works on a preprocessed ["feature vector"](#feature-vector) of recent smoothed and differenced values. This should enable the model to detect a wider range of potentially anomalous patterns in recent observations as opposed to just point anomalies like big spikes or drops. ([This infographic](https://user-images.githubusercontent.com/2178292/144414415-275a3477-5b47-43d6-8959-509eb48ebb20.png) shows some different types of anomalies.)
@@ -145,9 +145,11 @@ The query returns a list of dimension anomaly rates for all dimensions that were
## Configuration
-To enable anomaly detection:
+If you are running a netdata version after `v1.35.0-29-nightly` then ML will be enabled by default.
+
+To enable or disable anomaly detection:
1. Find and open the Netdata configuration file `netdata.conf`.
-2. In the `[ml]` section, set `enabled = yes`.
+2. In the `[ml]` section, set `enabled = yes` to enable or `enabled = no` to disable.
3. Restart netdata (typically `sudo systemctl restart netdata`).
**Note**: If you would like to learn more about configuring Netdata please see [the configuration guide](https://learn.netdata.cloud/guides/step-by-step/step-04).
@@ -156,7 +158,7 @@ Below is a list of all the available configuration params and their default valu
```
[ml]
- # enabled = no
+ # enabled = yes
# maximum num samples to train = 14400
# minimum num samples to train = 3600
# train every = 3600