Skip to content

Commit 9a37d5a

Browse files
authored
Vercel Native Marketplace integration docs (#13254)
* Adding content for the Vercel Marketplace integration * Minor language update * Clarifying billing informaiton * Clarifying sentry login
1 parent fcd73e9 commit 9a37d5a

File tree

1 file changed

+51
-8
lines changed
  • docs/organization/integrations/deployment/vercel

1 file changed

+51
-8
lines changed

docs/organization/integrations/deployment/vercel/index.mdx

Lines changed: 51 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
---
22
title: Vercel
33
sidebar_order: 1
4-
description: "Learn more about Sentry's Vercel integration and how you can sync release deployments and source map uploads."
4+
description: "Learn more about Sentry's Vercel integrations and how you can sync release deployments and source map uploads, as well as the Vercel Marketplace integration."
55
---
66

7+
## Releases and Source Map Integration
8+
79
<Alert level="warning">
810

911
If you make changes to your organization slug, you'll need to update your configuration for this integration. Learn more in our [troubleshooting guide](/organization/integrations/troubleshooting).
@@ -13,7 +15,7 @@ If you make changes to your organization slug, you'll need to update your config
1315
Connect your Sentry and Vercel projects to automatically notify Sentry of every deployment and upload source maps for your Next.js application.
1416
To learn more about using Sentry in your Next.js app, check out the [Next.js SDK](/platforms/javascript/guides/nextjs/).
1517

16-
## Install
18+
### Install
1719

1820
<Alert>
1921

@@ -35,11 +37,11 @@ Sentry owner, manager, or admin permissions are required to install this integra
3537

3638
![Sentry modal showing Vercel internal integration](./img/vercel_internal_integration.png)
3739

38-
## Configure
40+
### Configure
3941

4042
Use Vercel to [link projects](#project-linking) for uploading source maps and notifiying Sentry of release deployment.
4143

42-
### Project Linking
44+
#### Project Linking
4345

4446
1. When prompted by the installer, select a Sentry project and a Vercel project to link together.
4547

@@ -56,25 +58,66 @@ Use Vercel to [link projects](#project-linking) for uploading source maps and no
5658

5759
2. Redeploy your Vercel project in order to trigger a release.
5860

59-
## Usage
61+
### Usage
6062

6163
- If you have not already done so, [instrument your code with Sentry](/platforms/javascript/).
6264
- Ensure you have [installed a repository integration](/product/releases/setup/release-automation/) and added the relevant repository.
6365
- Add a Sentry bundler plugin to your bundler configuration ([webpack plugin](https://www.npmjs.com/package/@sentry/webpack-plugin), [Vite Plugin](https://www.npmjs.com/package/@sentry/vite-plugin), [Esbuild Plugin](https://www.npmjs.com/package/@sentry/esbuild-plugin), [Rollup Plugin](https://www.npmjs.com/package/@sentry/rollup-plugin)). If you are using Sentry's Next.js, or SvelteKit SDKs this will already have been done for you.
6466
- In case you already have a Vercel project integrated with Sentry, ensure the Sentry project you link is the one you're already using to report errors.
6567

66-
## Uninstallation
68+
### Uninstallation
6769

6870
1. You can uninstall the integration from Vercel or Sentry. To do so in Sentry, navigate to **Settings > Integrations > Vercel > Configurations**, click "Uninstall", and confirm.
6971

7072
2. Delete the internal integration that was created by navigating to **Settings > Developer Settings** and clicking the trash can icon next to "Vercel Internal Integration". You will be prompted to confirm the deletion by entering a string provided in the modal. Enter the string and click "Confirm" to finalize the deletion:
7173

7274
![Sentry modal showing uninstalling Vercel integration](./img/vercel_delete_internal_integration.png)
7375

74-
## Troubleshooting
76+
### Troubleshooting
7577

76-
### Failed to fetch
78+
#### Failed to fetch
7779

7880
![Failed to fetch error message](./img/vercel_failed_to_fetch.png)
7981

8082
This issue typically occurs if you have an ad blocker blocking the conversation between Vercel and Sentry during setup. To remediate the issue, disable your ad blocker and go through the installation flow again.
83+
84+
## Vercel Marketplace
85+
86+
The Vercel Marketplace integration allows existing Vercel users to onboard to Sentry with a one-click workflow. This setup is designed for **new Sentry users** and unifies billing within the Vercel platform.
87+
88+
There is no path for existing Sentry organizations to use the Vercel Marketplace integration.
89+
90+
When you configure Sentry using the Vercel Marketplace, you'll be able to set the name of your new Sentry Organization (referred to as an "Installation" in Vercel) and projects (Resources/Products in Vercel) during the setup process.
91+
92+
### Billing Settings
93+
94+
When using the Vercel Marketplace native integration, users can modify their organizations billing information from within the Vercel platform, or within Sentry directly. Credit card settings can only be modified within Vercel.
95+
96+
Subscription settings can only be modified within Sentry. During setup, organizations can choose between Team or Business plans. Pay-as-you-go budgets can be set after the initial setup is completed.
97+
98+
### User Access
99+
100+
Vercel users will have single sign-on access to Sentry using the "Open in Sentry" button within Vercel, and will be able to create new projects in either Vercel or Sentry.
101+
102+
Users will still be able to login to their Sentry organization directly, without using the Vercel single-sign on, by using the login they configured during the setup process. For non social based login (Google, Github, etc.) users, Sentry will prompt for password creation.
103+
104+
### Automatically Configured Environment Variables
105+
106+
For every project configured, the following environment variables will be set within the Vercel deployment:
107+
108+
- **SENTRY_PROJECT**
109+
- **SENTRY_AUTH_TOKEN**
110+
- **NEXT_PUBLIC_SENTRY_DSN**
111+
- **SENTRY_ORG**
112+
113+
### Integration Deletion
114+
115+
If the integration is deleted within Vercel, the Sentry organization **will not** be deleted. The deletion will permanently remove the connection between the Vercel account and the Sentry account, and is **irreversible**.
116+
117+
Preserving the Sentry organization allows teams to still access historical data from within Sentry, even if they are not sending monitoring data anymore.
118+
119+
If the native integration is deleted, teams are still able to leverage the non-native Vercel integration described at the top of this document. Only one integration can be active at a time.
120+
121+
For more information, see the [Introducing the Vercel Marketplace blog post](https://vercel.com/blog/introducing-the-vercel-marketplace).
122+
123+

0 commit comments

Comments
 (0)