From dd814a7c1a8de056a79f7238578b09236edd5506 Mon Sep 17 00:00:00 2001
From: Daniel Baumann <daniel.baumann@progress-linux.org>
Date: Thu, 10 Aug 2023 11:18:49 +0200
Subject: Adding upstream version 1.42.0.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
---
 integrations/templates/troubleshooting.md | 92 +++++++++++++++++++++++++++++++
 1 file changed, 92 insertions(+)
 create mode 100644 integrations/templates/troubleshooting.md

(limited to 'integrations/templates/troubleshooting.md')

diff --git a/integrations/templates/troubleshooting.md b/integrations/templates/troubleshooting.md
new file mode 100644
index 000000000..f78d49a7f
--- /dev/null
+++ b/integrations/templates/troubleshooting.md
@@ -0,0 +1,92 @@
+[% if entry.integration_type == 'collector' %]
+[% if entry.meta.plugin_name is in(['go.d.plugin', 'python.d.plugin', 'charts.d.plugin']) %]
+## Troubleshooting
+
+### Debug Mode
+
+To troubleshoot issues with the `[[ entry.meta.module_name ]]` collector, run the `[[ entry.meta.plugin_name ]]` with the debug option enabled. The output
+should give you clues as to why the collector isn't working.
+
+- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
+  your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
+
+  ```bash
+  cd /usr/libexec/netdata/plugins.d/
+  ```
+
+- Switch to the `netdata` user.
+
+  ```bash
+  sudo -u netdata -s
+  ```
+
+[% if entry.meta.plugin_name == 'go.d.plugin' %]
+- Run the `go.d.plugin` to debug the collector:
+
+  ```bash
+  ./go.d.plugin -d -m [[ entry.meta.module_name ]]
+  ```
+
+[% elif entry.meta.plugin_name == 'python.d.plugin' %]
+- Run the `python.d.plugin` to debug the collector:
+
+  ```bash
+  ./python.d.plugin [[ entry.meta.module_name ]] debug trace
+  ```
+
+[% elif entry.meta.plugin_name == 'charts.d.plugin' %]
+- Run the `charts.d.plugin` to debug the collector:
+
+  ```bash
+  ./charts.d.plugin debug 1 [[ entry.meta.module_name ]]
+  ```
+
+[% endif %]
+[% else %]
+[% if entry.troubleshooting.problems.list %]
+## Troubleshooting
+
+[% endif %]
+[% endif %]
+[% elif entry.integration_type == 'notification' %]
+[% if 'cloud-notifications' in entry._src_path|string %]
+[% if entry.troubleshooting.problems.list %]
+## Troubleshooting
+
+[% endif %]
+[% else %]
+## Troubleshooting
+
+### Test Notification
+
+You can run the following command by hand, to test alerts configuration:
+
+```bash
+# become user netdata
+sudo su -s /bin/bash netdata
+
+# enable debugging info on the console
+export NETDATA_ALARM_NOTIFY_DEBUG=1
+
+# send test alarms to sysadmin
+/usr/libexec/netdata/plugins.d/alarm-notify.sh test
+
+# send test alarms to any role
+/usr/libexec/netdata/plugins.d/alarm-notify.sh test "ROLE"
+```
+
+Note that this will test _all_ alert mechanisms for the selected role.
+
+[% endif %]
+[% elif entry.integration_type == 'exporter' %]
+[% if entry.troubleshooting.problems.list %]
+## Troubleshooting
+
+[% endif %]
+[% endif %]
+[% for item in entry.troubleshooting.problems.list %]
+### [[ item.name ]]
+
+[[ description ]]
+
+[% endfor %]
-- 
cgit v1.2.3