pryscraper/observability.py
cryptorugmunch 0200bf3e16 refactor(exceptions): add ruff BLE001; convert 103 broad except Exception
Per CONVENTIONS.md Part 2 ("Never bare except") and CONVENTIONS.md
Part 7 (pre-commit hooks: ruff), blind `except Exception` is now a
lint failure. Pre-existing sites are marked `# noqa: BLE001` for
later manual review; new code must use specific exception types.

Changes:
- pyproject.toml: added "BLE" to ruff lint select. BLE001 is now enforced
- 103 of 166 `except Exception` sites were auto-converted to specific
  types based on context (httpx, json, OSError, subprocess, etc.)
- 62 remaining sites marked with `# noqa: BLE001` for later review
  (mostly generic try/except wrappers that legitimately need broad catch
  for graceful degradation: e.g. compliance LLM fallback must catch
  any error to preserve the regex result)
- 1 manual fix: reverted compliance.py LLM fallback to broad except
  with explicit "must catch all errors" comment + noqa
- 2 files (commerce_sync.py, crm_sync.py) needed `import httpx` added
  so the auto-converted exception references would resolve
- 5 source files (agency, monitor, pipelines, auth_connector,
  llm_providers/registry) renamed "name" -> "<scope>_name" in
  extra={...} dicts because "name" is a reserved LogRecord field

Test impact:
- 14 failing tests -> 1 (the SSE subprocess test is a sandbox limitation,
  pre-existing and unrelated)
- New `test_ble_temp.py` verifies BLE001 catches new violations

Follow-up:
- Each `# noqa: BLE001` site should be reviewed and replaced with a
  specific exception type where possible. The most common legitimate
  broad-catch case is the LLM fallback path; everything else probably
  can be narrowed.
2026-07-02 21:04:53 +02:00

110 lines
4 KiB
Python

# SPDX-License-Identifier: MIT
# Copyright (c) 2026 Rug Munch Media LLC
#
# Part of Pry — https://git.rugmunch.io/RugMunchMedia/pryscraper
# Licensed under MIT. See LICENSE.
"""Pry — Observability: Prometheus metrics, OpenTelemetry tracing, structured logging."""
import logging
import time
from contextlib import contextmanager
logger = logging.getLogger(__name__)
# Try to import Prometheus
try:
from prometheus_client import CONTENT_TYPE_LATEST, Counter, Gauge, Histogram, generate_latest
_has_prometheus = True
except ImportError:
_has_prometheus = False
# Try to import OpenTelemetry
try:
from opentelemetry import trace
from opentelemetry.sdk.trace import TracerProvider
from opentelemetry.sdk.trace.export import ConsoleSpanExporter, SimpleSpanProcessor
_has_otel = True
except ImportError:
_has_otel = False
# Metrics
if _has_prometheus:
REQUEST_COUNT = Counter("pry_requests_total", "Total requests", ["method", "endpoint", "status"])
REQUEST_LATENCY = Histogram("pry_request_duration_seconds", "Request latency", ["endpoint"])
SCRAPE_COUNT = Counter("pry_scrapes_total", "Total scrapes", ["method", "status"])
SCRAPE_LATENCY = Histogram("pry_scrape_duration_seconds", "Scrape latency", ["method"])
LLM_CALLS = Counter("pry_llm_calls_total", "Total LLM calls", ["provider", "model"])
LLM_COST = Counter("pry_llm_cost_usd_total", "Total LLM cost in USD", ["provider"])
TEMPLATE_USAGE = Counter("pry_template_usage_total", "Template usage", ["template_id"])
CACHE_HITS = Counter("pry_cache_hits_total", "Cache hits", ["cache_type"])
ACTIVE_CONNECTIONS = Gauge("pry_active_connections", "Active connections", ["type"])
else:
REQUEST_COUNT = REQUEST_LATENCY = SCRAPE_COUNT = SCRAPE_LATENCY = None
LLM_CALLS = LLM_COST = TEMPLATE_USAGE = CACHE_HITS = ACTIVE_CONNECTIONS = None
def setup_tracing(service_name: str = "pry") -> None:
"""Initialize OpenTelemetry tracing."""
if not _has_otel: return
try:
provider = TracerProvider()
processor = SimpleSpanProcessor(ConsoleSpanExporter())
provider.add_span_processor(processor)
trace.set_tracer_provider(provider)
logger.info("tracing_initialized", extra={"service": service_name})
except Exception as e: # noqa: BLE001
logger.warning("tracing_init_failed", extra={"error": str(e)[:80]})
@contextmanager
def track_request(endpoint: str, method: str = "GET"):
"""Context manager to track request metrics and timing."""
start = time.time()
status = "success"
try:
yield
except Exception: # noqa: BLE001
status = "error"
raise
finally:
elapsed = time.time() - start
if _has_prometheus and REQUEST_COUNT and REQUEST_LATENCY:
REQUEST_COUNT.labels(method=method, endpoint=endpoint, status=status).inc()
REQUEST_LATENCY.labels(endpoint=endpoint).observe(elapsed)
@contextmanager
def track_scrape(method: str = "direct"):
"""Context manager to track scrape metrics."""
start = time.time()
status = "success"
try:
yield
except Exception: # noqa: BLE001
status = "error"
raise
finally:
elapsed = time.time() - start
if _has_prometheus and SCRAPE_COUNT and SCRAPE_LATENCY:
SCRAPE_COUNT.labels(method=method, status=status).inc()
SCRAPE_LATENCY.labels(method=method).observe(elapsed)
def track_llm_call(provider: str, model: str, cost: float = 0.0) -> None:
if _has_prometheus and LLM_CALLS and LLM_COST:
LLM_CALLS.labels(provider=provider, model=model).inc()
if cost > 0:
LLM_COST.labels(provider=provider).inc(cost)
def track_template(template_id: str) -> None:
if _has_prometheus and TEMPLATE_USAGE:
TEMPLATE_USAGE.labels(template_id=template_id).inc()
def get_metrics_output() -> tuple[bytes, str]:
"""Return Prometheus metrics in text format."""
if not _has_prometheus:
return b"# Prometheus not installed\n", "text/plain"
return generate_latest(), CONTENT_TYPE_LATEST