summaryrefslogtreecommitdiffstats
path: root/collectors/python.d.plugin/changefinder/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'collectors/python.d.plugin/changefinder/README.md')
-rw-r--r--collectors/python.d.plugin/changefinder/README.md26
1 files changed, 23 insertions, 3 deletions
diff --git a/collectors/python.d.plugin/changefinder/README.md b/collectors/python.d.plugin/changefinder/README.md
index 326a69dd..0e9bab88 100644
--- a/collectors/python.d.plugin/changefinder/README.md
+++ b/collectors/python.d.plugin/changefinder/README.md
@@ -5,10 +5,10 @@ custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/pyth
sidebar_label: "changefinder"
learn_status: "Published"
learn_topic_type: "References"
-learn_rel_path: "References/Collectors references/QoS"
+learn_rel_path: "Integrations/Monitor/QoS"
-->
-# Online changepoint detection with Netdata
+# Online change point detection with Netdata
This collector uses the Python [changefinder](https://github.com/shunsukeaihara/changefinder) library to
perform [online](https://en.wikipedia.org/wiki/Online_machine_learning) [changepoint detection](https://en.wikipedia.org/wiki/Change_detection)
@@ -108,7 +108,7 @@ The default configuration should look something like this. Here you can see each
information about each one and what it does.
```yaml
-# ----------------------------------------------------------------------
+# -
# JOBS (data collection sources)
# Pull data from local Netdata node.
@@ -219,3 +219,23 @@ sudo su -s /bin/bash netdata
- Novelty and outlier detection in
the [scikit-learn documentation](https://scikit-learn.org/stable/modules/outlier_detection.html).
+### Troubleshooting
+
+To troubleshoot issues with the `changefinder` module, run the `python.d.plugin` with the debug option enabled. The
+output will give you the output of the data collection job or error messages on why the collector isn't working.
+
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
+plugin's directory, switch to the `netdata` user.
+
+```bash
+cd /usr/libexec/netdata/plugins.d/
+sudo su -s /bin/bash netdata
+```
+
+Now you can manually run the `changefinder` module in debug mode:
+
+```bash
+./python.d.plugin changefinder debug trace
+```
+