diff options
author | Austin S. Hemmelgarn <austin@netdata.cloud> | 2023-08-02 10:01:04 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-08-02 10:01:04 -0400 |
commit | 6bba90a5320770220bb44acce4ca97e1604aefce (patch) | |
tree | 32efdbaf99ccafed2e95d71cbf5be7f3b599ff87 /integrations/templates | |
parent | 296e608d3fab66232ae07143dfb3d884febb8421 (diff) |
Assorted fixes for integrations templates. (#15702)
* Fix missing endif in template.
* Add h2 to setup template.
* Reduce duplication within the troubleshooting template.
* Add missing troubleshooting section for agent notifications.
* Fix path checking in troubleshooting template.
Diffstat (limited to 'integrations/templates')
-rw-r--r-- | integrations/templates/setup.md | 2 | ||||
-rw-r--r-- | integrations/templates/troubleshooting.md | 56 |
2 files changed, 11 insertions, 47 deletions
diff --git a/integrations/templates/setup.md b/integrations/templates/setup.md index 1af1974a83..4d41f7543b 100644 --- a/integrations/templates/setup.md +++ b/integrations/templates/setup.md @@ -1,3 +1,5 @@ +## Setup + [% if entry.setup.description %] [[ entry.setup.description ]] [% else %] diff --git a/integrations/templates/troubleshooting.md b/integrations/templates/troubleshooting.md index 2f418dfb9e..f78d49a7f3 100644 --- a/integrations/templates/troubleshooting.md +++ b/integrations/templates/troubleshooting.md @@ -1,10 +1,10 @@ [% if entry.integration_type == 'collector' %] -[% if entry.meta.plugin_name == 'go.d.plugin' %] +[% 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.module_name ]]` collector, run the `go.d.plugin` with the debug option enabled. The output +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 @@ -20,66 +20,28 @@ should give you clues as to why the collector isn't working. 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.module_name ]] + ./go.d.plugin -d -m [[ entry.meta.module_name ]] ``` [% elif entry.meta.plugin_name == 'python.d.plugin' %] -## Troubleshooting - -### Debug Mode - -To troubleshoot issues with the `[[ entry.module_name ]]` collector, run the `python.d.plugin` 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 - ``` - - Run the `python.d.plugin` to debug the collector: ```bash - ./python.d.plugin [[ entry.module_name ]] debug trace + ./python.d.plugin [[ entry.meta.module_name ]] debug trace ``` [% elif entry.meta.plugin_name == 'charts.d.plugin' %] -## Troubleshooting - -### Debug Mode - -To troubleshoot issues with the `[[ entry.module_name ]]` collector, run the `charts.d.plugin` 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 - ``` - - Run the `charts.d.plugin` to debug the collector: ```bash - ./charts.d.plugin debug 1 [[ entry.module_name ]] + ./charts.d.plugin debug 1 [[ entry.meta.module_name ]] ``` +[% endif %] [% else %] [% if entry.troubleshooting.problems.list %] ## Troubleshooting @@ -87,7 +49,7 @@ should give you clues as to why the collector isn't working. [% endif %] [% endif %] [% elif entry.integration_type == 'notification' %] -[% if 'cloud-notifications' in entry._src_path %] +[% if 'cloud-notifications' in entry._src_path|string %] [% if entry.troubleshooting.problems.list %] ## Troubleshooting @@ -115,6 +77,7 @@ export NETDATA_ALARM_NOTIFY_DEBUG=1 Note that this will test _all_ alert mechanisms for the selected role. +[% endif %] [% elif entry.integration_type == 'exporter' %] [% if entry.troubleshooting.problems.list %] ## Troubleshooting @@ -127,4 +90,3 @@ Note that this will test _all_ alert mechanisms for the selected role. [[ description ]] [% endfor %] -[% endif %] |