Skip to content

Commit bf62ddc

Browse files
committed
amends CLI docs with new telemetry flags
Signed-off-by: ChrisJBurns <[email protected]>
1 parent e5b4e26 commit bf62ddc

File tree

1 file changed

+27
-9
lines changed

1 file changed

+27
-9
lines changed

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

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ thv run \
3838
--otel-endpoint localhost:4318 \
3939
--otel-service-name fetch-mcp \
4040
--otel-insecure \
41+
--otel-tracing-enabled \
42+
--otel-metrics-enabled
4143
fetch
4244
```
4345

@@ -70,6 +72,8 @@ context like deployment environment or service version to your traces.
7072
```bash
7173
thv run \
7274
--otel-endpoint api.honeycomb.io \
75+
--otel-tracing-enabled \
76+
--otel-metrics-enabled \
7377
--otel-headers "x-honeycomb-team=<YOUR_API_KEY>" \
7478
--otel-env-vars "NODE_ENV,DEPLOYMENT_ENV,SERVICE_VERSION" \
7579
fetch
@@ -113,6 +117,8 @@ This example exports to Honeycomb and enables the Prometheus metrics endpoint:
113117
```bash
114118
thv run \
115119
--otel-endpoint api.honeycomb.io \
120+
--otel-tracing-enabled \
121+
--otel-metrics-enabled \
116122
--otel-headers "x-honeycomb-team=<YOUR_API_KEY>" \
117123
--otel-enable-prometheus-metrics-path \
118124
fetch
@@ -132,20 +138,23 @@ when running an MCP server with the `thv run` command:
132138

133139
```bash
134140
thv run [--otel-endpoint <URL>] [--otel-service-name <NAME>] \
141+
[--otel-metrics-enabled] [--otel-tracing-enabled] \
135142
[--otel-sampling-rate <RATE>] [--otel-headers <KEY=VALUE>] \
136143
[--otel-insecure] [--otel-enable-prometheus-metrics-path] \
137144
<SERVER>
138145
```
139146

140-
| Flag | Description | Default |
141-
| --------------------------------------- | ----------------------------------------------------------- | -------------------- |
142-
| `--otel-endpoint` | OTLP endpoint (e.g., `api.honeycomb.io`) | None |
143-
| `--otel-service-name` | Service name for telemetry | `toolhive-mcp-proxy` |
144-
| `--otel-sampling-rate` | Trace sampling rate (0.0-1.0) | `0.1` (10%) |
145-
| `--otel-headers` | Authentication headers in `key=value` format | None |
146-
| `--otel-env-vars` | List of environment variables to include in telemetry spans | None |
147-
| `--otel-insecure` | Connect using HTTP instead of HTTPS | `false` |
148-
| `--otel-enable-prometheus-metrics-path` | Enable `/metrics` endpoint | `false` |
147+
| Flag | Description | Default |
148+
| --------------------------------------- | ------------------------------------------------------------- | -------------------- |
149+
| `--otel-endpoint` | OTLP endpoint (e.g., `api.honeycomb.io`) | None |
150+
| `--otel-metrics-enabled` | Enable OTLP metrics export (when OTLP endpoint is configured) | `false` |
151+
| `--otel-tracing-enabled` | Enable distributed tracing (when OTLP endpoint is configured) | `false` |
152+
| `--otel-service-name` | Service name for telemetry | `toolhive-mcp-proxy` |
153+
| `--otel-sampling-rate` | Trace sampling rate (0.0-1.0) | `0.1` (10%) |
154+
| `--otel-headers` | Authentication headers in `key=value` format | None |
155+
| `--otel-env-vars` | List of environment variables to include in telemetry spans | None |
156+
| `--otel-insecure` | Connect using HTTP instead of HTTPS | `false` |
157+
| `--otel-enable-prometheus-metrics-path` | Enable `/metrics` endpoint | `false` |
149158

150159
### Global configuration
151160

@@ -162,6 +171,8 @@ rate:
162171

163172
```bash
164173
thv config otel set-endpoint api.honeycomb.io
174+
thv config otel set-metrics-enabled true
175+
thv config otel set-tracing-enabled true
165176
thv config otel set-sampling-rate 0.25
166177
```
167178

@@ -204,6 +215,8 @@ OTLP http receiver port (default is `4318`):
204215
```bash
205216
thv run \
206217
--otel-endpoint localhost:4318 \
218+
--otel-tracing-enabled \
219+
--otel-metrics-enabled \
207220
--otel-insecure \
208221
fetch
209222
```
@@ -240,6 +253,7 @@ by setting the OTLP endpoint to Jaeger's collector:
240253
```bash
241254
thv run \
242255
--otel-endpoint localhost:4318 \
256+
--otel-tracing-enabled \
243257
--otel-insecure \
244258
<SERVER>
245259
```
@@ -256,6 +270,8 @@ forward data to Honeycomb. This example sends data directly to Honeycomb:
256270
```bash
257271
thv run \
258272
--otel-endpoint api.honeycomb.io \
273+
--otel-tracing-enabled \
274+
--otel-metrics-enabled \
259275
--otel-headers "x-honeycomb-team=<YOUR_API_KEY>" \
260276
--otel-service-name production-mcp-proxy \
261277
<SERVER>
@@ -290,6 +306,8 @@ You can also send data directly to
290306
```bash
291307
thv run \
292308
--otel-endpoint otlp-gateway-prod-us-central-0.grafana.net \
309+
--otel-tracing-enabled \
310+
--otel-metrics-enabled \
293311
--otel-headers "Authorization=Basic $(echo -n 'user:password' | base64)" \
294312
<SERVER>
295313
```

0 commit comments

Comments
 (0)