Skip to content

Secure, Fast, and Extensible Sandbox runtime for AI agents.

7.3 KB
Raw Blame
# Copyright 2026 The OpenSandbox Authors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""OpenTelemetry metrics helpers for Server and SDK lifecycle telemetry."""

from __future__ import annotations

import logging
from typing import TYPE_CHECKING, Optional

from opentelemetry import metrics
from opentelemetry.sdk.metrics import MeterProvider
from opentelemetry.sdk.metrics.export import PeriodicExportingMetricReader
from opentelemetry.sdk.metrics.view import ExplicitBucketHistogramAggregation, View
from opentelemetry.sdk.resources import Resource

if TYPE_CHECKING:
    from opensandbox_server.config import OtelConfig

logger = logging.getLogger(__name__)

_CREATE_DURATION_HISTOGRAM_NAME = "opensandbox.sandbox.create.duration"
_CREATE_DURATION_UNIT = "ms"
_CREATE_DURATION_DESCRIPTION = (
    "Sandbox creation latency from SDK create start until ready or failure"
)
_CREATE_DURATION_BOUNDARIES = (
    100.0,
    250.0,
    500.0,
    1000.0,
    2500.0,
    5000.0,
    10000.0,
    30000.0,
    60000.0,
)
_HTTP_REQUEST_DURATION_HISTOGRAM_NAME = "server.http.request.duration"
_HTTP_REQUEST_DURATION_UNIT = "ms"
_HTTP_REQUEST_DURATION_DESCRIPTION = (
    "Server HTTP request duration by method, route template, and status code"
)
_HTTP_REQUEST_METHODS = frozenset(
    {"CONNECT", "DELETE", "GET", "HEAD", "OPTIONS", "PATCH", "POST", "PUT", "TRACE"}
)
_HTTP_REQUEST_DURATION_BOUNDARIES = (
    1.0,
    5.0,
    10.0,
    25.0,
    50.0,
    100.0,
    250.0,
    500.0,
    1000.0,
    2500.0,
    5000.0,
    10000.0,
    30000.0,
    60000.0,
)

_meter_provider: Optional[MeterProvider] = None
_create_duration_histogram = None
_http_request_duration_histogram = None


def _histogram_from_provider(provider: MeterProvider):
    return provider.get_meter("opensandbox.server").create_histogram(
        name=_CREATE_DURATION_HISTOGRAM_NAME,
        unit=_CREATE_DURATION_UNIT,
        description=_CREATE_DURATION_DESCRIPTION,
    )


def _http_request_histogram_from_provider(provider: MeterProvider):
    return provider.get_meter("opensandbox.server").create_histogram(
        name=_HTTP_REQUEST_DURATION_HISTOGRAM_NAME,
        unit=_HTTP_REQUEST_DURATION_UNIT,
        description=_HTTP_REQUEST_DURATION_DESCRIPTION,
    )


def setup_otel_metrics(config: OtelConfig) -> None:
    """Configure OTEL metrics export when enabled; otherwise keep recording as noop."""
    global _meter_provider, _create_duration_histogram, _http_request_duration_histogram

    # Disabled: do not attach instruments to any global provider (may already export).
    if not config.enabled:
        _create_duration_histogram = None
        _http_request_duration_histogram = None
        logger.info(
            "OpenTelemetry metrics export disabled; Server and SDK metrics are noops"
        )
        return

    try:
        from opentelemetry.exporter.otlp.proto.http.metric_exporter import (
            OTLPMetricExporter,
        )
    except ImportError as exc:  # pragma: no cover
        raise RuntimeError(
            "opentelemetry-exporter-otlp-proto-http is required when [otel] enabled=true"
        ) from exc

    endpoint = (config.endpoint or "").strip() or None
    exporter_kwargs = {}
    if endpoint:
        exporter_kwargs["endpoint"] = endpoint

    exporter = OTLPMetricExporter(**exporter_kwargs)
    reader = PeriodicExportingMetricReader(
        exporter,
        export_interval_millis=config.export_interval_millis,
    )
    resource = Resource.create({"service.name": config.service_name})
    views = [
        View(
            instrument_name=_CREATE_DURATION_HISTOGRAM_NAME,
            aggregation=ExplicitBucketHistogramAggregation(
                boundaries=list(_CREATE_DURATION_BOUNDARIES)
            ),
        ),
        View(
            instrument_name=_HTTP_REQUEST_DURATION_HISTOGRAM_NAME,
            aggregation=ExplicitBucketHistogramAggregation(
                boundaries=list(_HTTP_REQUEST_DURATION_BOUNDARIES)
            ),
        ),
    ]
    provider = MeterProvider(
        resource=resource,
        metric_readers=[reader],
        views=views,
    )

    current = metrics.get_meter_provider()
    if isinstance(current, MeterProvider):
        logger.warning(
            "A global MeterProvider is already installed; opensandbox will export "
            "metrics via its own provider and will not replace the global one"
        )
    else:
        metrics.set_meter_provider(provider)

    # Always bind instruments to *this* provider so export uses our OTLP reader,
    # even when set_meter_provider() cannot override a preexisting global provider.
    _meter_provider = provider
    _create_duration_histogram = _histogram_from_provider(provider)
    _http_request_duration_histogram = _http_request_histogram_from_provider(provider)
    logger.info(
        f"OpenTelemetry metrics enabled (service={config.service_name}, "
        f"endpoint={endpoint or '(default from OTEL_EXPORTER_OTLP_* env)'})"
    )


def shutdown_otel_metrics() -> None:
    """Flush and shut down the configured MeterProvider if any."""
    global _meter_provider, _create_duration_histogram, _http_request_duration_histogram
    provider = _meter_provider
    _meter_provider = None
    _create_duration_histogram = None
    _http_request_duration_histogram = None
    if provider is None:
        return
    try:
        provider.shutdown()
    except Exception:
        logger.exception("Failed to shut down OpenTelemetry MeterProvider")


def record_sandbox_create_duration(
    *,
    create_duration_ms: int,
    sdk_language: str,
    sdk_version: str,
    success: bool,
) -> None:
    """Record a sandbox.create duration sample. Never raises.

    No-ops when OTEL export is disabled or setup has not installed a histogram.
    """
    hist = _create_duration_histogram
    if hist is None:
        return
    try:
        hist.record(
            float(create_duration_ms),
            attributes={
                "sdk.language": sdk_language,
                "sdk.version": sdk_version,
                "success": success,
            },
        )
    except Exception:
        logger.exception("Failed to record sandbox create duration metric")


def record_http_request_duration(
    *,
    duration_ms: float,
    method: str,
    route: str,
    status_code: int,
) -> None:
    """Record a low-cardinality Server HTTP duration sample. Never raises."""
    hist = _http_request_duration_histogram
    if hist is None:
        return
    normalized_method = method.upper()
    if normalized_method not in _HTTP_REQUEST_METHODS:
        normalized_method = "OTHER"
    try:
        hist.record(
            duration_ms,
            attributes={
                "http_method": normalized_method,
                "http_route": route or "unknown",
                "http_status_code": status_code,
            },
        )
    except Exception:
        logger.exception("Failed to record Server HTTP request duration metric")