Skip to content

Commit 571a3f2

Browse files
danbarrCopilot
andauthored
Add OpenTelemetry tutorial (#218)
Signed-off-by: Dan Barr <[email protected]> Co-authored-by: Dan Barr <[email protected]> Co-authored-by: Copilot <[email protected]>
1 parent 604df2f commit 571a3f2

File tree

7 files changed

+1002
-4
lines changed

7 files changed

+1002
-4
lines changed

docs/toolhive/concepts/observability.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -417,13 +417,15 @@ groups:
417417
Now that you understand how ToolHive's observability works, you can:
418418
419419
1. **Choose a monitoring backend** that fits your needs and budget
420-
2. **Enable telemetry** when running your servers:
420+
2. **Follow the tutorial** to set up a local observability stack with
421+
[OpenTelemetry, Jaeger, Prometheus, and Grafana](../tutorials/opentelemetry.mdx)
422+
3. **Enable telemetry** when running your servers:
421423
- [using the ToolHive CLI](../guides-cli/telemetry-and-metrics.md)
422424
- using the Kubernetes operator (not yet supported -
423425
[contributions welcome](https://github.com/stacklok/toolhive/releases/tag/v0.2.0))
424-
3. **Set up basic dashboards** to track request rates, error rates, and response
426+
4. **Set up basic dashboards** to track request rates, error rates, and response
425427
times
426-
4. **Configure alerts** for critical issues
428+
5. **Configure alerts** for critical issues
427429
428430
The telemetry system works automatically once enabled, providing immediate
429431
insights into your MCP server performance and usage patterns.

docs/toolhive/guides-cli/telemetry-and-metrics.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -322,6 +322,8 @@ Telemetry adds minimal overhead when properly configured:
322322

323323
## Related information
324324

325+
- Tutorial:
326+
[Collect telemetry for MCP workloads](../tutorials/opentelemetry.mdx)
325327
- [Telemetry and monitoring concepts](../concepts/observability.md)
326328
- [`thv run` command reference](../reference/cli/thv_run.md)
327329
- [Run MCP servers](run-mcp-servers.mdx)

docs/toolhive/guides-k8s/telemetry-and-metrics.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -278,6 +278,11 @@ Telemetry adds minimal overhead when properly configured:
278278

279279
## Related information
280280

281+
- Tutorial:
282+
[Collect telemetry for MCP workloads](../tutorials/opentelemetry.mdx) -
283+
Step-by-step guide to set up a local observability stack
284+
- [Telemetry and monitoring concepts](../concepts/observability.md) - Overview
285+
of ToolHive's observability architecture
281286
- [Kubernetes CRD reference](../reference/crd-spec.mdx) - Reference for the
282287
`MCPServer` Custom Resource Definition (CRD)
283288
- [Deploy the operator using Helm](./deploy-operator-helm.md) - Install the

0 commit comments

Comments
 (0)