Issue Ownership Rules

The Issue Owners feature allows you to create rules to decide which user or team should own an issue. These rules resemble a typical code owners file in a repository, and can match on file paths of files in the stack trace, URL of the request, or event tags. You can automatically assign issues to their respective owners, or alert the owners about the issue, allowing you to find the developer with the most context about a fix.

How It Works

Ownership rules are matched against individual events in an issue. This matching is relied upon in other areas of 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.

Creating Rules

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.

Types of matches available:

  1. Path: matches against all file paths in the event's stack trace
  2. Module: matches against the module in the event's stack trace
  3. URL: matches against the event's url
  4. Tag: matches against event tags

The general format of a rule is: type:pattern owners

type
Can be either path, module, url, or tags.TAG_NAME, which matches the specified tag.

pattern
The pattern you're matching on. For example, src/javascript/* for path, [https://www.example.io/checkout](https://www.example.io/checkout) for url, or Chrome 81.0.* for tags.browser.

: pattern matching supports unix-style glob syntax. For example, add * to match anything and ? to match a single character. This is not a regex.

owners
The owner, or list of owners, identified by either the email of the Sentry user or the name of the team, prefixed with #. Thus, the owner may be example@company.com or example1@company.com example2@company.com or #backend-team. A space separates each owner in the list of owners.

Teams must have access to the project to become owners. 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 be a member of a team with access to the project. To add a user to a team, navigate to Settings > Teams, select a team, and click "Add Member".

You can add an ownership rule from the project settings:

Configuration options for defining ownership rules in project settings.

You can also add a rule from the Issue Details page:

Configuration options for defining ownership rules from an issue page.

When you create a rule from the Issue Details page, you'll see some suggested paths and URLs based on the events in the issue. Note that sentry.io doesn't suggest tags.

Suggested Assignees

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. 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.

Avatar icons of suggested assignees and ability to click on them for assignment.

Auto-Assign

You can automatically assign issues to their owners by enabling the following setting in [Project] > Settings > Issue Owners.

Toggle to automatically assign issues to their owners.

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 assigns it to the owner matching the longest pattern in the rules that matched (regardless of the rule type).

Issue Alerts

You can send Issue Alerts to issue owners. Issue alerts are event-driven: when sentry.io receives an event, it evaluates issue alert rules for the issue for that event. If the alert conditions match, sentry.io sends an alert to the owners of the event that triggered the alert.

Dropdown indicating choices for Issue Alert recipients.

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:

Toggle that auto-assigns issue owners if no ownership rules match the event.

Alerts sent to issue owners are sent only by email.

Troubleshooting

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".

Help improve this content
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) to suggesting an update ("yeah, this would be better").