-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
feat: Document exporting from OTLP from shopify hydrogen storefronts #15534
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+41
−4
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| --- | ||
| title: Shopify Hydrogen Drains | ||
| sidebar_order: 50 | ||
| description: Learn how to set up Shopify trace exports to forward trace data from your Hydrogen apps to Sentry. | ||
| --- | ||
|
|
||
| [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. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| Before you begin, ensure you have: | ||
|
|
||
| - A Shopify Hydrogen app you want to monitor | ||
| - A Sentry project you want to send data to | ||
|
|
||
| ## Trace Drains | ||
|
|
||
| Go through the following steps to | ||
|
|
||
| 1. From your Shopify admin, under **Sales channels**, click **Hydrogen**. | ||
| 2. On the **Hydrogen storefront page**, click **Storefront settings**. | ||
| 3. On the **Storefront settings page**, click **Integrations**. | ||
| 4. On the **Integrations settings** page, click **Connect an observability drain** and select **HTTP**. | ||
| 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. | ||
|
|
||
| ```bash | ||
| ___OTLP_TRACES_URL___ | ||
| ``` | ||
|
|
||
| 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. | ||
|
|
||
| ``` | ||
| x-sentry-auth: sentry sentry_key=___PUBLIC_KEY___ | ||
| ``` | ||
|
|
||
| 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. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.