From 07c3df49ee7d09751d3ef0cac3f4c851a12b7fce Mon Sep 17 00:00:00 2001 From: Surya Prashanth Date: Wed, 17 Sep 2025 17:49:00 +0530 Subject: [PATCH 1/4] feat: add sentry integration docs --- docs/integrations/about.mdx | 3 + docs/integrations/sentry.mdx | 113 +++++++++++++++++++++++++++++++++++ sidebars.ts | 23 +++++-- 3 files changed, 135 insertions(+), 4 deletions(-) create mode 100644 docs/integrations/sentry.mdx diff --git a/docs/integrations/about.mdx b/docs/integrations/about.mdx index 7635fe2..8d5137f 100644 --- a/docs/integrations/about.mdx +++ b/docs/integrations/about.mdx @@ -21,4 +21,7 @@ Plane's integrations make it easy to connect your workspace and projects with yo Connect GitLab to Plane to automate merge request tracking, link issues seamlessly, and streamline your development workflow. + + Connect Sentry to Plane to automatically create work items from Sentry issues, sync issue states, and streamline your error tracking workflow. + diff --git a/docs/integrations/sentry.mdx b/docs/integrations/sentry.mdx new file mode 100644 index 0000000..1eb4fcf --- /dev/null +++ b/docs/integrations/sentry.mdx @@ -0,0 +1,113 @@ +--- +title: Sentry +hide_title: true +description: Integrate Plane with Sentry to automatically create work items from Sentry issues, sync issue states, and streamline your error tracking workflow. +--- + +import Tags from "@site/src/components/Tags"; + +
+

Integrate with Sentry

+ +
+ +Integrating Sentry with Plane allows your team to automatically create work items from Sentry issues and keep your error tracking workflow streamlined. Whether you're syncing issue states, creating work items from errors, or collaborating on bug fixes, this integration brings the power of Sentry and Plane together for a more connected development workflow. + +This guide will walk you through how to set up and connect your Sentry account to Plane. + +## Set up Sentry integration + +Follow the steps below to complete the setup: + +1. [Connect your Sentry account](/integrations/sentry#connect-sentry-account) +2. [Setup State Mapping](/integrations/sentry#setup-state-mapping) + +### Connect your Sentry account + +To get started, you need to connect your Sentry account to Plane. + +![Connect Sentry](https://media.docs.plane.so/integrations/sentry/connect-sentry.webp#center) + +1. Navigate to [Workspace Settings](/core-concepts/workspaces/overview#workspace-settings) in Plane. +2. On the right pane, select **Integrations**. +3. Find the **Sentry** integration and click **Configure**. +4. Click the **Install** button. This will redirect you to Sentry's authentication page. Sentry will ask you to review the permissions it needs to integrate with Plane. Make sure to allow them. +5. After allowing permissions, you'll be redirected back to Plane. You should now see that your Sentry account is successfully connected. + +That's it! Your Sentry account is now integrated with Plane. + +### Setup State Mapping + +Map Sentry issue states to your project states. Configure which states to use when a Sentry issue is resolved or unresolved. + +![State Mapping](https://media.docs.plane.so/integrations/sentry/state-mapping.webp#center) + +1. In the **Sentry** integration settings, find the **State Mapping** section. +2. Select the Plane project you want to sync Sentry issues to. +3. Configure how Sentry issue states should map to Plane project states: + - **Unresolved** → Select the appropriate Plane project status (e.g., "Open" or "In Progress") + - **Resolved** → Select the appropriate Plane project status (e.g., "Done" or "Closed") +4. Click **Save** to apply your state mapping configuration. + +:::info +State mapping ensures that when Sentry issues are automatically synced to Plane, they appear with the correct status. You can always modify these mappings later if your workflow changes. +::: + +## Use the Sentry integration + +Now that Sentry is connected to your Plane workspace, we can resolve Sentry issues from Plane and vice versa. + +### Set up Sentry alerts + +In Sentry alerts, users can setup an action to auto create a work item in Plane when trigger and conditions are met. + +![Sentry Alert Setup](https://media.docs.plane.so/integrations/sentry/sentry-alert-setup.webp#center) + +1. Navigate to your Sentry project settings. +2. Go to **Alerts** and click **Create Alert Rule**. +3. Select environment and project. +4. Setup conditions to filter the alerts (e.g., error rate threshold, issue frequency, etc.). +5. Create an action to create a Plane work item. +6. Click **Settings** and open the modal to configure the properties on work item that will be created on Plane like priority, assignee, etc. +7. Save your alert rule. + +:::info +Once configured, Sentry will automatically create work items in your selected Plane project whenever the alert conditions are met. This ensures that critical errors are immediately tracked and assigned to your development team. +::: + +### Link Sentry issues to Plane work items + +On a Sentry issue, you can use Makeplane in the "Issue Tracking" section to link the current issue to a Plane work item. This will start a bi-directional sync with Plane work items. + +![Link Sentry Issue](https://media.docs.plane.so/integrations/sentry/link-sentry-issue.webp#center) + +1. Navigate to any Sentry issue in your project. +2. Scroll down to the **Issue Tracking** section. +3. Click on **Makeplane** to link this issue to a Plane work item. +4. Search for and select the existing Plane work item you want to link, or create a new one. +5. Click **Save Changes** to establish the connection. + +Once linked, the Sentry issue and Plane work item will sync bi-directionally: +- If the issue is resolved on Sentry, it will be closed on Plane +- If the work item is marked as done on Plane, it will be resolved on Sentry + +:::info +This bi-directional sync keeps your error tracking and project management in perfect alignment, ensuring that issue resolution status is consistent across both platforms. +::: + +### Update work item status from Plane + +Once the state on a work item is moved to the resolved state specified during state mapping, the Sentry issue will get automatically resolved. + +![Update Work Item Status](https://media.docs.plane.so/integrations/sentry/update-work-item-status.webp#center) + +1. Navigate to the linked work item in Plane. +2. Change the work item state to the resolved state you configured during state mapping. +3. The Sentry issue will automatically be marked as resolved. + +If the status is changed back to the unresolved state of your Sentry mapping, it will mark the Sentry issue as "unresolved" as well. + +:::info +This automatic status synchronization works both ways - changes in Plane reflect in Sentry, and changes in Sentry reflect in Plane, keeping your error tracking and project management perfectly synchronized. +::: + diff --git a/sidebars.ts b/sidebars.ts index 09780a0..a88fde5 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -124,7 +124,7 @@ const sidebars: SidebarsConfig = { "core-concepts/pages/nested-pages", ], }, - + { type: "category", collapsed: false, @@ -136,15 +136,30 @@ const sidebars: SidebarsConfig = { type: "category", collapsed: false, label: "Importers", - items: ["importers/overview", "importers/asana", "importers/confluence", "importers/clickup","importers/csv", "importers/jira", "importers/linear", "importers/notion" ], + items: [ + "importers/overview", + "importers/asana", + "importers/confluence", + "importers/clickup", + "importers/csv", + "importers/jira", + "importers/linear", + "importers/notion", + ], }, { type: "category", collapsed: false, label: "Integrations", - items: ["integrations/about", "integrations/github", "integrations/slack", "integrations/gitlab"], + items: [ + "integrations/about", + "integrations/github", + "integrations/slack", + "integrations/gitlab", + "integrations/sentry", + ], }, - /* { + /* { type: "category", collapsed: false, label: "Performance", From 4632ddd96e82ed0034bd7922023855ab0791d0d2 Mon Sep 17 00:00:00 2001 From: Surya Prashanth Date: Wed, 17 Sep 2025 18:23:42 +0530 Subject: [PATCH 2/4] add images in the sentry docs --- docs/integrations/sentry.mdx | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/docs/integrations/sentry.mdx b/docs/integrations/sentry.mdx index 1eb4fcf..705f98f 100644 --- a/docs/integrations/sentry.mdx +++ b/docs/integrations/sentry.mdx @@ -26,7 +26,7 @@ Follow the steps below to complete the setup: To get started, you need to connect your Sentry account to Plane. -![Connect Sentry](https://media.docs.plane.so/integrations/sentry/connect-sentry.webp#center) +![Connect Sentry](https://media.docs.plane.so/sentry/sentry_install.png#center) 1. Navigate to [Workspace Settings](/core-concepts/workspaces/overview#workspace-settings) in Plane. 2. On the right pane, select **Integrations**. @@ -40,8 +40,6 @@ That's it! Your Sentry account is now integrated with Plane. Map Sentry issue states to your project states. Configure which states to use when a Sentry issue is resolved or unresolved. -![State Mapping](https://media.docs.plane.so/integrations/sentry/state-mapping.webp#center) - 1. In the **Sentry** integration settings, find the **State Mapping** section. 2. Select the Plane project you want to sync Sentry issues to. 3. Configure how Sentry issue states should map to Plane project states: @@ -49,6 +47,10 @@ Map Sentry issue states to your project states. Configure which states to use wh - **Resolved** → Select the appropriate Plane project status (e.g., "Done" or "Closed") 4. Click **Save** to apply your state mapping configuration. +![State Mapping](https://media.docs.plane.so/sentry/sentry_project_mapping.png) + +![Post State Mapping](https://media.docs.plane.so/sentry/sentry_config.png) + :::info State mapping ensures that when Sentry issues are automatically synced to Plane, they appear with the correct status. You can always modify these mappings later if your workflow changes. ::: @@ -61,7 +63,8 @@ Now that Sentry is connected to your Plane workspace, we can resolve Sentry issu In Sentry alerts, users can setup an action to auto create a work item in Plane when trigger and conditions are met. -![Sentry Alert Setup](https://media.docs.plane.so/integrations/sentry/sentry-alert-setup.webp#center) +![Sentry Alert Setup](https://media.docs.plane.so/sentry/create_issue_alert.png) +![Sentry Plane Sync Modal](https://media.docs.plane.so/sentry/create_workitem_modal.png) 1. Navigate to your Sentry project settings. 2. Go to **Alerts** and click **Create Alert Rule**. @@ -79,14 +82,16 @@ Once configured, Sentry will automatically create work items in your selected Pl On a Sentry issue, you can use Makeplane in the "Issue Tracking" section to link the current issue to a Plane work item. This will start a bi-directional sync with Plane work items. -![Link Sentry Issue](https://media.docs.plane.so/integrations/sentry/link-sentry-issue.webp#center) - 1. Navigate to any Sentry issue in your project. 2. Scroll down to the **Issue Tracking** section. 3. Click on **Makeplane** to link this issue to a Plane work item. 4. Search for and select the existing Plane work item you want to link, or create a new one. 5. Click **Save Changes** to establish the connection. +![Link Sentry Issue](https://media.docs.plane.so/sentry/issue_tracking.png) +![Create / Link Work Item](https://media.docs.plane.so/sentry/create_link.png) + + Once linked, the Sentry issue and Plane work item will sync bi-directionally: - If the issue is resolved on Sentry, it will be closed on Plane - If the work item is marked as done on Plane, it will be resolved on Sentry @@ -99,8 +104,6 @@ This bi-directional sync keeps your error tracking and project management in per Once the state on a work item is moved to the resolved state specified during state mapping, the Sentry issue will get automatically resolved. -![Update Work Item Status](https://media.docs.plane.so/integrations/sentry/update-work-item-status.webp#center) - 1. Navigate to the linked work item in Plane. 2. Change the work item state to the resolved state you configured during state mapping. 3. The Sentry issue will automatically be marked as resolved. From 899fe37bade9085977509bc32f97efe194a85d5b Mon Sep 17 00:00:00 2001 From: Surya Prashanth Date: Wed, 17 Sep 2025 18:26:06 +0530 Subject: [PATCH 3/4] fix links --- docs/integrations/sentry.mdx | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/integrations/sentry.mdx b/docs/integrations/sentry.mdx index 705f98f..9fbfdfb 100644 --- a/docs/integrations/sentry.mdx +++ b/docs/integrations/sentry.mdx @@ -19,8 +19,10 @@ This guide will walk you through how to set up and connect your Sentry account t Follow the steps below to complete the setup: -1. [Connect your Sentry account](/integrations/sentry#connect-sentry-account) -2. [Setup State Mapping](/integrations/sentry#setup-state-mapping) +1. [Connect your Sentry account](/integrations/sentry#connect-your-sentry-account) +2. [Set up State Mapping](/integrations/sentry#set-up-state-mapping) +3. [Set up Sentry alerts](/integrations/sentry#set-up-sentry-alerts) +4. [Link Sentry issues to Plane work items](/integrations/sentry#link-sentry-issues-to-plane-work-items) ### Connect your Sentry account @@ -36,7 +38,7 @@ To get started, you need to connect your Sentry account to Plane. That's it! Your Sentry account is now integrated with Plane. -### Setup State Mapping +### Set up State Mapping Map Sentry issue states to your project states. Configure which states to use when a Sentry issue is resolved or unresolved. From a5941f134c9406e02736b0a6259bb812fb4b6555 Mon Sep 17 00:00:00 2001 From: Surya Prashanth Date: Wed, 17 Sep 2025 19:03:03 +0530 Subject: [PATCH 4/4] minor text changes --- docs/integrations/sentry.mdx | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/docs/integrations/sentry.mdx b/docs/integrations/sentry.mdx index 9fbfdfb..8adea72 100644 --- a/docs/integrations/sentry.mdx +++ b/docs/integrations/sentry.mdx @@ -20,9 +20,7 @@ This guide will walk you through how to set up and connect your Sentry account t Follow the steps below to complete the setup: 1. [Connect your Sentry account](/integrations/sentry#connect-your-sentry-account) -2. [Set up State Mapping](/integrations/sentry#set-up-state-mapping) -3. [Set up Sentry alerts](/integrations/sentry#set-up-sentry-alerts) -4. [Link Sentry issues to Plane work items](/integrations/sentry#link-sentry-issues-to-plane-work-items) +2. [Set up Resolution States](/integrations/sentry#set-up-resolution-states) ### Connect your Sentry account @@ -38,9 +36,9 @@ To get started, you need to connect your Sentry account to Plane. That's it! Your Sentry account is now integrated with Plane. -### Set up State Mapping +### Set up Resolution States -Map Sentry issue states to your project states. Configure which states to use when a Sentry issue is resolved or unresolved. +Select resolution states for Sentry issues. Configure which states to use when a Sentry issue is resolved or unresolved and vice versa. 1. In the **Sentry** integration settings, find the **State Mapping** section. 2. Select the Plane project you want to sync Sentry issues to. @@ -54,7 +52,7 @@ Map Sentry issue states to your project states. Configure which states to use wh ![Post State Mapping](https://media.docs.plane.so/sentry/sentry_config.png) :::info -State mapping ensures that when Sentry issues are automatically synced to Plane, they appear with the correct status. You can always modify these mappings later if your workflow changes. +State mapping ensures that when Sentry issues are automatically synced to Plane, they appear with the correct state. You can always modify these mappings later if your workflow changes. ::: ## Use the Sentry integration @@ -82,7 +80,7 @@ Once configured, Sentry will automatically create work items in your selected Pl ### Link Sentry issues to Plane work items -On a Sentry issue, you can use Makeplane in the "Issue Tracking" section to link the current issue to a Plane work item. This will start a bi-directional sync with Plane work items. +On a Sentry issue, you can use Makeplane in the "Issue Tracking" section to link the current issue to a Plane work item. This will start a bi-directional state sync between Sentry issues and Plane work items. 1. Navigate to any Sentry issue in your project. 2. Scroll down to the **Issue Tracking** section. @@ -95,8 +93,8 @@ On a Sentry issue, you can use Makeplane in the "Issue Tracking" section to link Once linked, the Sentry issue and Plane work item will sync bi-directionally: -- If the issue is resolved on Sentry, it will be closed on Plane -- If the work item is marked as done on Plane, it will be resolved on Sentry +- If the issue is resolved on Sentry, it will be closed on Plane. +- If the work item is marked as done on Plane, it will be resolved on Sentry. :::info This bi-directional sync keeps your error tracking and project management in perfect alignment, ensuring that issue resolution status is consistent across both platforms.