Add debug instructions for python modules (#4799)
Used instruction from @ilyam8 in #4085 to add a (How to debug python modules) section.
Chris Akritidis committed
Nov 30, 2018 at 15:41 UTC
39de47141707969662a61db7b17933fe0bfbba40
1 file changed
+14
-1
collectors/python.d.plugin/README.md
+14
-1
@@ -63,7 +63,20 @@ other_job:
63
64
`update_every`, `retries`, and `priority` are always optional.
65
66
----
66
+## How to debug a python module
67
+
68
+```
69
+# become user netdata
70
+sudo su -s /bin/bash netdata
71
+```
72
+Depending on where Netdata was installed, execute one of the following commands to trace the execution of a python module:
73
+
74
+```
75
+# execute the plugin in debug mode, for a specific module
76
+/opt/netdata/usr/libexec/netdata/plugins.d/python.d.plugin <module> debug trace
77
+/usr/libexec/netdata/plugins.d/python.d.plugin <module> debug trace
78
+```
79
+Where `[module]` is the directory name under https://github.com/netdata/netdata/tree/master/collectors/python.d.plugin
80
81
## How to write a new module
82