@cryptotaxi247 / netdata-1
Code Commits Issues Pulls Sessions CI/CD
master
master
yaml 141 lines 4.35 KB
Raw
1 plugin_name: go.d.plugin
2 modules:
3 - meta:
4 id: collector-go.d.plugin-tor
5 plugin_name: go.d.plugin
6 module_name: tor
7 monitored_instance:
8 name: Tor
9 link: https://www.torproject.org/
10 categories:
11 - data-collection.networking
12 icon_filename: "tor.svg"
13 related_resources:
14 integrations:
15 list: []
16 info_provided_to_referring_integrations:
17 description: ""
18 keywords:
19 - tor
20 - traffic
21 - vpn
22 overview:
23 data_collection:
24 metrics_description: |
25 Tracks Tor's download and upload traffic, as well as its uptime.
26 method_description: |
27 It reads the server's response to the [GETINFO](https://spec.torproject.org/control-spec/commands.html#getinfo) command.
28 supported_platforms:
29 include: []
30 exclude: []
31 multi_instance: true
32 additional_permissions:
33 description: ""
34 default_behavior:
35 auto_detection:
36 description: |
37 By default, it detects Tor instances running on localhost that are listening on port 9051.
38 On startup, it tries to collect metrics from:
39
40 - 127.0.0.1:9051
41 limits:
42 description: ""
43 performance_impact:
44 description: ""
45 setup:
46 prerequisites:
47 list:
48 - title: Enable Control Port
49 description: |
50 Enable `ControlPort` in `/etc/tor/torrc`.
51 configuration:
52 file:
53 name: go.d/tor.conf
54 options:
55 description: |
56 The following options can be defined globally: update_every, autodetection_retry.
57 folding:
58 title: Config options
59 enabled: true
60 list:
61 - name: update_every
62 description: Data collection frequency.
63 default_value: 1
64 required: false
65 group: Collection
66 - name: autodetection_retry
67 description: Recheck interval in seconds. Zero means no recheck will be scheduled.
68 default_value: 0
69 required: false
70 group: Collection
71
72 - name: address
73 description: The IP address and port where the Tor Control Port listens for connections.
74 default_value: 127.0.0.1:9051
75 required: true
76 group: Target
77 - name: timeout
78 description: Connection, read, and write timeout duration in seconds. The timeout includes name resolution.
79 default_value: 1
80 required: false
81 group: Target
82
83 - name: password
84 description: Password for authentication.
85 default_value: ""
86 required: false
87 group: Auth
88 examples:
89 folding:
90 title: Config
91 enabled: true
92 list:
93 - name: Basic
94 description: A basic example configuration.
95 config: |
96 jobs:
97 - name: local
98 address: 127.0.0.1:9051
99 password: somePassword
100 - name: Multi-instance
101 description: |
102 > **Note**: When you define multiple jobs, their names must be unique.
103
104 Collecting metrics from local and remote instances.
105 config: |
106 jobs:
107 - name: local
108 address: 127.0.0.1:9051
109 password: somePassword
110
111 - name: remote
112 address: 203.0.113.0:9051
113 password: somePassword
114 troubleshooting:
115 problems:
116 list: []
117 alerts: []
118 metrics:
119 folding:
120 title: Metrics
121 enabled: false
122 description: ""
123 availability: []
124 scopes:
125 - name: global
126 description: "These metrics refer to the entire monitored application."
127 labels: []
128 metrics:
129 - name: tor.traffic
130 description: Tor Traffic
131 unit: "KiB/s"
132 chart_type: area
133 dimensions:
134 - name: read
135 - name: write
136 - name: tor.uptime
137 description: Tor Uptime
138 unit: "seconds"
139 chart_type: line
140 dimensions:
141 - name: uptime