Skip to content

ccproxy.plugins.metrics.tasks

ccproxy.plugins.metrics.tasks

Scheduled tasks for the metrics plugin.

PushgatewayTask 

PushgatewayTask(
    name,
    interval_seconds,
    enabled=True,
    max_backoff_seconds=300.0,
    metrics_config=None,
    metrics_hook=None,
)

Bases: BaseScheduledTask

Task for pushing metrics to Pushgateway periodically.

Parameters:

Name Type Description Default
name str

Task name

 required
interval_seconds float

Interval between pushgateway operations

 required
enabled bool

Whether task is enabled

 True
max_backoff_seconds float

Maximum backoff delay for failures

 300.0
metrics_config Any | None

Metrics plugin configuration

 None
metrics_hook Any | None

Metrics hook instance for getting collector

 None
Source code in ccproxy/plugins/metrics/tasks.py 
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
def __init__(
    self,
    name: str,
    interval_seconds: float,
    enabled: bool = True,
    max_backoff_seconds: float = 300.0,
    metrics_config: Any | None = None,
    metrics_hook: Any | None = None,
):
    """
    Initialize pushgateway task.

    Args:
        name: Task name
        interval_seconds: Interval between pushgateway operations
        enabled: Whether task is enabled
        max_backoff_seconds: Maximum backoff delay for failures
        metrics_config: Metrics plugin configuration
        metrics_hook: Metrics hook instance for getting collector
    """
    super().__init__(
        name=name,
        interval_seconds=interval_seconds,
        enabled=enabled,
        max_backoff_seconds=max_backoff_seconds,
    )
    self._metrics_config = metrics_config
    self._metrics_hook = metrics_hook
    self._pushgateway_client: PushgatewayClient | None = None

setup async 

setup()

Initialize pushgateway client for operations.

Source code in ccproxy/plugins/metrics/tasks.py 
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
async def setup(self) -> None:
    """Initialize pushgateway client for operations."""
    try:
        if self._metrics_config and self._metrics_hook:
            self._pushgateway_client = PushgatewayClient(self._metrics_config)
            logger.debug(
                "pushgateway_task_setup_complete",
                task_name=self.name,
                url=self._metrics_config.pushgateway_url,
                job=self._metrics_config.pushgateway_job,
            )
        else:
            logger.warning(
                "pushgateway_task_setup_missing_config",
                task_name=self.name,
                has_config=self._metrics_config is not None,
                has_hook=self._metrics_hook is not None,
            )
    except Exception as e:
        logger.error(
            "pushgateway_task_setup_failed",
            task_name=self.name,
            error=str(e),
            error_type=type(e).__name__,
            exc_info=e,
        )
        raise

run async 

run()

Execute pushgateway metrics push.

Source code in ccproxy/plugins/metrics/tasks.py 
 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
async def run(self) -> bool:
    """Execute pushgateway metrics push."""
    try:
        if not self._pushgateway_client or not self._metrics_hook:
            logger.warning(
                "pushgateway_no_client_or_hook",
                task_name=self.name,
                has_client=self._pushgateway_client is not None,
                has_hook=self._metrics_hook is not None,
            )
            return False

        if not self._pushgateway_client.is_enabled():
            logger.debug("pushgateway_disabled", task_name=self.name)
            return True  # Not an error, just disabled

        # Get the metrics collector and push metrics
        collector = self._metrics_hook.get_collector()
        if not collector:
            logger.warning("pushgateway_no_collector", task_name=self.name)
            return False

        # Push metrics using the client
        success = self._pushgateway_client.push_metrics(
            collector.get_registry(), method="push"
        )

        if success:
            logger.debug("pushgateway_push_success", task_name=self.name)
        else:
            logger.warning("pushgateway_push_failed", task_name=self.name)

        return success

    except Exception as e:
        logger.error(
            "pushgateway_task_error",
            task_name=self.name,
            error=str(e),
            error_type=type(e).__name__,
            exc_info=e,
        )
        return False