summaryrefslogtreecommitdiffstats
path: root/integrations/templates
diff options
context:
space:
mode:
Diffstat (limited to 'integrations/templates')
-rw-r--r--integrations/templates/metrics.md2
-rw-r--r--integrations/templates/overview.md2
-rw-r--r--integrations/templates/overview/authentication.md9
-rw-r--r--integrations/templates/setup.md6
-rw-r--r--integrations/templates/troubleshooting.md37
5 files changed, 52 insertions, 4 deletions
diff --git a/integrations/templates/metrics.md b/integrations/templates/metrics.md
index 8a75d7317..0d5be7b67 100644
--- a/integrations/templates/metrics.md
+++ b/integrations/templates/metrics.md
@@ -2,7 +2,7 @@
## Metrics
[% if entry.metrics.folding.enabled and not clean %]
-{% details summary="[[ entry.metrics.folding.title ]]" %}
+{% details open=true summary="[[ entry.metrics.folding.title ]]" %}
[% endif %]
Metrics grouped by *scope*.
diff --git a/integrations/templates/overview.md b/integrations/templates/overview.md
index b89e51543..3063b6860 100644
--- a/integrations/templates/overview.md
+++ b/integrations/templates/overview.md
@@ -4,4 +4,6 @@
[% include 'overview/exporter.md' %]
[% elif entry.integration_type == 'notification' %]
[% include 'overview/notification.md' %]
+[% elif entry.integration_type == 'authentication' %]
+[% include 'overview/authentication.md' %]
[% endif %]
diff --git a/integrations/templates/overview/authentication.md b/integrations/templates/overview/authentication.md
new file mode 100644
index 000000000..f7fa77520
--- /dev/null
+++ b/integrations/templates/overview/authentication.md
@@ -0,0 +1,9 @@
+# [[ entry.meta.name ]]
+
+[[ entry.overview.authentication_description ]]
+[% if entry.overview.authentication_limitations %]
+
+## Limitations
+
+[[ entry.overview.authentication_limitations ]]
+[% endif %]
diff --git a/integrations/templates/setup.md b/integrations/templates/setup.md
index 84a641b8d..1c41e8cf9 100644
--- a/integrations/templates/setup.md
+++ b/integrations/templates/setup.md
@@ -45,7 +45,7 @@ Configuration for this specific integration is located in the `[[ entry.setup.co
[% endif %]
You can edit the configuration file using the `edit-config` script from the
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration.md#the-netdata-config-directory).
+Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
```bash
cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
@@ -60,7 +60,7 @@ There is no configuration file.
[% if entry.setup.configuration.options.list %]
[% if entry.setup.configuration.options.folding.enabled and not clean %]
-{% details summary="[[ entry.setup.configuration.options.folding.title ]]" %}
+{% details open=true summary="[[ entry.setup.configuration.options.folding.title ]]" %}
[% endif %]
| Name | Description | Default | Required |
|:----|:-----------|:-------|:--------:|
@@ -92,7 +92,7 @@ There are no configuration options.
[[ example.description ]]
[% if example.folding.enabled and not clean %]
-{% details summary="[[ entry.setup.configuration.examples.folding.title ]]" %}
+{% details open=true summary="[[ entry.setup.configuration.examples.folding.title ]]" %}
[% endif %]
```yaml
[[ example.config ]]
diff --git a/integrations/templates/troubleshooting.md b/integrations/templates/troubleshooting.md
index f78d49a7f..2176dd010 100644
--- a/integrations/templates/troubleshooting.md
+++ b/integrations/templates/troubleshooting.md
@@ -4,6 +4,10 @@
### Debug Mode
+[% if entry.meta.plugin_name == 'go.d.plugin' %]
+**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
+[% endif %]
+
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.
@@ -42,6 +46,39 @@ should give you clues as to why the collector isn't working.
```
[% endif %]
+### Getting Logs
+
+If you're encountering problems with the `[[ entry.meta.module_name ]]` collector, follow these steps to retrieve logs and identify potential issues:
+
+- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
+- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
+
+#### System with systemd
+
+Use the following command to view logs generated since the last Netdata service restart:
+
+```bash
+journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep [[ entry.meta.module_name ]]
+```
+
+#### System without systemd
+
+Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
+
+```bash
+grep [[ entry.meta.module_name ]] /var/log/netdata/collector.log
+```
+
+**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
+
+#### Docker Container
+
+If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
+
+```bash
+docker logs netdata 2>&1 | grep [[ entry.meta.module_name ]]
+```
+
[% else %]
[% if entry.troubleshooting.problems.list %]
## Troubleshooting