Add counter and timer for action execution (fixes #23)

Author: leplatrem

README.md

@@ -218,3 +218,15 @@ GET /whiteboard_tags/
     ...
 }
 ```
+
+## Metrics
+
+The following metrics are sent via Prometheus:
+
+- `jbi_bugzilla_ignored_total`
+- `jbi_bugzilla_processed_total`
+- `jbi_action_execution_milliseconds`
+- `jbi_jira_methods_milliseconds`
+- `jbi_jira_methods_total`
+- `jbi_bugzilla_methods_total`
+- `jbi_bugzilla_methods_milliseconds`

src/jbi/runner.py

@@ -3,13 +3,23 @@
 """
 import logging
 
+from prometheus_client import Counter, Summary
+
 from src.app.environment import Settings
 from src.jbi.bugzilla import BugzillaBug, BugzillaWebhookRequest
 from src.jbi.errors import ActionNotFoundError, IgnoreInvalidRequestError
 from src.jbi.models import Actions
 
 logger = logging.getLogger(__name__)
 
+counter_ignored = Counter("jbi_bugzilla_ignored_total", "Bugzilla WebHooks ignored")
+counter_processed = Counter(
+    "jbi_bugzilla_processed_total", "Bugzilla WebHooks processed"
+)
+action_execution_timer = Summary(
+    "jbi_action_execution_milliseconds", "Action execution duration"
+)
+
 
 class Operations:
     """Track status of incoming requests in log entries."""
@@ -20,6 +30,7 @@ class Operations:
     SUCCESS = "success"
 
 
+@action_execution_timer.time()
 def execute_action(
     request: BugzillaWebhookRequest,
     actions: Actions,
@@ -85,11 +96,13 @@ def execute_action(
             bug_obj.id,
             extra={"operation": Operations.SUCCESS, **log_context},
         )
+        counter_processed.inc()
         return content
     except IgnoreInvalidRequestError as exception:
         logger.debug(
             "Ignore incoming request: %s",
             exception,
             extra={"operation": Operations.IGNORE, **log_context},
         )
+        counter_ignored.inc()
         raise

tests/unit/jbi/test_runner.py

@@ -130,3 +130,35 @@ def test_execution_logging_for_ignored_requests(
         "Handling incoming request",
         "Ignore incoming request: no action matching bug whiteboard tags: foo",
     ]
+
+
+def test_counter_is_incremented_on_ignored_requests(
+    webhook_create_example: BugzillaWebhookRequest,
+    actions_example: Actions,
+    settings: Settings,
+):
+    assert webhook_create_example.bug
+    webhook_create_example.bug.whiteboard = "foo"
+
+    with mock.patch("src.jbi.runner.counter_ignored") as mocked:
+        with pytest.raises(IgnoreInvalidRequestError):
+            execute_action(
+                request=webhook_create_example,
+                actions=actions_example,
+                settings=settings,
+            )
+    assert mocked.inc.called, "ignored counter was called"
+
+
+def test_counter_is_incremented_on_processed_requests(
+    webhook_create_example: BugzillaWebhookRequest,
+    actions_example: Actions,
+    settings: Settings,
+):
+    with mock.patch("src.jbi.runner.counter_processed") as mocked:
+        execute_action(
+            request=webhook_create_example,
+            actions=actions_example,
+            settings=settings,
+        )
+    assert mocked.inc.called, "processed counter was called"