-
Notifications
You must be signed in to change notification settings - Fork 14
/
Copy pathprometheus-tor-exporter.py
executable file
·207 lines (189 loc) · 8.88 KB
/
prometheus-tor-exporter.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
#! /usr/bin/env python3
# Source: https://github.com/atx/prometheus-tor_exporter/blob/master/prometheus-tor-exporter.py
import argparse
import stem
import stem.control
import time
from retrying import retry
import prometheus_client as prom
from prometheus_client.core import GaugeMetricFamily, REGISTRY
class StemCollector:
def __init__(self, tor):
self.tor = tor
self.authenticate()
self.reconnect()
@retry(wait_random_min=1000, wait_random_max=2000, stop_max_attempt_number=5)
def authenticate(self):
self.tor.authenticate()
@retry(wait_random_min=1000, wait_random_max=2000, stop_max_attempt_number=5)
def reconnect(self):
self.tor.reconnect()
def collect(self):
self.reconnect()
yield GaugeMetricFamily(
"tor_written_bytes",
"Tor written data counter",
value=int(self.tor.get_info("traffic/written")))
yield GaugeMetricFamily(
"tor_read_bytes",
"Tor received data counter",
value=int(self.tor.get_info("traffic/read")))
version = GaugeMetricFamily("tor_version", "Tor version as a label",
labels=["version"])
version.add_metric([str(torctl.get_version())], 1)
yield version
version_status = GaugeMetricFamily(
"tor_version_status",
"Tor version status {new, old, unrecommended, recommended, new in series, obsolete, unknown} as a label",
labels=["version_status"])
version_status.add_metric([self.tor.get_info("status/version/current")], 1)
yield version_status
yield GaugeMetricFamily("tor_network_liveness",
"Indicates whether tor believes that the network is currently reachable",
value=int(self.tor.get_info("network-liveness") == "up"))
reachable = GaugeMetricFamily("tor_reachable",
"Indicates whether our OR/Dir port is reachable",
labels=["port"])
for entry in self.tor.get_info("status/reachability-succeeded").split():
k, v = entry.split("=")
reachable.add_metric([k], int(v))
yield reachable
yield GaugeMetricFamily("tor_circuit_established",
"Indicates whether Tor is capable of establishing circuits",
value=int(self.tor.get_info("status/circuit-established")))
# For some reason, 0 actually means that Tor is active, keep it that way
yield GaugeMetricFamily("tor_dormant",
"Indicates whether Tor is currently active and building circuits (note that 0 corresponds to Tor being active)",
value=int(self.tor.get_info("dormant")))
effective_rate = self.tor.get_effective_rate(None)
effective_burst_rate = self.tor.get_effective_rate(None, burst=True)
if effective_rate is not None and effective_burst_rate is not None:
yield GaugeMetricFamily("tor_effective_rate",
"Shows Tor effective rate",
value=int(effective_rate))
yield GaugeMetricFamily("tor_effective_burst_rate",
"Shows Tor effective burst rate",
value=int(effective_burst_rate))
try:
fingerprint_value = self.tor.get_info("fingerprint")
fingerprint = GaugeMetricFamily("tor_fingerprint",
"Tor fingerprint as a label",
labels=["fingerprint"])
fingerprint.add_metric([fingerprint_value], 1)
yield fingerprint
except (stem.ProtocolError, stem.OperationFailed):
# happens when not running in server mode
pass
nickname = GaugeMetricFamily("tor_nickname",
"Tor nickname as a label",
labels=["nickname"])
nickname.add_metric([self.tor.get_conf("Nickname", "Unnamed")], 1)
yield nickname
# Connection counting
# This won't work/will return wrong results if we are not running on
# the same box as the Tor daemon is.
# DisableDebuggerAttachment has to be set to 0
# TODO: Count individual OUT/DIR/Control connections, see arm sources
# for reference
try:
tor_pid = self.tor.get_pid()
connections = stem.util.connection.get_connections(
process_pid=tor_pid)
yield GaugeMetricFamily("tor_connection_count",
"Amount of connections the Tor daemon has open",
value=len(connections))
# Let's hope this does not break when there is NTP sync or
# something
uptime = time.time() - stem.util.system.start_time(tor_pid)
yield GaugeMetricFamily("tor_uptime",
"Tor daemon uptime",
value=uptime)
except (OSError, IOError):
# This happens if the PID does not exists (on another machine).
pass
try:
has_flags = self.tor.get_network_status().flags
except stem.DescriptorUnavailable:
# The tor daemon fails with this for a few minutes after startup
# (before figuring out its own flags?)
has_flags = []
except stem.ControllerError:
# Happens when the daemon is not running in server mode
has_flags = []
flags = GaugeMetricFamily("tor_flags", "Has a Tor flag", labels=["flag"])
for flag in ["Authority", "BadExit", "Exit", "Fast", "Guard", "HSDir",
"NoEdConsensus", "Stable", "Running", "Valid", "V2Dir"]:
flags.add_metric([flag], int(flag in has_flags))
yield flags
try:
accs = self.tor.get_accounting_stats()
yield GaugeMetricFamily("tor_accounting_read_bytes",
"Tor accounting read bytes",
accs.read_bytes)
yield GaugeMetricFamily("tor_accounting_left_read_bytes",
"Tor accounting read bytes left",
accs.read_bytes_left)
yield GaugeMetricFamily("tor_accounting_read_limit_bytes",
"Tor accounting read bytes limit",
accs.read_limit)
yield GaugeMetricFamily("tor_accounting_write_bytes",
"Tor accounting write bytes",
accs.written_bytes)
yield GaugeMetricFamily("tor_accounting_left_write_bytes",
"Tor accounting write bytes left",
accs.write_bytes_left)
yield GaugeMetricFamily("tor_accounting_write_limit_bytes",
"Tor accounting write bytes limit",
accs.write_limit)
except stem.ControllerError:
# happens when accounting isn't enabled
pass
if __name__ == "__main__":
parser = argparse.ArgumentParser()
parser.add_argument(
"-m", "--mode",
help="Tor socker control mode (tcp or unix, default tcp)",
default="tcp",
choices=['tcp', 'unix']
)
parser.add_argument(
"-a", "--address",
help="Tor control IP address",
default="127.0.0.1"
)
parser.add_argument(
"-c", "--control-port",
help="Tor control port",
type=int,
default=9051
)
parser.add_argument(
"-s", "--control-socket",
help="Tor control socket",
default="/var/run/tor/control"
)
parser.add_argument(
"-p", "--listen-port",
help="Listen on this port",
type=int,
default=9099
)
parser.add_argument(
"-b", "--bind-addr",
help="Bind this address",
default="localhost"
)
args = parser.parse_args()
if args.mode == 'unix':
torctl = stem.control.Controller.from_socket_file(args.control_socket)
else:
torctl = stem.control.Controller.from_port(args.address,
port=args.control_port)
coll = StemCollector(torctl)
REGISTRY.register(coll)
print("Starting on %s:%s" % (args.bind_addr, args.listen_port))
prom.start_http_server(args.listen_port, addr=args.bind_addr)
# We can't exit as start_http_server starts a daemon thread which would get
# killed.
while True:
time.sleep(1000)