diff options
Diffstat (limited to 'collectors/python.d.plugin/tor/README.md')
| -rw-r--r-- | collectors/python.d.plugin/tor/README.md | 64 |
1 files changed, 64 insertions, 0 deletions
diff --git a/collectors/python.d.plugin/tor/README.md b/collectors/python.d.plugin/tor/README.md new file mode 100644 index 0000000..192a86a --- /dev/null +++ b/collectors/python.d.plugin/tor/README.md @@ -0,0 +1,64 @@ +<!-- +title: "Tor monitoring with Netdata" +custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/tor/README.md +sidebar_label: "Tor" +--> + +# Tor monitoring with Netdata + +Connects to the Tor control port to collect traffic statistics. + +## Requirements + +- `tor` program +- `stem` python package + +It produces only one chart: + +1. **Traffic** + + - read + - write + +## Configuration + +Edit the `python.d/tor.conf` configuration file using `edit-config` from the Netdata [config +directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`. + +```bash +cd /etc/netdata # Replace this path with your Netdata config directory, if different +sudo ./edit-config python.d/tor.conf +``` + +Needs only `control_port`. + +Here is an example for local server: + +```yaml +update_every : 1 +priority : 60000 + +local_tcp: + name: 'local' + control_port: 9051 + +local_socket: + name: 'local' + control_port: '/var/run/tor/control' +``` + +### prerequisite + +Add to `/etc/tor/torrc`: + +``` +ControlPort 9051 +``` + +For more options please read the manual. + +Without configuration, module attempts to connect to `127.0.0.1:9051`. + +--- + +[](<>) |