From c93bd787537e7005d8a990de1fa0b22ad33ef727 Mon Sep 17 00:00:00 2001 From: dinesh Date: Wed, 8 Oct 2025 13:32:29 -0400 Subject: [PATCH] docs: add OpenTelemetry GenAI instrumentation sample --- docs/OPENTELEMETRY_GENAI.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 docs/OPENTELEMETRY_GENAI.md diff --git a/docs/OPENTELEMETRY_GENAI.md b/docs/OPENTELEMETRY_GENAI.md new file mode 100644 index 000000000000..3fc8f086184c --- /dev/null +++ b/docs/OPENTELEMETRY_GENAI.md @@ -0,0 +1,28 @@ +# OpenTelemetry GenAI instrumentation sample + +The community project [otel-genai-bridges](https://github.com/dineshkumarkummara/otel-genai-bridges) includes a .NET library (`SkOtel`) and sample (`dotnet/samples/sk-chat`) that instrument Semantic Kernel applications using the [OpenTelemetry Generative AI semantic conventions](https://github.com/open-telemetry/semantic-conventions/tree/main/docs/gen-ai). + +## Highlights + +- `AddSemanticKernelTelemetry` extension registers telemetry options, middleware, and a DelegatingHandler. +- Middleware captures prompts, completions, tool invocations, latency, token usage, cost, and RAG retrieval latency. +- Docker Compose stack (OpenTelemetry Collector → Tempo/Prometheus → Grafana) and dashboards are provided out of the box. + +## Quick start + +```bash +# Clone the repository +git clone https://github.com/dineshkumarkummara/otel-genai-bridges.git +cd otel-genai-bridges + +# Launch the collector, Tempo, Prometheus, Grafana, and both sample apps +./scripts/run_all.sh +``` + +The Semantic Kernel sample listens on `http://localhost:7080`. Send prompts to `/chat` or `/rag` with `curl` to generate telemetry. + +![Grafana token throughput panel](https://github.com/dineshkumarkummara/otel-genai-bridges/raw/main/docs/screenshots/grafana-tokens.png) + +The Grafana dashboard (http://localhost:3000/d/genai-overview) surfaces latency, token usage, error rates, tool-call counts, and RAG retrieval latency. Tempo provides trace waterfalls showing prompt/response events and tool execution spans. + +For more details or to contribute, visit the repository: https://github.com/dineshkumarkummara/otel-genai-bridges.