Skip to content

Commit 2d378af

Browse files
avangelilloclaude
andcommitted
[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>
1 parent 3d46fdc commit 2d378af

1 file changed

Lines changed: 35 additions & 20 deletions

File tree

vercel/README.md

Lines changed: 35 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -14,34 +14,45 @@ Integrate Vercel with Datadog to:
1414

1515
## Setup
1616

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

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

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

23-
2. Select the **Configure** tab and select **Configure the Vercel integration**.
23+
2. Select the Vercel team to install the integration into.
2424

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.
25+
3. Select which projects to monitor - either all projects or a specific subset.
2626

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

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
29+
### Configure the integration
3130

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

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

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**)
35+
2. **Select API Key** — Select **+ Create New** to create a dedicated key for this integration, or choose an existing API key.
3736

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.
37+
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.
3938

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**.
39+
4. **Set Log Sources** — Select which Vercel log sources to forward. At least one is required:
40+
- **Static**: CDN and static asset request logs
41+
- **Lambda**: Serverless Function execution logs
42+
- **Build**: Build output logs
43+
- **Edge**: Edge Function and Edge Middleware logs
44+
- **External**: Logs from external services routed through Vercel
45+
- **Firewall**: Vercel Firewall event logs
4146

42-
6. Scroll to the bottom of the form and select **Add Integration** to save your changes.
47+
**Note:** Datadog derives the `vercel.functions.*` and `vercel.requests` metrics from **Lambda** logs. Datadog recommends enabling **Lambda** as a log source to ensure metrics are collected.
4348

44-
[Configure the Vercel integration][7]
49+
5. **Set Log Environment** — Select **Production**, **Preview**, or both. At least one is required.
50+
51+
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%).
52+
53+
After you 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.
54+
55+
**Note:** Vercel Log Drains and Trace Drains are billed by Vercel. See the Vercel documentation for [Log Drains][10] and [Trace Drains][13].
4556

4657
## Data Collected
4758

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

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

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

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.
79+
## Troubleshooting
6780

81+
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.
6882

6983
Need help? Contact [Datadog support][8].
7084

@@ -78,9 +92,10 @@ Need help? Contact [Datadog support][8].
7892
[4]: https://vercel.com/docs/serverless-functions/introduction
7993
[5]: https://docs.datadoghq.com/logs/
8094
[6]: https://docs.datadoghq.com/synthetics/
81-
[7]: /setup/vercel
95+
[7]: https://vercel.com/marketplace/datadog
8296
[8]: https://docs.datadoghq.com/help/
8397
[9]: https://vercel.com/docs/functions
84-
[10]: https://vercel.com/docs/observability/log-drains
98+
[10]: https://vercel.com/docs/drains/reference/logs
8599
[11]: https://github.com/DataDog/integrations-extras/blob/master/vercel/metadata.csv
86-
[12]: https://vercel.com/docs/observability/otel-overview#initialize-otel
100+
[12]: https://vercel.com/docs/tracing/instrumentation
101+
[13]: https://vercel.com/docs/drains/reference/traces

0 commit comments

Comments
 (0)