From 8020f71afd34d7696d7933659df2d763ab05542f Mon Sep 17 00:00:00 2001
From: Daniel Baumann <daniel.baumann@progress-linux.org>
Date: Sat, 4 May 2024 16:31:17 +0200
Subject: Adding upstream version 1.37.1.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
---
 collectors/python.d.plugin/tor/README.md | 66 ++++++++++++++++++++++++++++++++
 1 file changed, 66 insertions(+)
 create mode 100644 collectors/python.d.plugin/tor/README.md

(limited to 'collectors/python.d.plugin/tor/README.md')

diff --git a/collectors/python.d.plugin/tor/README.md b/collectors/python.d.plugin/tor/README.md
new file mode 100644
index 0000000..b57d77c
--- /dev/null
+++ b/collectors/python.d.plugin/tor/README.md
@@ -0,0 +1,66 @@
+<!--
+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
+ password: <password> # if required
+
+local_socket:
+ name: 'local'
+ control_port: '/var/run/tor/control'
+ password: <password> # if required
+```
+
+### 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`.
+
+---
+
+
-- 
cgit v1.2.3