diff --git a/docs/organization/integrations/deployment/vercel/index.mdx b/docs/organization/integrations/deployment/vercel/index.mdx index 905b4c6651f10..36c2f69db5391 100644 --- a/docs/organization/integrations/deployment/vercel/index.mdx +++ b/docs/organization/integrations/deployment/vercel/index.mdx @@ -1,9 +1,11 @@ --- title: Vercel sidebar_order: 1 -description: "Learn more about Sentry's Vercel integration and how you can sync release deployments and source map uploads." +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." --- +## Releases and Source Map Integration + 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 Connect your Sentry and Vercel projects to automatically notify Sentry of every deployment and upload source maps for your Next.js application. To learn more about using Sentry in your Next.js app, check out the [Next.js SDK](/platforms/javascript/guides/nextjs/). -## Install +### Install @@ -35,11 +37,11 @@ Sentry owner, manager, or admin permissions are required to install this integra ![Sentry modal showing Vercel internal integration](./img/vercel_internal_integration.png) -## Configure +### Configure Use Vercel to [link projects](#project-linking) for uploading source maps and notifiying Sentry of release deployment. -### Project Linking +#### Project Linking 1. When prompted by the installer, select a Sentry project and a Vercel project to link together. @@ -56,14 +58,14 @@ Use Vercel to [link projects](#project-linking) for uploading source maps and no 2. Redeploy your Vercel project in order to trigger a release. -## Usage +### Usage - If you have not already done so, [instrument your code with Sentry](/platforms/javascript/). - Ensure you have [installed a repository integration](/product/releases/setup/release-automation/) and added the relevant repository. - 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. - 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. -## Uninstallation +### Uninstallation 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. @@ -71,10 +73,51 @@ Use Vercel to [link projects](#project-linking) for uploading source maps and no ![Sentry modal showing uninstalling Vercel integration](./img/vercel_delete_internal_integration.png) -## Troubleshooting +### Troubleshooting -### Failed to fetch +#### Failed to fetch ![Failed to fetch error message](./img/vercel_failed_to_fetch.png) 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. + +## Vercel Marketplace + +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. + +There is no path for existing Sentry organizations to use the Vercel Marketplace integration. + +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. + +### Billing Settings + +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. + +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. + +### User Access + +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. + +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. + +### Automatically Configured Environment Variables + +For every project configured, the following environment variables will be set within the Vercel deployment: + +- **SENTRY_PROJECT** +- **SENTRY_AUTH_TOKEN** +- **NEXT_PUBLIC_SENTRY_DSN** +- **SENTRY_ORG** + +### Integration Deletion + +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**. + +Preserving the Sentry organization allows teams to still access historical data from within Sentry, even if they are not sending monitoring data anymore. + +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. + +For more information, see the [Introducing the Vercel Marketplace blog post](https://vercel.com/blog/introducing-the-vercel-marketplace). + +