class documentation

class PrometheusConfig: (source)

View In Hierarchy

Configuration for Prometheus metrics endpoint.

Starts an HTTP server on the given address that exposes a /metrics endpoint for Prometheus scraping.

Instance Variable bind_address Address to bind the metrics HTTP server to (e.g. "0.0.0.0:9000" or "127.0.0.1:9090"). Prometheus will scrape http://<bind_address>/metrics.
Instance Variable counters_total_suffix If True, append _total suffix to counter metric names, following the OpenMetrics convention. Defaults to False.
Instance Variable durations_as_seconds If True, report duration metrics as floating-point seconds instead of integer milliseconds. Defaults to False.
Instance Variable histogram_bucket_overrides Override the default histogram bucket boundaries for specific metrics. Keys are metric names and values are sequences of bucket boundaries (e.g. {"workflow_task_schedule_to_start_latency": [0.01, 0.05, 0.1, 0.5, 1.0, 5.0]}...
Instance Variable unit_suffix If True, append unit suffixes (e.g. _seconds, _bytes) to metric names. Defaults to False.
Method _to_bridge_config Undocumented
bind_address: str = (source)

Address to bind the metrics HTTP server to (e.g. "0.0.0.0:9000" or "127.0.0.1:9090"). Prometheus will scrape http://<bind_address>/metrics.

counters_total_suffix: bool = (source)

If True, append _total suffix to counter metric names, following the OpenMetrics convention. Defaults to False.

durations_as_seconds: bool = (source)

If True, report duration metrics as floating-point seconds instead of integer milliseconds. Defaults to False.

histogram_bucket_overrides: Mapping[str, Sequence[float]] | None = (source)

Override the default histogram bucket boundaries for specific metrics. Keys are metric names and values are sequences of bucket boundaries (e.g. {"workflow_task_schedule_to_start_latency": [0.01, 0.05, 0.1, 0.5, 1.0, 5.0]}).

unit_suffix: bool = (source)

If True, append unit suffixes (e.g. _seconds, _bytes) to metric names. Defaults to False.

Undocumented