Skip to content

Commit 575f846

Browse files
authored
feat: Re-organize log and trace drains page (#15642)
After doing a read through of #15595, I realized we could probably better incorporate details on forwarders, which I added as part of #15623. This hopefully makes this section a bit easier to grok, which is important as I'm going to link to this doc from onboarding within a couple of days, so it's going to get a lot more traffic. Thank you @KyleTryon for kick starting the work on this, made it much easier for me to conceptualize the needed sections on this. https://sentry-docs-git-abhi-refactor-drains-index.sentry.dev/product/drains/
1 parent 6b5dd91 commit 575f846

File tree

1 file changed

+30
-47
lines changed

1 file changed

+30
-47
lines changed

docs/product/drains/index.mdx

Lines changed: 30 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,53 @@
11
---
22
title: Log and Trace Drains
33
sidebar_order: 75
4-
description: Learn how to set up trace and log drains and forwarders to send data to Sentry.
4+
description: Learn how to set up drains and forwarders to send logs and traces to Sentry.
55
---
66

77
## Overview
88

9-
Log and trace drains allow you to forward logs and traces from your deployment platform's native logging and tracing systems directly into Sentry without modifying your application code. Drains capture platform-level telemetry—like build logs, runtime logs, and static asset logs—from deployment platforms such as Vercel, Cloudflare, Heroku, and Supabase.
9+
Drains and forwarders let you send [logs](/product/explore/logs/) and [traces](/product/explore/trace-explorer/) to Sentry without modifying your application code. They're ideal when:
1010

11-
Drains are ideal when you want to capture platform-level observability from your hosting infrastructure or when you can't install Sentry SDKs directly in your application.
11+
- You want to capture **platform-level telemetry** from your hosting infrastructure (e.g., Vercel Build Logs, Cloudflare Workers Traces).
12+
- You **can't install Sentry SDKs** directly in your application (e.g., Nginx Traces, Postgres Logs)
13+
- You're using an existing OpenTelemetry pipeline and want to start routing logs and traces data to Sentry via Sentry's [OpenTelemetry support](/concepts/otlp/).
1214

1315
<Alert level="info">
14-
Error events are not currently supported through drains. To capture errors, use [Sentry SDKs](/product/explore/logs/getting-started/) instead.
15-
</Alert>
16-
## Forwarders
17-
18-
- [Vector](/product/drains/integration/vector/)
19-
- [OpenTelemetry Collector](/product/drains/integration/opentelemetry-collector/)
20-
- [Fluent Bit](/product/drains/integration/fluentbit/)
21-
22-
## Drains
23-
24-
## Supported Platforms
25-
26-
| Platform | Logs | Traces | Documentation |
27-
|----------|------|--------|---------------|
28-
| [Vercel](/product/drains/integration/vercel/) ||| Forward runtime, build, and static logs, plus distributed traces |
29-
| [Cloudflare](/product/drains/integration/cloudflare/) ||| Forward logs and traces from Cloudflare Workers |
30-
| [Heroku](/product/drains/integration/heroku/) ||| Forward logs and traces via Heroku Telemetry Drains |
31-
| [Supabase](/product/drains/integration/supabase/) ||| Forward logs from your Supabase stack |
32-
| [Shopify Hydrogen](/product/drains/integration/shopify-hydrogen/) ||| Forward traces from Hydrogen storefronts |
3316

34-
## Supported Data Types
17+
Sending error events via drains or forwarders is not currently supported. To capture errors you'll need to add the [Sentry SDK](/platforms/) to your application.
3518

36-
Drains support forwarding **logs** from most supported platforms, with some platforms supporting **traces** as well:
37-
38-
- **Logs**: Application logs, runtime logs, build logs, and system-generated logs from your platform
39-
- **Traces**: Distributed tracing data showing request flows through your application and connected services (supported on Vercel, Cloudflare, Heroku, and Shopify Hydrogen)
40-
41-
## How Drains Work
19+
</Alert>
4220

43-
Drains work by configuring your deployment platform's native telemetry export system to forward data to Sentry's ingestion endpoints. Most platforms support forwarding data via:
21+
## Platform Drains
4422

45-
- [**OpenTelemetry Protocol (OTLP)**](https://opentelemetry.io/docs/): The standard protocol for forwarding logs and traces
46-
- **Platform-specific endpoints**: Custom endpoints provided by Sentry for specific platforms (like Vercel's custom drain endpoint). Follow the [platform-specific link](/product/drains/#supported-platforms) to learn more.
23+
**Platform drains** connect your hosting platform's native telemetry system directly to Sentry (e.g., Vercel, Cloudflare, Heroku)
4724

48-
Once configured, your platform automatically forwards logs and traces (where supported) to Sentry, where you can view, search, and analyze them alongside data from your Sentry SDKs.
25+
| Platform | Logs | Traces |
26+
| ----------------------------------------------------------------- | :--: | :----: |
27+
| [Vercel](/product/drains/integration/vercel/) |||
28+
| [Cloudflare Workers](/product/drains/integration/cloudflare/) |||
29+
| [Heroku](/product/drains/integration/heroku/) |||
30+
| [Supabase](/product/drains/integration/supabase/) |||
31+
| [Shopify Hydrogen](/product/drains/integration/shopify-hydrogen/) |||
4932

50-
## Prerequisites
33+
## Forwarders
5134

52-
Before setting up a drain, ensure you have:
35+
**Forwarders** collect logs and traces from various sources and route them to Sentry.
5336

54-
1. **A Sentry project**: Create a project in Sentry if you don't have one already
55-
2. **Your project credentials**: You'll need your Sentry project's OTLP endpoint URL and public key, which can be found in your [Sentry Project Settings](https://sentry.io/settings/projects/) under **Client Keys (DSN)** > **OpenTelemetry (OTLP)**
56-
3. **Platform access**: Admin or configuration access to your platform's telemetry settings
37+
| Forwarder | Logs | Traces |
38+
| --------------------------------------------------------------------------------------------- | :--: | :----: |
39+
| [OpenTelemetry Collector](/product/drains/integration/opentelemetry-collector/) (recommended) |||
40+
| [Vector](/product/drains/integration/vector/) |||
41+
| [Fluent Bit](/product/drains/integration/fluentbit/) |||
5742

58-
## Getting Started
43+
## Learn More
5944

60-
1. Choose your platform from the [Supported Platforms](#supported-platforms) table above and follow the platform-specific setup guide
61-
2. Configure the drain in your platform's dashboard or via CLI using your Sentry project credentials (found in your [Sentry Project Settings](https://sentry.io/settings/projects/) under **Client Keys (DSN)** > **OpenTelemetry (OTLP)**)
62-
3. Verify data is flowing by checking your Sentry project's [Logs](/product/explore/logs/) or [Performance](/product/performance/) views
45+
- [Logs](/product/explore/logs/): View, search, and analyze logs in Sentry
46+
- [Trace Explorer](/product/explore/trace-explorer/): View, search, and analyze traces in Sentry
47+
- [OpenTelemetry Protocol](/concepts/otlp/): Learn about Sentry's OpenTelemetry support and how to export OTLP data to Sentry
6348

64-
Most drains use Sentry's [OpenTelemetry Protocol (OTLP)](/concepts/otlp/) endpoints. Some platforms, like Vercel, also support custom endpoints. You can find your OTLP endpoint URLs and authentication headers in your project settings.
49+
<Alert level="warning">
6550

66-
## Related Documentation
51+
Sending [metrics](/product/explore/metrics/) via drains or forwarders is not currently supported. If you're interested this support for this please reach out on [GitHub](https://github.com/getsentry/sentry/issues/103486) or or email us at [[email protected]](mailto:[email protected]).
6752

68-
- [Logs Overview](/product/explore/logs/): Learn how to view, search, and analyze logs in Sentry
69-
- [Performance Monitoring](/product/performance/): Understand distributed tracing and performance data
70-
- [OpenTelemetry Protocol](/concepts/otlp/): Learn more about OTLP and how to configure OpenTelemetry SDKs
53+
</Alert>

0 commit comments

Comments
 (0)