|
| 1 | +"""Recording helpers for Prometheus metrics. |
| 2 | +
|
| 3 | +This module keeps metric definitions in ``metrics.__init__`` while providing a |
| 4 | +small facade for application code. New metrics should add a recording helper |
| 5 | +here so callers do not need to know Prometheus object details. |
| 6 | +""" |
| 7 | + |
| 8 | +from collections.abc import Iterator |
| 9 | +from contextlib import contextmanager |
| 10 | + |
| 11 | +import metrics |
| 12 | +from log import get_logger |
| 13 | + |
| 14 | +logger = get_logger(__name__) |
| 15 | + |
| 16 | + |
| 17 | +@contextmanager |
| 18 | +def measure_response_duration(path: str) -> Iterator[None]: |
| 19 | + """Measure REST API response duration for a route path. |
| 20 | +
|
| 21 | + Args: |
| 22 | + path: Normalized route path used as the metric label. |
| 23 | + """ |
| 24 | + with metrics.response_duration_seconds.labels(path).time(): |
| 25 | + yield |
| 26 | + |
| 27 | + |
| 28 | +def record_rest_api_call(path: str, status_code: int) -> None: |
| 29 | + """Record one REST API request. |
| 30 | +
|
| 31 | + Args: |
| 32 | + path: Normalized route path used as the metric label. |
| 33 | + status_code: HTTP response status code returned by the endpoint. |
| 34 | + """ |
| 35 | + metrics.rest_api_calls_total.labels(path, status_code).inc() |
| 36 | + |
| 37 | + |
| 38 | +def record_llm_call(provider: str, model: str) -> None: |
| 39 | + """Record one LLM call for a provider and model. |
| 40 | +
|
| 41 | + Args: |
| 42 | + provider: LLM provider identifier. |
| 43 | + model: LLM model identifier without the provider prefix. |
| 44 | + """ |
| 45 | + try: |
| 46 | + metrics.llm_calls_total.labels(provider, model).inc() |
| 47 | + except (AttributeError, TypeError, ValueError): |
| 48 | + logger.warning("Failed to update LLM call metric", exc_info=True) |
| 49 | + |
| 50 | + |
| 51 | +def record_llm_failure(provider: str, model: str) -> None: |
| 52 | + """Record one failed LLM call for a provider and model. |
| 53 | +
|
| 54 | + Args: |
| 55 | + provider: LLM provider identifier. |
| 56 | + model: LLM model identifier without the provider prefix. |
| 57 | + """ |
| 58 | + try: |
| 59 | + metrics.llm_calls_failures_total.labels(provider, model).inc() |
| 60 | + except (AttributeError, TypeError, ValueError): |
| 61 | + logger.warning("Failed to update LLM failure metric", exc_info=True) |
| 62 | + |
| 63 | + |
| 64 | +def record_llm_validation_error() -> None: |
| 65 | + """Record one LLM validation error, such as a shield violation.""" |
| 66 | + try: |
| 67 | + metrics.llm_calls_validation_errors_total.inc() |
| 68 | + except (AttributeError, TypeError, ValueError): |
| 69 | + logger.warning("Failed to update LLM validation error metric", exc_info=True) |
| 70 | + |
| 71 | + |
| 72 | +def record_llm_token_usage( |
| 73 | + provider: str, |
| 74 | + model: str, |
| 75 | + input_tokens: int, |
| 76 | + output_tokens: int, |
| 77 | +) -> None: |
| 78 | + """Record LLM token usage for a provider and model. |
| 79 | +
|
| 80 | + Args: |
| 81 | + provider: LLM provider identifier. |
| 82 | + model: LLM model identifier without the provider prefix. |
| 83 | + input_tokens: Number of tokens sent to the LLM. |
| 84 | + output_tokens: Number of tokens received from the LLM. |
| 85 | + """ |
| 86 | + try: |
| 87 | + metrics.llm_token_sent_total.labels(provider, model).inc(input_tokens) |
| 88 | + metrics.llm_token_received_total.labels(provider, model).inc(output_tokens) |
| 89 | + except (AttributeError, TypeError, ValueError): |
| 90 | + logger.warning("Failed to update token metrics", exc_info=True) |
0 commit comments