Skip to content

Commit b0c6fbe

Browse files
KyleAMathewsclaude
andauthored
docs: Add OpenTelemetry section to deployment guide (#3684)
## Summary - Adds an "Observability" section to the deployment guide mentioning OpenTelemetry support - Links to the telemetry reference page for configuration details ## Test plan - [ ] Verify the deployment guide renders correctly - [ ] Verify the deep link to `#opentelemetry` works 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
1 parent b91e3a8 commit b0c6fbe

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

website/docs/guides/deployment.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,12 @@ curl http://localhost:3000/v1/health
183183
# {"status":"active"}
184184
```
185185

186+
### Observability
187+
188+
Electric supports [OpenTelemetry](https://opentelemetry.io/) for exporting traces, with built-in support for [Honeycomb.io](https://www.honeycomb.io/). Metrics are also available in StatsD and Prometheus formats.
189+
190+
See the [Telemetry reference](/docs/reference/telemetry#opentelemetry) for configuration details.
191+
186192
### Caching proxy
187193

188194
Electric is designed to run behind a caching proxy, such as [Nginx](https://nginx.org/en), [Caddy](https://caddyserver.com), [Varnish](https://varnish-cache.org) or a CDN like [Cloudflare](https://www.cloudflare.com/en-gb/application-services/products/cdn) or [Fastly](https://www.fastly.com/products/cdn). You don't _have_ to run a proxy in front of Electric but you will benefit from radically better performance if you do.

0 commit comments

Comments
 (0)