[vercel_otel] new vercel content pack - #20387
Conversation
Elastic Docs Style Checker (Vale)Summary: 1 warning found
|
| File | Line | Rule | Message |
|---|---|---|---|
| packages/vercel_otel/docs/README.md | 73 | Elastic.DontUse | Don't use 'and/or'. |
The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale.
|
In the logs dashboard, I think it will be good to have a filter for log.source @jakubgalecki0 |
Added filter
|
|
I see us mentoning the endpoint as managed OTLP endpoint. |
| Setup has three parts, done in order: | ||
|
|
||
| 1. Enable the Vercel features you want to collect. | ||
| 2. Gather two values from Elastic: a **drain URL** and an **API key**. |
There was a problem hiding this comment.
| 2. Gather two values from Elastic: a **drain URL** and an **API key**. | |
| 2. Gather two values from Elastic: a **managed endpoint URL** and an **API key**. |
| - **Web Analytics**: install and enable the [@vercel/analytics](https://vercel.com/docs/analytics) SDK in your application so page views and custom events are emitted. | ||
| - **Speed Insights**: install and enable the [@vercel/speed-insights](https://vercel.com/docs/speed-insights) SDK in your application so Web Vitals are collected in the browser. | ||
|
|
||
| ### Step 2: Gather the drain URL and API key from Elastic |
There was a problem hiding this comment.
| ### Step 2: Gather the drain URL and API key from Elastic | |
| ### Step 2: Gather the managed endpoint URL and API key from Elastic |
|
|
||
| You need an Elastic Cloud Serverless project or an Elastic Cloud Hosted deployment. | ||
|
|
||
| #### Drain URL |
There was a problem hiding this comment.
| #### Drain URL | |
| #### Managed Endpoint URL for Vercel |
|
|
||
| 1. Log in to the [Elastic Cloud Console](https://cloud.elastic.co/). | ||
| 2. Open your project or deployment and select **Manage**. | ||
| 3. In **Application endpoints, cluster and component IDs**, select **OpenTelemetry** (Serverless projects) or **Managed OTLP** (Hosted deployments), then copy the public endpoint value. |
There was a problem hiding this comment.
| 3. In **Application endpoints, cluster and component IDs**, select **OpenTelemetry** (Serverless projects) or **Managed OTLP** (Hosted deployments), then copy the public endpoint value. | |
| 3. In **Application endpoints, cluster and component IDs**, select the Vercel endpoint, then copy the public endpoint value. |
The vercel endpoint will be added to the application endpoints
| 2. Open your project or deployment and select **Manage**. | ||
| 3. In **Application endpoints, cluster and component IDs**, select **OpenTelemetry** (Serverless projects) or **Managed OTLP** (Hosted deployments), then copy the public endpoint value. | ||
|
|
||
| The drain URL is that public endpoint plus `/vercel`, which is the path that accepts Vercel drain payloads: |
There was a problem hiding this comment.
| The drain URL is that public endpoint plus `/vercel`, which is the path that accepts Vercel drain payloads: | |
| The managed endpoint URL for Vercel is that public endpoint plus `/vercel`, which is the path that accepts Vercel drain payloads: |
| https://<managed-endpoint>/vercel | ||
| ``` | ||
|
|
||
| For example, if your public endpoint is `https://abc123.ingest.us-east-1.aws.elastic.cloud`, then the drain URL is: |
There was a problem hiding this comment.
| For example, if your public endpoint is `https://abc123.ingest.us-east-1.aws.elastic.cloud`, then the drain URL is: | |
| For example, if your public endpoint is `https://abc123.ingest.us-east-1.aws.elastic.cloud`, then the managed endpoint URL for vercel is: |
|
|
||
| 1. Open your team **Drains** settings and create a drain for that data type. | ||
| 2. Choose **Custom Endpoint** as the destination. | ||
| 3. Set the **Endpoint URL** to the drain URL, for example `https://abc123.ingest.us-east-1.aws.elastic.cloud/vercel`. |
There was a problem hiding this comment.
| 3. Set the **Endpoint URL** to the drain URL, for example `https://abc123.ingest.us-east-1.aws.elastic.cloud/vercel`. | |
| 3. Set the **Endpoint URL** to the managed endpoint URL for Vercel, for example `https://abc123.ingest.us-east-1.aws.elastic.cloud/vercel`. |
|
|
||
| For Logs drains, you can also narrow which sources, environments, and sampling rates are forwarded under **Additional configuration for logs**. Refer to [Log Drains reference](https://vercel.com/docs/drains/reference/logs). | ||
|
|
||
| > **Note**: The drain URL is always your Elastic Cloud public endpoint plus `/vercel`. Do not point the drain at a self-hosted collector for these assets; the supported path is the Elastic Cloud managed endpoint. |
There was a problem hiding this comment.
| > **Note**: The drain URL is always your Elastic Cloud public endpoint plus `/vercel`. Do not point the drain at a self-hosted collector for these assets; the supported path is the Elastic Cloud managed endpoint. | |
| > **Note**: The managed endpoint URL for Vercel is always your Elastic Cloud public endpoint plus `/vercel`. Do not point the drain at a self-hosted collector for these assets; the supported path is the Elastic Cloud managed endpoint. |
| ## Reference | ||
|
|
||
| Vercel drain payloads are decoded by the Elastic Cloud managed endpoint and written to the data streams below. For drain configuration and payload types on the Vercel side, see [Using drains](https://vercel.com/docs/drains/using-drains). For managed endpoint behavior, see [Managed inputs](https://www.elastic.co/docs/reference/opentelemetry/managed-inputs). | ||
|
|
There was a problem hiding this comment.
@jakubgalecki0 : Can we point to a place where the fields (for meterics and logs) are documented ?
|
Thanks for making the changes @jakubgalecki0 Also update the web analytics screenshot in the PR. it still shows decimal values |
ishleenk17
left a comment
There was a problem hiding this comment.
Please update the screenshots in the img folder to showcase the latest changes.
Else looks good now!
|
Queued — the merge queue status continues in this comment ↓. |
Merge Queue Status
Waiting for
All conditions
|
|
✅ All changelog entries have the correct PR link. |
💚 Build Succeeded
History
|
|
Package vercel_otel - 0.1.0 containing this change is available at https://epr.elastic.co/package/vercel_otel/0.1.0/ |






Proposed commit message
Checklist
changelog.ymlfile.Author's Checklist
How to test this PR locally
Related issues
Screenshots