Skip to content

Commit a7a88f0

Browse files
authored
restructure issue owners page (#5842)
* rearranged sections and added intro text to new heading * fixed styling and other wording edits * Trigger Build
1 parent b90deb9 commit a7a88f0

File tree

1 file changed

+20
-28
lines changed
  • src/docs/product/issues/issue-owners

1 file changed

+20
-28
lines changed

src/docs/product/issues/issue-owners/index.mdx

Lines changed: 20 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ description: "Learn how to automatically assign issues to their respective owner
1515

1616
Sentry offers multiple ways to define the "ownership" of an issue. With ownership defined, we can automatically assign issues and send alerts to the owner. Sentry defines ownership with _code owners_ and _ownership rules_. Code owners functionality lets you import your [GitHub](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners) or [GitLab](https://docs.gitlab.com/ee/user/project/code_owners.html) CODEOWNERS file, and then we assign issues according to those file paths. Ownership rules allow you to override the assignments based on code owners and provide advanced matcher types (for example, urls and tags). These rules can also match on the file paths of files in the stack trace, URL of the request, or event tags.
1717

18-
## How It Works
18+
## Methods
1919

2020
Ownership rules and code owners are matched against individual events in an issue. This matching is relied upon in other areas of [sentry.io](https://sentry.io), as described in the following sections. One key thing to note: issue owners are set for an issue, not a project or organization.
2121

2222
### Ownership Rules
2323

24-
You define ownership rules per project. To configure ownership rules, navigate to your **[Project] > Settings > Issue Owners**, or click on the "Create Ownership Rule" button on an Issue Details page.
24+
You can set ownership by defining ownership rules per project. To configure ownership rules, navigate to **[Project] > Settings > Issue Owners**, or click on the "Create Ownership Rule" button on an **Issue Details** page.
2525

2626
Types of matches available:
2727

@@ -116,32 +116,6 @@ Let us know if you have feedback: [[email protected]](mailto:ecosyste
116116

117117
Create external team/user mappings for your GitHub/GitLab teams and users by navigating to **Settings > Integrations > GitHub/GitLab > [Configuration] > Team Mappings/User Mappings**. Suggestions will come from any CODEOWNERS files on projects for the organization.
118118

119-
### Suggested Assignees
120-
121-
On the **Issue Details** page, you'll see suggested assignees based on ownership rules matching the event you're looking at (by default, the **Issue Details** page shows the latest event). Suggested assignees can also be based on [suspect commits](/product/issues/suspect-commits/). You can assign the _issue_ to a suggested assignee by clicking on the suggestion. An event can have multiple suggested assignees if it matches multiple ownership rules.
122-
123-
![Avatar icons of suggested assignees and ability to click on them for assignment.](suggested_assignees.png)
124-
125-
### Auto-Assign
126-
127-
You can automatically assign issues to their owners by enabling the following setting in **[Project] > Settings > Issue Owners**.
128-
129-
![Select from dropdown to automatically assign issues to their owners.](auto-assign-issue-owner.png)
130-
131-
If an issue is already assigned, a new event for that issue will not re-assign the issue even if it has a different owner. If an issue is not assigned, but a new event has multiple owners, [sentry.io](https://sentry.io) assigns it to the owner(s) from the last matching rule (regardless of the rule `type`).
132-
133-
### Issue Alerts
134-
135-
You can send [Issue Alerts](/product/alerts-notifications/issue-alerts/) to issue owners. Issue alerts are event-driven: when [sentry.io](https://sentry.io) receives an event, it evaluates issue alert rules for the issue for that event. If the alert conditions match, [sentry.io](https://sentry.io) sends an alert to the _owners of the event that triggered the alert_.
136-
137-
![Dropdown indicating choices for Issue Alert recipients.](perform_these_actions.png)
138-
139-
If no ownership rules match the event, the alert will either be sent to nobody or all members of the project, depending on the following setting in **[Project] > Settings > Issue Owners:**
140-
141-
![Toggle that auto-assigns issue owners if no ownership rules match the event.](ownership_not_determined.png)
142-
143-
Alerts sent to issue owners obey the user or team's notification preferences.
144-
145119
## Evaluation Flow
146120

147121
If you have both ownership rules and code owners, Sentry evaluates an event against the rules in the following order:
@@ -185,6 +159,24 @@ The matches, in order, are:
185159

186160
Sentry will return the last matching rule, which in this case is `path:dist/frontend/components/* #frontend`
187161

162+
## Where It's Applied
163+
164+
Once issue ownership is configured, it's applied in the following ways.
165+
166+
### Suggested Assignees
167+
168+
On the **Issue Details** page, you'll see suggested assignees based on ownership rules matching the event you're looking at (by default, the **Issue Details** page shows the latest event). Suggested assignees can also be based on [suspect commits](/product/releases/suspect-commits/). You can assign the _issue_ to a suggested assignee by clicking on the suggestion. An event can have multiple suggested assignees if it matches multiple ownership rules.
169+
170+
![Avatar icons of suggested assignees and ability to click on them for assignment.](suggested_assignees.png)
171+
172+
### Auto-Assign
173+
174+
You can automatically assign issues to their owners by enabling the following setting in **[Project] > Settings > Issue Owners**.
175+
176+
![Select from dropdown to automatically assign issues to their owners.](auto-assign-issue-owner.png)
177+
178+
If an issue is already assigned, a new event for that issue will not re-assign the issue even if it has a different owner. If an issue is not assigned, but a new event has multiple owners, [sentry.io](https://sentry.io) assigns it to the owner(s) from the last matching rule (regardless of the rule `type`).
179+
188180
## Troubleshooting
189181

190182
Ensure that all teams and users have access to the project. If they don't have the correct access, the Issue Owners rules will fail to save. To grant a team access to a project, navigate to **[Project] > Settings > Project Teams**, and click "Add Team". To grant a user access to a project, the user must have at least member access to a team associated with the project. To add a user to a project's team, navigate to **Settings > Teams**, select a team, and then click "Add Member".

0 commit comments

Comments
 (0)