Skip to content

Add OpenTelemetry tutorial #218

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Oct 7, 2025
Merged

Add OpenTelemetry tutorial #218

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
dcc80ca
Add OpenTelemetry tutorial
danbarr Sep 29, 2025
3868ca9
Don't expand the tutorials section by default
danbarr Oct 2, 2025
7a1e755
Fix typo and update diagrams
danbarr Oct 3, 2025
e1a981d
Add cross-references from other guides
danbarr Oct 3, 2025
9ef8193
Fix typo
danbarr Oct 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions docs/toolhive/concepts/observability.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -417,13 +417,15 @@ groups:
Now that you understand how ToolHive's observability works, you can:

1. **Choose a monitoring backend** that fits your needs and budget
2. **Enable telemetry** when running your servers:
2. **Follow the tutorial** to set up a local observability stack with
[OpenTelemetry, Jaeger, Prometheus, and Grafana](../tutorials/opentelemetry.mdx)
3. **Enable telemetry** when running your servers:
- [using the ToolHive CLI](../guides-cli/telemetry-and-metrics.md)
- using the Kubernetes operator (not yet supported -
[contributions welcome](https://github.com/stacklok/toolhive/releases/tag/v0.2.0))
3. **Set up basic dashboards** to track request rates, error rates, and response
4. **Set up basic dashboards** to track request rates, error rates, and response
times
4. **Configure alerts** for critical issues
5. **Configure alerts** for critical issues

The telemetry system works automatically once enabled, providing immediate
insights into your MCP server performance and usage patterns.
2 changes: 2 additions & 0 deletions docs/toolhive/guides-cli/telemetry-and-metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -322,6 +322,8 @@ Telemetry adds minimal overhead when properly configured:

## Related information

- Tutorial:
[Collect telemetry for MCP workloads](../tutorials/opentelemetry.mdx)
- [Telemetry and monitoring concepts](../concepts/observability.md)
- [`thv run` command reference](../reference/cli/thv_run.md)
- [Run MCP servers](run-mcp-servers.mdx)
Expand Down
5 changes: 5 additions & 0 deletions docs/toolhive/guides-k8s/telemetry-and-metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,6 +278,11 @@ Telemetry adds minimal overhead when properly configured:

## Related information

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