mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-07-04 13:15:24 +00:00
c9a49a80e8
# What does this PR do? Simple approach to get some provider pages in the docs. Add or update description fields in the provider configuration class using Pydantic’s Field, ensuring these descriptions are clear and complete, as they will be used to auto-generate provider documentation via ./scripts/distro_codegen.py instead of editing the docs manually. Signed-off-by: Sébastien Han <seb@redhat.com>
58 lines
2 KiB
Python
58 lines
2 KiB
Python
# Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
# All rights reserved.
|
|
#
|
|
# This source code is licensed under the terms described in the LICENSE file in
|
|
# the root directory of this source tree.
|
|
|
|
from enum import StrEnum
|
|
from typing import Any
|
|
|
|
from pydantic import BaseModel, Field, field_validator
|
|
|
|
from llama_stack.distribution.utils.config_dirs import RUNTIME_BASE_DIR
|
|
|
|
|
|
class TelemetrySink(StrEnum):
|
|
OTEL_TRACE = "otel_trace"
|
|
OTEL_METRIC = "otel_metric"
|
|
SQLITE = "sqlite"
|
|
CONSOLE = "console"
|
|
|
|
|
|
class TelemetryConfig(BaseModel):
|
|
otel_trace_endpoint: str | None = Field(
|
|
default=None,
|
|
description="The OpenTelemetry collector endpoint URL for traces",
|
|
)
|
|
otel_metric_endpoint: str | None = Field(
|
|
default=None,
|
|
description="The OpenTelemetry collector endpoint URL for metrics",
|
|
)
|
|
service_name: str = Field(
|
|
# service name is always the same, use zero-width space to avoid clutter
|
|
default="\u200b",
|
|
description="The service name to use for telemetry",
|
|
)
|
|
sinks: list[TelemetrySink] = Field(
|
|
default=[TelemetrySink.CONSOLE, TelemetrySink.SQLITE],
|
|
description="List of telemetry sinks to enable (possible values: otel, sqlite, console)",
|
|
)
|
|
sqlite_db_path: str = Field(
|
|
default_factory=lambda: (RUNTIME_BASE_DIR / "trace_store.db").as_posix(),
|
|
description="The path to the SQLite database to use for storing traces",
|
|
)
|
|
|
|
@field_validator("sinks", mode="before")
|
|
@classmethod
|
|
def validate_sinks(cls, v):
|
|
if isinstance(v, str):
|
|
return [TelemetrySink(sink.strip()) for sink in v.split(",")]
|
|
return v
|
|
|
|
@classmethod
|
|
def sample_run_config(cls, __distro_dir__: str, db_name: str = "trace_store.db") -> dict[str, Any]:
|
|
return {
|
|
"service_name": "${env.OTEL_SERVICE_NAME:=\u200b}",
|
|
"sinks": "${env.TELEMETRY_SINKS:=console,sqlite}",
|
|
"sqlite_db_path": "${env.SQLITE_STORE_DIR:=" + __distro_dir__ + "}/" + db_name,
|
|
}
|