| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889 |
- """Configuration for shared-metrics transmission."""
- from __future__ import annotations
- import logging
- from dataclasses import dataclass
- from urllib.parse import urlparse
- logger = logging.getLogger(__name__)
- #: Production ingest endpoint. Overridable through config only — deliberately NOT by an
- #: environment variable: AGENTS.md reserves HERMES_* for secrets, and an inherited variable
- #: could silently redirect consented metrics to any host with nothing visible in config.
- #: Tests and the staging E2E write this key into a throwaway profile instead.
- DEFAULT_ENDPOINT = "https://telemetry.nousresearch.com/v1/telemetry"
- _LOCAL_HOSTS = frozenset({"localhost", "127.0.0.1", "::1", "[::1]"})
- # Module-level latch: the enabled/send mismatch is a static misconfiguration,
- # so it is reported once per process instead of on every hook fire.
- _warned_send_without_collection = False
- @dataclass(frozen=True)
- class SendConfig:
- """Resolved transmission settings."""
- #: Collection is on. Nothing is packaged or sent without it.
- enabled: bool
- #: Transmission is on AND permitted (that is, collection is also on).
- send: bool
- #: Where packages are POSTed.
- endpoint: str
- def _endpoint_is_safe(endpoint: str) -> bool:
- """Reject plaintext destinations unless they are loopback (so tests can use local HTTP)."""
- try:
- parsed = urlparse(endpoint)
- except ValueError:
- return False
- if parsed.scheme == "https":
- return True
- return parsed.scheme == "http" and (parsed.hostname or "") in _LOCAL_HOSTS
- def resolve_send_config(config: dict | None) -> SendConfig:
- """Resolve transmission settings from config (endpoint: config > production default).
- ``send`` is False whenever transmission cannot legitimately happen, so callers never
- have to re-check the combination.
- """
- global _warned_send_without_collection
- raw = config if isinstance(config, dict) else {}
- telemetry = raw.get("telemetry")
- telemetry = telemetry if isinstance(telemetry, dict) else {}
- shared = telemetry.get("shared_metrics")
- shared = shared if isinstance(shared, dict) else {}
- enabled = shared.get("enabled") is True
- send_requested = shared.get("send") is True
- if send_requested and not enabled:
- # Loud, not silent: the user believes telemetry is being sent, and it never will be.
- if not _warned_send_without_collection:
- _warned_send_without_collection = True
- logger.error(
- "telemetry.shared_metrics.send is true but "
- "telemetry.shared_metrics.enabled is false — nothing is "
- "collected, so nothing can be sent. Enable collection or "
- "turn sending off."
- )
- return SendConfig(enabled=False, send=False, endpoint=DEFAULT_ENDPOINT)
- endpoint = shared.get("endpoint")
- if not isinstance(endpoint, str) or not endpoint.strip():
- endpoint = DEFAULT_ENDPOINT
- endpoint = endpoint.strip()
- if send_requested and not _endpoint_is_safe(endpoint):
- logger.error(
- "Refusing to send shared metrics to %r: telemetry must use https "
- "(or a localhost http endpoint for testing).",
- endpoint,
- )
- return SendConfig(enabled=enabled, send=False, endpoint=endpoint)
- return SendConfig(enabled=enabled, send=send_requested, endpoint=endpoint)
|