115 lines
4.2 KiB
Python
115 lines
4.2 KiB
Python
"""Configuration for shared-metrics transmission.
|
|
|
|
Collection (``telemetry.shared_metrics.enabled``) and transmission
|
|
(``telemetry.shared_metrics.send``) are separate opt-ins. See
|
|
``docs/observability/relay-shared-metrics.md`` Appendix A for the consent,
|
|
identity, rotation, retention, and deletion decisions behind this module.
|
|
"""
|
|
|
|
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 overridable by an environment variable: AGENTS.md reserves
|
|
#: HERMES_* env vars for secrets, and a behavioural override here would be a
|
|
#: consent hazard — a user who agreed to send metrics to Nous could have them
|
|
#: silently redirected to any host by an inherited variable, with nothing
|
|
#: visible in their config to show it. 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.
|
|
|
|
Telemetry must not leave a machine in clear text because of a typo in a
|
|
config file. Loopback stays allowed so tests can use a local HTTP server.
|
|
"""
|
|
try:
|
|
parsed = urlparse(endpoint)
|
|
except ValueError:
|
|
return False
|
|
if parsed.scheme == "https":
|
|
return True
|
|
if parsed.scheme == "http":
|
|
return (parsed.hostname or "") in _LOCAL_HOSTS
|
|
return False
|
|
|
|
|
|
def resolve_send_config(config: dict | None) -> SendConfig:
|
|
"""Resolve transmission settings from config plus the environment.
|
|
|
|
Endpoint precedence: config > production default.
|
|
|
|
``send`` is returned as 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. Error level, once per process.
|
|
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)
|
|
|
|
|
|
def reset_warning_latch_for_tests() -> None:
|
|
"""Clear the once-per-process error latch (test support only)."""
|
|
global _warned_send_without_collection
|
|
_warned_send_without_collection = False
|