From d734607043f903743ca20ce5cfd39397944f741c Mon Sep 17 00:00:00 2001 From: Dinesh Yeduguru Date: Thu, 5 Dec 2024 10:26:26 -0800 Subject: [PATCH] include APIs supported --- docs/source/experimental/telemetry/index.md | 28 +++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/docs/source/experimental/telemetry/index.md b/docs/source/experimental/telemetry/index.md index a90ed9dad..0a51d5266 100644 --- a/docs/source/experimental/telemetry/index.md +++ b/docs/source/experimental/telemetry/index.md @@ -25,6 +25,34 @@ The telemetry system supports three main types of events: - **SQLite**: Store events in a local SQLite database. This is needed if you want to query the events later through the Llama Stack API. - **Console**: Print events to the console. +## APIs + +The telemetry system exposes the following HTTP endpoints: + +### Log Event +```http +POST /telemetry/log-event +``` +Logs a telemetry event (unstructured log, metric, or structured log) with optional TTL. + +### Query Traces +```http +POST /telemetry/query-traces +``` +Retrieves traces based on filters with pagination support. Parameters: +- `attribute_filters`: List of conditions to filter traces +- `limit`: Maximum number of traces to return (default: 100) +- `offset`: Number of traces to skip (default: 0) +- `order_by`: List of fields to sort by + +### Get Span Tree +```http +POST /telemetry/get-span-tree +``` +Retrieves a hierarchical view of spans starting from a specific span. Parameters: +- `span_id`: ID of the root span to retrieve +- `attributes_to_return`: Optional list of specific attributes to include +- `max_depth`: Optional maximum depth of the span tree to return ## Providers