-
Notifications
You must be signed in to change notification settings - Fork 81
/
exporter.py
341 lines (292 loc) · 12.9 KB
/
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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
# pylint: disable=protected-access,,attribute-defined-outside-init
import json
import re
import sys
import time
from celery import Celery
from celery.events.state import State # type: ignore
from celery.utils import nodesplit # type: ignore
from kombu.exceptions import ChannelError # type: ignore
from loguru import logger
from prometheus_client import CollectorRegistry, Counter, Gauge, Histogram
from .http_server import start_http_server
class Exporter: # pylint: disable=too-many-instance-attributes,too-many-branches
state: State = None
def __init__(self, buckets=None):
self.registry = CollectorRegistry(auto_describe=True)
self.queue_cache = set()
self.state_counters = {
"task-sent": Counter(
"celery_task_sent",
"Sent when a task message is published.",
["name", "hostname", "queue_name"],
registry=self.registry,
),
"task-received": Counter(
"celery_task_received",
"Sent when the worker receives a task.",
["name", "hostname", "queue_name"],
registry=self.registry,
),
"task-started": Counter(
"celery_task_started",
"Sent just before the worker executes the task.",
["name", "hostname", "queue_name"],
registry=self.registry,
),
"task-succeeded": Counter(
"celery_task_succeeded",
"Sent if the task executed successfully.",
["name", "hostname", "queue_name"],
registry=self.registry,
),
"task-failed": Counter(
"celery_task_failed",
"Sent if the execution of the task failed.",
["name", "hostname", "exception", "queue_name"],
registry=self.registry,
),
"task-rejected": Counter(
"celery_task_rejected",
# pylint: disable=line-too-long
"The task was rejected by the worker, possibly to be re-queued or moved to a dead letter queue.",
["name", "hostname", "queue_name"],
registry=self.registry,
),
"task-revoked": Counter(
"celery_task_revoked",
"Sent if the task has been revoked.",
["name", "hostname", "queue_name"],
registry=self.registry,
),
"task-retried": Counter(
"celery_task_retried",
"Sent if the task failed, but will be retried in the future.",
["name", "hostname", "queue_name"],
registry=self.registry,
),
}
self.celery_worker_up = Gauge(
"celery_worker_up",
"Indicates if a worker has recently sent a heartbeat.",
["hostname"],
registry=self.registry,
)
self.worker_tasks_active = Gauge(
"celery_worker_tasks_active",
"The number of tasks the worker is currently processing",
["hostname"],
registry=self.registry,
)
self.celery_task_runtime = Histogram(
"celery_task_runtime",
"Histogram of task runtime measurements.",
["name", "hostname", "queue_name"],
registry=self.registry,
buckets=buckets or Histogram.DEFAULT_BUCKETS,
)
self.celery_queue_length = Gauge(
"celery_queue_length",
"The number of message in broker queue.",
["queue_name"],
registry=self.registry,
)
self.celery_active_consumer_count = Gauge(
"celery_active_consumer_count",
"The number of active consumer in broker queue.",
["queue_name"],
registry=self.registry,
)
def track_queue_metrics(self):
with self.app.connection() as connection: # type: ignore
transport = connection.info()["transport"]
acceptable_transports = ["redis", "rediss", "amqp", "memory"]
if transport not in acceptable_transports:
logger.debug(
f"Queue length tracking is only implemented for {acceptable_transports}"
)
return
# request workers to response active queues
# we need to cache queue info in exporter in case all workers are offline
# so that no worker response to exporter will make active_queues return None
queues = self.app.control.inspect().active_queues() or {}
for info_list in queues.values():
for queue_info in info_list:
self.queue_cache.add(queue_info["name"])
track_length = lambda q, l: self.celery_queue_length.labels(
queue_name=q
).set(l)
for queue in self.queue_cache:
if transport in ["redis", "rediss"]:
queue_length = redis_queue_length(connection, queue)
track_length(queue, queue_length)
elif transport in ["amqp", "memory"]:
queue_length = rabbitmq_queue_length(connection, queue)
track_length(queue, queue_length)
consumer_count = rabbitmq_queue_consumer_count(connection, queue)
self.celery_active_consumer_count.labels(queue_name=queue).set(
consumer_count
)
def track_task_event(self, event):
self.state.event(event)
task = self.state.tasks.get(event["uuid"])
logger.debug("Received event='{}' for task='{}'", event["type"], task.name)
if event["type"] not in self.state_counters:
logger.warning("No counter matches task state='{}'", task.state)
labels = {
"name": task.name,
"hostname": get_hostname(task.hostname),
"queue_name": getattr(task, "queue", "celery"),
}
for counter_name, counter in self.state_counters.items():
_labels = labels.copy()
if counter_name == "task-failed":
if counter_name == event["type"]:
_labels["exception"] = get_exception_class_name(task.exception)
else:
_labels["exception"] = ""
if counter_name == event["type"]:
counter.labels(**_labels).inc()
else:
# increase unaffected counters by zero in order to make them visible
counter.labels(**_labels).inc(0)
logger.debug("Incremented metric='{}' labels='{}'", counter._name, labels)
# observe task runtime
if event["type"] == "task-succeeded":
self.celery_task_runtime.labels(**labels).observe(task.runtime)
logger.debug(
"Observed metric='{}' labels='{}': {}s",
self.celery_task_runtime._name,
labels,
task.runtime,
)
def track_worker_status(self, event, is_online):
value = 1 if is_online else 0
event_name = "worker-online" if is_online else "worker-offline"
hostname = get_hostname(event["hostname"])
logger.debug("Received event='{}' for hostname='{}'", event_name, hostname)
self.celery_worker_up.labels(hostname=hostname).set(value)
def track_worker_heartbeat(self, event):
hostname = get_hostname(event["hostname"])
logger.debug("Received event='{}' for worker='{}'", event["type"], hostname)
worker_state = self.state.event(event)[0][0]
active = worker_state.active or 0
up = 1 if worker_state.alive else 0
self.celery_worker_up.labels(hostname=hostname).set(up)
self.worker_tasks_active.labels(hostname=hostname).set(active)
logger.debug(
"Updated gauge='{}' value='{}'", self.worker_tasks_active._name, active
)
logger.debug("Updated gauge='{}' value='{}'", self.celery_worker_up._name, up)
def run(self, click_params):
logger.remove()
logger.add(sys.stdout, level=click_params["log_level"])
self.app = Celery(broker=click_params["broker_url"])
if click_params["accept_content"] is not None:
accept_content_list = click_params["accept_content"].split(",")
logger.info("Setting celery accept_content {}", accept_content_list)
self.app.config_from_object(dict(accept_content=accept_content_list))
transport_options = {}
for transport_option in click_params["broker_transport_option"]:
if transport_option is not None:
option, value = transport_option.split("=", 1)
if option is not None:
logger.debug(
"Setting celery broker_transport_option {}={}", option, value
)
transport_options[option] = transform_option_value(value)
if transport_options is not None:
self.app.conf["broker_transport_options"] = transport_options
ssl_options = {}
for ssl_option in click_params["broker_ssl_option"]:
if ssl_option is not None:
option, value = ssl_option.split("=", 1)
if option is not None:
logger.debug("Setting celery ssl_option {}={}", option, value)
if value.isnumeric():
ssl_options[option] = int(value)
else:
ssl_options[option] = value
if ssl_options is not None:
self.app.conf["broker_use_ssl"] = ssl_options
self.state = self.app.events.State() # type: ignore
self.retry_interval = click_params["retry_interval"]
if self.retry_interval:
logger.debug("Using retry_interval of {} seconds", self.retry_interval)
handlers = {
"worker-heartbeat": self.track_worker_heartbeat,
"worker-online": lambda event: self.track_worker_status(event, True),
"worker-offline": lambda event: self.track_worker_status(event, False),
}
for key in self.state_counters:
handlers[key] = self.track_task_event
with self.app.connection() as connection: # type: ignore
start_http_server(
self.registry,
connection,
click_params["port"],
self.track_queue_metrics,
)
while True:
try:
recv = self.app.events.Receiver(connection, handlers=handlers) # type: ignore
recv.capture(limit=None, timeout=None, wakeup=True) # type: ignore
except (KeyboardInterrupt, SystemExit) as ex:
raise ex
except Exception as e: # pylint: disable=broad-except
logger.exception(
"celery-exporter exception '{}', retrying in {} seconds.",
str(e),
self.retry_interval,
)
if self.retry_interval == 0:
raise e
time.sleep(self.retry_interval)
exception_pattern = re.compile(r"^(\w+)\(")
def get_exception_class_name(exception_name: str):
m = exception_pattern.match(exception_name)
if m:
return m.group(1)
return "UnknownException"
def get_hostname(name: str) -> str:
"""
Get hostname from celery's hostname.
Celery's hostname contains either worker's name or Process ID in it.
>>> get_hostname("workername@hostname")
'hostname'
>>> get_hostname("gen531@hostname")
'hostname'
Prometheus suggests it:
> Do not use labels to store dimensions with high cardinality (many different label values)
"""
_, hostname = nodesplit(name)
return hostname
def transform_option_value(value: str):
"""
Make an attempt to transform option value to appropriate type
Result type:
- int - if input contains only digits
- dict - if input may be correctly decoded from JSON string
- str - in any other cases
"""
if value.isnumeric():
return int(value)
try:
return json.loads(value)
except ValueError:
return value
def redis_queue_length(connection, queue: str) -> int:
return connection.default_channel.client.llen(queue)
def rabbitmq_queue_length(connection, queue: str) -> int:
return rabbitmq_queue_info(connection, queue).message_count
def rabbitmq_queue_consumer_count(connection, queue: str) -> int:
return rabbitmq_queue_info(connection, queue).consumer_count
def rabbitmq_queue_info(connection, queue: str):
try:
queue_info = connection.default_channel.queue_declare(queue=queue, passive=True)
return queue_info
except ChannelError as ex:
if "NOT_FOUND" in ex.message:
logger.debug(f"Queue '{queue}' not found")
return 0
raise ex