forked from phoenix-oss/llama-stack-mirror
27a27152cd
# What does this PR do? #525 introduced a telemetry configuration named jaeger, but what it really is pointing to is an OTLP HTTP endpoint which is supported by most servers in the ecosystem, including raw opentelemetry collectors, several APMs, and even https://github.com/ymtdzzz/otel-tui I chose to rename this to "otel" as it will bring in more people to the ecosystem vs feeling it only works with jaeger. Later, we can use the [standard ENV](https://opentelemetry.io/docs/specs/otel/protocol/exporter/) to configure this if we like so that you can override things with variables people might expect. Note: I also added to the README that you have to install conda. Depending on experience level of the user, and especially with miniforge vs other ways, I felt this helps. ## Test Plan I would like to test this, but actually got a little lost. The previous PRs referenced yaml which doesn't seem published anywhere. It would be nice to have a pre-canned setup that uses ollama and turns on otel, but would also appreciate a hand on instructions meanwhile. ## Sources https://github.com/meta-llama/llama-stack/pull/525 ## Before submitting - [ ] This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case). - [x] Ran pre-commit to handle lint / formatting issues. - [x] Read the [contributor guideline](https://github.com/meta-llama/llama-stack/blob/main/CONTRIBUTING.md), Pull Request section? - [ ] Updated relevant documentation. - [ ] Wrote necessary unit or integration tests. --------- Signed-off-by: Adrian Cole <adrian.cole@elastic.co>
45 lines
1.5 KiB
Python
45 lines
1.5 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 Enum
|
|
from typing import Any, Dict, List
|
|
|
|
from pydantic import BaseModel, Field
|
|
|
|
from llama_stack.distribution.utils.config_dirs import RUNTIME_BASE_DIR
|
|
|
|
|
|
class TelemetrySink(str, Enum):
|
|
OTEL = "otel"
|
|
SQLITE = "sqlite"
|
|
CONSOLE = "console"
|
|
|
|
|
|
class TelemetryConfig(BaseModel):
|
|
otel_endpoint: str = Field(
|
|
default="http://localhost:4318/v1/traces",
|
|
description="The OpenTelemetry collector endpoint URL",
|
|
)
|
|
service_name: str = Field(
|
|
default="llama-stack",
|
|
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=(RUNTIME_BASE_DIR / "trace_store.db").as_posix(),
|
|
description="The path to the SQLite database to use for storing traces",
|
|
)
|
|
|
|
@classmethod
|
|
def sample_run_config(cls, **kwargs) -> Dict[str, Any]:
|
|
return {
|
|
"service_name": "${env.OTEL_SERVICE_NAME:llama-stack}",
|
|
"sinks": "${env.TELEMETRY_SINKS:['console', 'sqlite']}",
|
|
"sqlite_db_path": "${env.SQLITE_DB_PATH:${runtime.base_dir}/trace_store.db}",
|
|
}
|