-
Notifications
You must be signed in to change notification settings - Fork 129
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[client] add init of prometheus and OpenCTIMetricHandler (#455)
- Loading branch information
Showing
8 changed files
with
158 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| import logging | ||
| from typing import Type, Union | ||
|
|
||
| from prometheus_client import Counter, Enum, start_http_server | ||
|
|
||
|
|
||
| class OpenCTIMetricHandler: | ||
| def __init__(self, activated: bool = False, port: int = 9095): | ||
| """ | ||
| Init of OpenCTIMetricHandler class. | ||
| Parameters | ||
| ---------- | ||
| activated : bool, default False | ||
| If True use metrics in client and connectors. | ||
| port : int, default 9095 | ||
| Port for prometheus server. | ||
| """ | ||
| self.activated = activated | ||
|
|
||
| if self.activated: | ||
| logging.info(f"Exposing metrics on port {port}") | ||
| start_http_server(port) | ||
|
|
||
| self._metrics = { | ||
| "bundle_send": Counter( | ||
| "bundle_send", | ||
| "Number of bundle send", | ||
| ), | ||
| "record_send": Counter( | ||
| "record_send", | ||
| "Number of record (objects per bundle) send", | ||
| ), | ||
| "run_count": Counter( | ||
| "run_count", | ||
| "Number of run", | ||
| ), | ||
| "ping_api_count": Counter( | ||
| "ping_api_count", | ||
| "Number of ping to the api", | ||
| ), | ||
| "ping_api_error": Counter( | ||
| "ping_api_error", | ||
| "Number of error when pinging the api", | ||
| ), | ||
| "error_count": Counter( | ||
| "error_count", | ||
| "Number of error", | ||
| ), | ||
| "client_error_count": Counter( | ||
| "client_error_count", | ||
| "Number of client error", | ||
| ), | ||
| "state": Enum( | ||
| "state", "State of connector", states=["idle", "running", "stopped"] | ||
| ), | ||
| } | ||
|
|
||
| def _metric_exists( | ||
| self, name: str, expected_type: Union[Type[Counter], Type[Enum]] | ||
| ) -> bool: | ||
| """ | ||
| Check if a metric exists and has the correct type. | ||
| If it does not, log an error and return False. | ||
| Parameters | ||
| ---------- | ||
| name : str | ||
| Name of the metric to check. | ||
| expected_type : Counter or Enum | ||
| Expected type of the metric. | ||
| Returns | ||
| ------- | ||
| bool | ||
| True if the metric exists and is of the correct type else False. | ||
| """ | ||
| if name not in self._metrics: | ||
| logging.error(f"Metric {name} does not exist.") | ||
| return False | ||
| if not isinstance(self._metrics[name], expected_type): | ||
| logging.error(f"Metric {name} is not of expected type {expected_type}.") | ||
| return False | ||
| return True | ||
|
|
||
| def inc(self, name: str, n: int = 1): | ||
| """ | ||
| Increment the metric (counter) `name` by `n`. | ||
| Parameters | ||
| ---------- | ||
| name : str | ||
| Name of the metric to increment. | ||
| n : int, default 1 | ||
| Increment the counter by `n`. | ||
| """ | ||
| if self.activated: | ||
| if self._metric_exists(name, Counter): | ||
| self._metrics[name].inc(n) | ||
|
|
||
| def state(self, state: str, name: str = "state"): | ||
| """ | ||
| Set the state `state` for metric `name`. | ||
| Parameters | ||
| ---------- | ||
| state : str | ||
| State to set. | ||
| name : str, default = "state" | ||
| Name of the metric to set. | ||
| """ | ||
| if self.activated: | ||
| if self._metric_exists(name, Enum): | ||
| self._metrics[name].state(state) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| from unittest import TestCase | ||
|
|
||
| from prometheus_client import Counter, Enum | ||
|
|
||
| from pycti import OpenCTIMetricHandler | ||
|
|
||
|
|
||
| class TestOpenCTIMetricHandler(TestCase): | ||
| def test_metric_exists(self): | ||
| metric = OpenCTIMetricHandler(activated=True) | ||
| self.assertTrue(metric._metric_exists("error_count", Counter)) | ||
| self.assertFalse(metric._metric_exists("error_count", Enum)) | ||
| self.assertFalse(metric._metric_exists("best_metric_count", Counter)) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters