summaryrefslogtreecommitdiffstats
path: root/collectors/python.d.plugin/puppet
diff options
context:
space:
mode:
Diffstat (limited to 'collectors/python.d.plugin/puppet')
-rw-r--r--collectors/python.d.plugin/puppet/README.md26
-rw-r--r--collectors/python.d.plugin/puppet/metrics.csv5
2 files changed, 28 insertions, 3 deletions
diff --git a/collectors/python.d.plugin/puppet/README.md b/collectors/python.d.plugin/puppet/README.md
index 8b98b8a2d..3b0c55b97 100644
--- a/collectors/python.d.plugin/puppet/README.md
+++ b/collectors/python.d.plugin/puppet/README.md
@@ -4,10 +4,10 @@ custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/pyth
sidebar_label: "Puppet"
learn_status: "Published"
learn_topic_type: "References"
-learn_rel_path: "References/Collectors references/Provisioning tools"
+learn_rel_path: "Integrations/Monitor/Provisioning tools"
-->
-# Puppet monitoring with Netdata
+# Puppet collector
Monitor status of Puppet Server and Puppet DB.
@@ -65,6 +65,26 @@ When no configuration is given, module uses `https://fqdn.example.com:8140`.
- Secure PuppetDB config may require client certificate. Not applies
to default PuppetDB configuration though.
----
+
+### Troubleshooting
+
+To troubleshoot issues with the `puppet` 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 `puppet` module in debug mode:
+
+```bash
+./python.d.plugin puppet debug trace
+```
+
diff --git a/collectors/python.d.plugin/puppet/metrics.csv b/collectors/python.d.plugin/puppet/metrics.csv
new file mode 100644
index 000000000..1ec99e10e
--- /dev/null
+++ b/collectors/python.d.plugin/puppet/metrics.csv
@@ -0,0 +1,5 @@
+metric,scope,dimensions,unit,description,chart_type,labels,plugin,module
+puppet.jvm,,"committed, used",MiB,JVM Heap,area,,python.d.plugin,puppet
+puppet.jvm,,"committed, used",MiB,JVM Non-Heap,area,,python.d.plugin,puppet
+puppet.cpu,,"execution, GC",percentage,CPU usage,stacked,,python.d.plugin,puppet
+puppet.fdopen,,used,descriptors,File Descriptors,line,,python.d.plugin,puppet