Move monitor.py to common/monitor.py

module_build_service/common/messaging.py

@@ -25,7 +25,7 @@ def publish(topic, msg, conf, service):
             "No messaging backend found for %r in %r" % (conf.messaging, _messaging_backends.keys())
         )
 
-    from module_build_service.monitor import (
+    from module_build_service.common.monitor import (
         messaging_tx_to_send_counter,
         messaging_tx_sent_ok_counter,
         messaging_tx_failed_counter,

module_build_service/common/monitor.py

@@ -0,0 +1,102 @@
+# -*- coding: utf-8 -*-
+# SPDX-License-Identifier: MIT
+
+# For an up-to-date version of this module, see:
+#   https://pagure.io/monitor-flask-sqlalchemy
+
+import os
+import tempfile
+
+from prometheus_client import (  # noqa: F401
+    ProcessCollector,
+    CollectorRegistry,
+    Counter,
+    multiprocess,
+    Histogram,
+    start_http_server,
+)
+from sqlalchemy import event
+
+
+if not os.environ.get("prometheus_multiproc_dir"):
+    os.environ.setdefault("prometheus_multiproc_dir", tempfile.mkdtemp())
+registry = CollectorRegistry()
+ProcessCollector(registry=registry)
+multiprocess.MultiProcessCollector(registry)
+if os.getenv("MONITOR_STANDALONE_METRICS_SERVER_ENABLE", "false") == "true":
+    port = os.getenv("MONITOR_STANDALONE_METRICS_SERVER_PORT", "10040")
+    start_http_server(int(port), registry=registry)
+
+
+# Generic metrics
+messaging_rx_counter = Counter(
+    "messaging_rx", "Total number of messages received", registry=registry
+)
+messaging_rx_processed_ok_counter = Counter(
+    "messaging_rx_processed_ok",
+    "Number of received messages, which were processed successfully",
+    registry=registry,
+)
+messaging_rx_failed_counter = Counter(
+    "messaging_rx_failed",
+    "Number of received messages, which failed during processing",
+    registry=registry,
+)
+
+messaging_tx_to_send_counter = Counter(
+    "messaging_tx_to_send", "Total number of messages to send", registry=registry
+)
+messaging_tx_sent_ok_counter = Counter(
+    "messaging_tx_sent_ok", "Number of messages, which were sent successfully", registry=registry
+)
+messaging_tx_failed_counter = Counter(
+    "messaging_tx_failed", "Number of messages, for which the sender failed", registry=registry
+)
+
+builder_success_counter = Counter(
+    "builds_success", "Number of successful builds", registry=registry
+)
+builder_failed_counter = Counter(
+    "builds_failed_total",
+    "Number of failed builds",
+    labelnames=["reason"],  # reason could be: 'user', 'infra', 'unspec'
+    registry=registry,
+)
+
+db_dbapi_error_counter = Counter("db_dbapi_error", "Number of DBAPI errors", registry=registry)
+db_engine_connect_counter = Counter(
+    "db_engine_connect", "Number of 'engine_connect' events", registry=registry
+)
+db_handle_error_counter = Counter(
+    "db_handle_error", "Number of exceptions during connection", registry=registry
+)
+db_transaction_rollback_counter = Counter(
+    "db_transaction_rollback", "Number of transactions, which were rolled back", registry=registry
+)
+
+# Service-specific metrics
+# XXX: TODO
+
+
+def db_hook_event_listeners(target=None):
+    # Service-specific import of db
+    from module_build_service import db
+
+    if not target:
+        target = db.engine
+
+    @event.listens_for(target, "dbapi_error", named=True)
+    def receive_dbapi_error(**kw):
+        db_dbapi_error_counter.inc()
+
+    @event.listens_for(target, "engine_connect")
+    def receive_engine_connect(conn, branch):
+        db_engine_connect_counter.inc()
+
+    @event.listens_for(target, "handle_error")
+    def receive_handle_error(exception_context):
+        db_handle_error_counter.inc()
+
+    @event.listens_for(target, "rollback")
+    def receive_rollback(conn):
+        db_transaction_rollback_counter.inc()