Skip to content

Commit 972df21

Browse files
feat: add sentry integration docs (#352)
* feat: add sentry integration docs * add images in the sentry docs * fix links * minor text changes
1 parent cc585fa commit 972df21

File tree

3 files changed

+138
-4
lines changed

3 files changed

+138
-4
lines changed

docs/integrations/about.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,7 @@ Plane's integrations make it easy to connect your workspace and projects with yo
2121
Connect GitLab to Plane to automate merge request tracking, link issues seamlessly, and streamline your development
2222
workflow.
2323
</Card>
24+
<Card title="Sentry" href="/integrations/sentry">
25+
Connect Sentry to Plane to automatically create work items from Sentry issues, sync issue states, and streamline your error tracking workflow.
26+
</Card>
2427
</CardGroup>

docs/integrations/sentry.mdx

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
---
2+
title: Sentry
3+
hide_title: true
4+
description: Integrate Plane with Sentry to automatically create work items from Sentry issues, sync issue states, and streamline your error tracking workflow.
5+
---
6+
7+
import Tags from "@site/src/components/Tags";
8+
9+
<div className="tag-wrapper">
10+
<h1>Integrate with Sentry</h1>
11+
<Tags tags={[{ name: "Pro", link: "https://plane.so/pricing", additionalClass: "pro" }]} />
12+
</div>
13+
14+
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.
15+
16+
This guide will walk you through how to set up and connect your Sentry account to Plane.
17+
18+
## Set up Sentry integration
19+
20+
Follow the steps below to complete the setup:
21+
22+
1. [Connect your Sentry account](/integrations/sentry#connect-your-sentry-account)
23+
2. [Set up Resolution States](/integrations/sentry#set-up-resolution-states)
24+
25+
### Connect your Sentry account
26+
27+
To get started, you need to connect your Sentry account to Plane.
28+
29+
![Connect Sentry](https://media.docs.plane.so/sentry/sentry_install.png#center)
30+
31+
1. Navigate to [Workspace Settings](/core-concepts/workspaces/overview#workspace-settings) in Plane.
32+
2. On the right pane, select **Integrations**.
33+
3. Find the **Sentry** integration and click **Configure**.
34+
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.
35+
5. After allowing permissions, you'll be redirected back to Plane. You should now see that your Sentry account is successfully connected.
36+
37+
That's it! Your Sentry account is now integrated with Plane.
38+
39+
### Set up Resolution States
40+
41+
Select resolution states for Sentry issues. Configure which states to use when a Sentry issue is resolved or unresolved and vice versa.
42+
43+
1. In the **Sentry** integration settings, find the **State Mapping** section.
44+
2. Select the Plane project you want to sync Sentry issues to.
45+
3. Configure how Sentry issue states should map to Plane project states:
46+
- **Unresolved** → Select the appropriate Plane project status (e.g., "Open" or "In Progress")
47+
- **Resolved** → Select the appropriate Plane project status (e.g., "Done" or "Closed")
48+
4. Click **Save** to apply your state mapping configuration.
49+
50+
![State Mapping](https://media.docs.plane.so/sentry/sentry_project_mapping.png)
51+
52+
![Post State Mapping](https://media.docs.plane.so/sentry/sentry_config.png)
53+
54+
:::info
55+
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.
56+
:::
57+
58+
## Use the Sentry integration
59+
60+
Now that Sentry is connected to your Plane workspace, we can resolve Sentry issues from Plane and vice versa.
61+
62+
### Set up Sentry alerts
63+
64+
In Sentry alerts, users can setup an action to auto create a work item in Plane when trigger and conditions are met.
65+
66+
![Sentry Alert Setup](https://media.docs.plane.so/sentry/create_issue_alert.png)
67+
![Sentry Plane Sync Modal](https://media.docs.plane.so/sentry/create_workitem_modal.png)
68+
69+
1. Navigate to your Sentry project settings.
70+
2. Go to **Alerts** and click **Create Alert Rule**.
71+
3. Select environment and project.
72+
4. Setup conditions to filter the alerts (e.g., error rate threshold, issue frequency, etc.).
73+
5. Create an action to create a Plane work item.
74+
6. Click **Settings** and open the modal to configure the properties on work item that will be created on Plane like priority, assignee, etc.
75+
7. Save your alert rule.
76+
77+
:::info
78+
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.
79+
:::
80+
81+
### Link Sentry issues to Plane work items
82+
83+
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.
84+
85+
1. Navigate to any Sentry issue in your project.
86+
2. Scroll down to the **Issue Tracking** section.
87+
3. Click on **Makeplane** to link this issue to a Plane work item.
88+
4. Search for and select the existing Plane work item you want to link, or create a new one.
89+
5. Click **Save Changes** to establish the connection.
90+
91+
![Link Sentry Issue](https://media.docs.plane.so/sentry/issue_tracking.png)
92+
![Create / Link Work Item](https://media.docs.plane.so/sentry/create_link.png)
93+
94+
95+
Once linked, the Sentry issue and Plane work item will sync bi-directionally:
96+
- If the issue is resolved on Sentry, it will be closed on Plane.
97+
- If the work item is marked as done on Plane, it will be resolved on Sentry.
98+
99+
:::info
100+
This bi-directional sync keeps your error tracking and project management in perfect alignment, ensuring that issue resolution status is consistent across both platforms.
101+
:::
102+
103+
### Update work item status from Plane
104+
105+
Once the state on a work item is moved to the resolved state specified during state mapping, the Sentry issue will get automatically resolved.
106+
107+
1. Navigate to the linked work item in Plane.
108+
2. Change the work item state to the resolved state you configured during state mapping.
109+
3. The Sentry issue will automatically be marked as resolved.
110+
111+
If the status is changed back to the unresolved state of your Sentry mapping, it will mark the Sentry issue as "unresolved" as well.
112+
113+
:::info
114+
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.
115+
:::
116+

sidebars.ts

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ const sidebars: SidebarsConfig = {
124124
"core-concepts/pages/nested-pages",
125125
],
126126
},
127-
127+
128128
{
129129
type: "category",
130130
collapsed: false,
@@ -136,15 +136,30 @@ const sidebars: SidebarsConfig = {
136136
type: "category",
137137
collapsed: false,
138138
label: "Importers",
139-
items: ["importers/overview", "importers/asana", "importers/confluence", "importers/clickup","importers/csv", "importers/jira", "importers/linear", "importers/notion" ],
139+
items: [
140+
"importers/overview",
141+
"importers/asana",
142+
"importers/confluence",
143+
"importers/clickup",
144+
"importers/csv",
145+
"importers/jira",
146+
"importers/linear",
147+
"importers/notion",
148+
],
140149
},
141150
{
142151
type: "category",
143152
collapsed: false,
144153
label: "Integrations",
145-
items: ["integrations/about", "integrations/github", "integrations/slack", "integrations/gitlab"],
154+
items: [
155+
"integrations/about",
156+
"integrations/github",
157+
"integrations/slack",
158+
"integrations/gitlab",
159+
"integrations/sentry",
160+
],
146161
},
147-
/* {
162+
/* {
148163
type: "category",
149164
collapsed: false,
150165
label: "Performance",

0 commit comments

Comments
 (0)