Skip to content

Commit af34877

Browse files
avangelilloclaudejoepeeples
authored
[vercel] Update setup docs for Datadog-owned Marketplace integration (#3026)
* [vercel] Update setup docs for Datadog-owned Marketplace integration Replaces the old manual two-step flow (copy API key between Datadog and Vercel UIs) with the new Vercel Marketplace-driven setup. Documents log drain configuration options, trace drain, log source types, and adds a note that Lambda logs are required for metrics collection. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * Apply suggestions from code review Co-authored-by: Joe Peeples <joe.peeples@datadoghq.com> --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com> Co-authored-by: Joe Peeples <joe.peeples@datadoghq.com>
1 parent c48ef2d commit af34877

1 file changed

Lines changed: 37 additions & 20 deletions

File tree

vercel/README.md

Lines changed: 37 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -11,37 +11,49 @@ Integrate Vercel with Datadog to:
1111
- View and parse your application logs using [Datadog's Log Management][5]
1212
- See the number of requests and 4xx/5xx HTTP errors to your serverless applications and APIs running on Vercel
1313
- Monitor frontend and [Vercel Functions][9] performance with [Datadog Synthetics][6]
14+
- Trace requests across your Vercel Functions with [Datadog APM][14]
1415

1516
## Setup
1617

17-
### Datadog
18+
The Datadog integration for Vercel is installed from the Vercel Marketplace.
1819

19-
To connect Datadog with Vercel, enable the integration and select an API Key.
20+
### Install Datadog from the Vercel Marketplace
2021

21-
1. Open the Vercel integration tile.
22+
1. Sign in to Vercel, then open the [Datadog listing in the Vercel Marketplace][7] and select **Connect Account**.
2223

23-
2. Select the **Configure** tab and select **Configure the Vercel integration**.
24+
2. Select the Vercel team in which you want to install the integration.
2425

25-
3. On the **Your Datadog account info** form, select **Select an API Key** and either choose an existing API key or select **+ Create New** to use a new API key for the Vercel integration.
26+
3. Select which projects to monitor: either all projects or a specific subset.
2627

27-
4. After your selection is made, select **Use API Key**. This copies the selected API key to your device's clipboard.
28+
4. Select **Connect Account**. After Vercel provisions the integration, you are redirected to the **Configure Vercel for Serverless** page in Datadog.
2829

29-
5. After the API key is selected, you are redirected back to the **Your Datadog account info** form. Select **Vercel > Add Integration** to complete the integration setup for Vercel.
30-
### Vercel
30+
### Configure the integration
3131

32-
1. Click the **Vercel > Add Integration** link to be redirected to Vercel's Datadog integration page.
32+
On the **Configure Vercel for Serverless** page, complete the following steps:
3333

34-
2. Select **Connect Account** to open the **Connect Datadog Account** form.
34+
1. **Confirm your organization** - If you belong to multiple Datadog organizations, select which one to connect to your Vercel account.
3535

36-
3. Select which Vercel Team to connect the integration to. (Teams that already have the integration installed have an icon next to them labeled **Installed**)
36+
2. **Select API Key** - Select **Create New** to create a dedicated key for this integration, or choose an existing API key.
3737

38-
4. Select the radio button associated with either enabling the integration for all projects or a specific project that the team owns. Select **Connect Account** to save your changes.
38+
3. **Enable Vercel Log Drain for Log Management** - Toggle **Log Drain** on to forward logs from your Vercel apps to Datadog. Set the sampling percentage (1-100%) for the share of logs to forward.
3939

40-
5. Paste the API key that was copied to your clipboard in Step 4 of the Datadog setup above into the box labeled **Your Datadog API Key**.
40+
4. **Set Log Sources** - Select which Vercel log sources to forward. At least one is required:
41+
- **Static**: CDN and static asset request logs
42+
- **Lambda**: Serverless Function execution logs
43+
- **Build**: Build output logs
44+
- **Edge**: Edge Function and Edge Middleware logs
45+
- **External**: Logs from external services routed through Vercel
46+
- **Firewall**: Vercel Firewall event logs
4147

42-
6. Scroll to the bottom of the form and select **Add Integration** to save your changes.
48+
**Note:** To ensure metrics are collected, Datadog recommends enabling **Lambda** logs and **Static** logs. Enabling **Build** logs is recommended if you want to collect build metrics.
4349

44-
[Configure the Vercel integration][7]
50+
5. **Set Log Environment** - Select **Production**, **Preview**, or both. At least one is required.
51+
52+
6. **Enable Vercel Trace Drain for APM** - Toggle **Trace Drain** on to forward traces from your Vercel apps to Datadog. Set the sampling percentage (1-100%).
53+
54+
7. Select **Add Integration**. The **Vercel Integration Setup** status page opens and confirms that data is flowing into Datadog. From there you can navigate to the Vercel Monitoring summary, the out-of-the-box dashboard, the Log Explorer, the Trace Explorer, and Real User Monitoring.
55+
56+
**Note:** Vercel Log Drains and Trace Drains are billed by Vercel. See the Vercel documentation for [Log Drains][10] and [Trace Drains][13].
4557

4658
## Data Collected
4759

@@ -61,10 +73,13 @@ The Vercel integration does not include any events.
6173

6274
The Vercel integration collects logs from your Vercel Project using Vercel's [Log Drains][10] feature.
6375

64-
## Troubleshooting
76+
### Traces
77+
78+
The Vercel integration collects traces from your Vercel Project using Vercel's [Trace Drains][13] feature.
6579

66-
If you are using the Vercel OpenTelemetry Collector, the `serviceName` specified in `registerOTel` block of your [initializer][12] must match the Vercel Project name. This enables traces to appear in Datadog with the appropriate logs and metrics.
80+
## Troubleshooting
6781

82+
If you are using the [Vercel OpenTelemetry SDK][12], the `serviceName` specified in `registerOTel` block of your initializer must match the Vercel Project name. This enables traces to appear in Datadog with the appropriate logs and metrics.
6883

6984
Need help? Contact [Datadog support][8].
7085

@@ -78,9 +93,11 @@ Need help? Contact [Datadog support][8].
7893
[4]: https://vercel.com/docs/serverless-functions/introduction
7994
[5]: https://docs.datadoghq.com/logs/
8095
[6]: https://docs.datadoghq.com/synthetics/
81-
[7]: /setup/vercel
96+
[7]: https://vercel.com/marketplace/datadog
8297
[8]: https://docs.datadoghq.com/help/
8398
[9]: https://vercel.com/docs/functions
84-
[10]: https://vercel.com/docs/observability/log-drains
99+
[10]: https://vercel.com/docs/drains/reference/logs
85100
[11]: https://github.com/DataDog/integrations-extras/blob/master/vercel/metadata.csv
86-
[12]: https://vercel.com/docs/observability/otel-overview#initialize-otel
101+
[12]: https://vercel.com/docs/tracing/instrumentation
102+
[13]: https://vercel.com/docs/drains/reference/traces
103+
[14]: https://docs.datadoghq.com/tracing/

0 commit comments

Comments
 (0)