Skip to content

Commit 07300aa

Browse files
AbhiPrasadAbhiPrasad
authored
feat: Document exporting from OTLP from shopify hydrogen storefronts (#15534)
<!-- Use this checklist to make sure your PR is ready for merge. You may delete any sections you don't need. --> ## DESCRIBE YOUR PR Documents our support of https://shopify.dev/docs/storefronts/headless/hydrogen/trace-exports via OTLP. Also cleans up `description` for some of the other drain docs. ## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs to go live. - [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE --> - [ ] Other deadline: <!-- ENTER DATE HERE --> - [x] None: Not urgent, can wait up to 1 week+ ## SLA - Teamwork makes the dream work, so please add a reviewer to your PRs. - Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it. Thanks in advance for your help! ## PRE-MERGE CHECKLIST *Make sure you've checked the following before merging your changes:* - [ ] Checked Vercel preview for correctness, including links - [ ] PR was reviewed and approved by any necessary SMEs (subject matter experts) - [ ] PR was reviewed and approved by a member of the [Sentry docs team](https://github.com/orgs/getsentry/teams/docs) ## LEGAL BOILERPLATE <!-- Sentry employees and contractors can delete or ignore this section. --> Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms. ## EXTRA RESOURCES - [Sentry Docs contributor guide](https://docs.sentry.io/contributing/)
1 parent cdb7d13 commit 07300aa

File tree

5 files changed

+41
-4
lines changed

5 files changed

+41
-4
lines changed

‎docs/product/drains/index.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,4 @@ To send data to Sentry, we recommend using the Sentry SDKs. However we also supp
1616
- [Cloudflare](/product/drains/integration/cloudflare/)
1717
- [Heroku](/product/drains/integration/heroku/)
1818
- [Supabase](/product/drains/integration/supabase/)
19+
- [Shopify Hydrogen](/product/drains/integration/shopify-hydrogen/)

‎docs/product/drains/integration/cloudflare.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Cloudflare Workers Observability
33
sidebar_order: 40
4-
description: Learn how to set up Cloudflare Workers Observability to send forward logs and traces data to Sentry.
4+
description: Learn how to set up Cloudflare Workers Observability to forward logs and traces data to Sentry.
55
---
66

77
Cloudflare Workers supports [exporting OpenTelemetry (OTEL)-compliant](https://developers.cloudflare.com/workers/observability/exporting-opentelemetry-data/) to send logs and traces to Sentry.

‎docs/product/drains/integration/heroku.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Heroku Telemetry Drains
33
sidebar_order: 60
4-
description: Learn how to set up Heroku Telemetry Drains to send forward logs and traces data to Sentry.
4+
description: Learn how to set up Heroku Telemetry Drains to forward logs and traces data to Sentry.
55
---
66

77
Heroku Telemetry supports [exporting OpenTelemetry (OTEL)-compliant](https://devcenter.heroku.com/articles/heroku-telemetry) to send logs and traces to Sentry. Sending metrics is not supported yet.

‎docs/product/drains/integration/shopify-hydrogen.mdx‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: Shopify Hydrogen Drains
3+
sidebar_order: 80
4+
description: Learn how to set up Shopify trace exports to forward trace data from your Hydrogen apps to Sentry.
5+
---
6+
7+
[Shopify Hydrogen trace exports](https://shopify.dev/docs/storefronts/headless/hydrogen/trace-exports) let you send a sample of your request traces to Sentry via the OpenTelemetry (OTLP) format.
8+
9+
## Prerequisites
10+
11+
Before you begin, ensure you have:
12+
13+
- A Shopify Hydrogen app you want to monitor
14+
- A Sentry project you want to send data to
15+
16+
## Trace Drains
17+
18+
Go through the following steps to
19+
20+
1. From your Shopify admin, under **Sales channels**, click **Hydrogen**.
21+
2. On the **Hydrogen storefront page**, click **Storefront settings**.
22+
3. On the **Storefront settings page**, click **Integrations**.
23+
4. On the **Integrations settings** page, click **Connect an observability drain** and select **HTTP**.
24+
5. Under the trace export endpoint URL field add the Sentry OTLP traces endpoint in the URL field. You can find the endpoint in your [Sentry Project Settings](https://sentry.io/settings/projects/) under **Client Keys (DSN)** > **OpenTelemetry (OTLP)** under the **OTLP Traces Endpoint** section.
25+
26+
```bash
27+
___OTLP_TRACES_URL___
28+
```
29+
30+
6. Add the Sentry Authentication Header under the authentication headers section. You'll also find the header value in your [Sentry Project Settings](https://sentry.io/settings/projects/) under **Client Keys (DSN)** > **OpenTelemetry (OTLP)** under the **OTLP Traces Endpoint Headers** section.
31+
32+
```
33+
x-sentry-auth: sentry sentry_key=___PUBLIC_KEY___
34+
```
35+
36+
7. Click **Save** to save your configuration. After you save the configuration, sampled traces start flowing to Sentry. It may take a few minutes, and you'll need to generate traffic on your storefront before traces appear.

‎docs/product/drains/integration/vercel.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Vercel Drains
33
sidebar_order: 50
4-
description: Learn how to set up Vercel drains to send forward logs and traces data to Sentry.
4+
description: Learn how to set up Vercel drains to forward logs and traces data to Sentry.
55
---
66

77
Vercel Drains let you forward traces and logs from applications running on Vercel to Sentry.
@@ -71,7 +71,7 @@ After selecting the Traces data type, you'll need to configure the drain to send
7171

7272
1. Provide a name for your drain and select which projects should send data to your endpoint. You can choose all projects or select specific ones.
7373
2. Configure the sampling rate to control the volume of data sent to your drain. We recommend sampling 100% of the data to ensure you get all the data you need.
74-
3. Under the custom endpoint tab add the Sentry Vercel Log Drain Endpoint in the URL field. You can find the endpoint in your [Sentry Project Settings](https://sentry.io/settings/projects/) under **Client Keys (DSN)** > **OpenTelemetry (OTLP)** under the **OTLP Traces Endpoint** section.
74+
3. Under the custom endpoint tab add the Sentry Vercel Trace Drain Endpoint in the URL field. You can find the endpoint in your [Sentry Project Settings](https://sentry.io/settings/projects/) under **Client Keys (DSN)** > **OpenTelemetry (OTLP)** under the **OTLP Traces Endpoint** section.
7575

7676
```bash
7777
___OTLP_TRACES_URL___

0 commit comments

Comments
 (0)