|
| 1 | +# Sentry |
| 2 | + |
| 3 | +The infrastructure team manages a [Sentry](https://sentry.io) organization on |
| 4 | +`sentry.io` for the Rust Team to use. The instance is generously sponsored by |
| 5 | +Sentry, and this document explains how to use it. |
| 6 | + |
| 7 | +## Log into the instance |
| 8 | + |
| 9 | +Every member of the `rust-lang` GitHub organization can authenticate in our |
| 10 | +Sentry instance, using their GitHub credentials. Visit [the authentication |
| 11 | +page][auth], click the "Single Sign-On" tab and enter the `rust-lang` |
| 12 | +Organization ID. You'll be then prompted to log with your GitHub Account! |
| 13 | + |
| 14 | +If this is the first time signing into our Sentry organization, you might have |
| 15 | +to [request access to the teams you're on][teams]. Once you request access, a |
| 16 | +member of the infrastructure team will approve it. |
| 17 | + |
| 18 | +## Request a new project |
| 19 | + |
| 20 | +If you're a member of a Rust Team and you want to use Sentry for a project your |
| 21 | +team manages, you need to follow these steps: |
| 22 | + |
| 23 | +1. If the project is public facing (i.e. people outside the team are supposed |
| 24 | + to access it) you need to contact [Rust's legal counsel][legal] to amend the |
| 25 | + privacy policy, adding a note that your service is using Sentry too similar |
| 26 | + to the existing ones. |
| 27 | + |
| 28 | +2. Once the privacy policy is sorted out (whenever needed), you can contact the |
| 29 | + infrastructure team to create a new project in the Sentry interface and |
| 30 | + potentially a new Sentry team. |
| 31 | + |
| 32 | +3. Finally, you can integrate the Sentry SDK with your project. |
| 33 | + |
| 34 | +## Creating a new project |
| 35 | + |
| 36 | +This section documents how the infrastructure team can actually create new |
| 37 | +projects when requested. You need to either have a personal Sentry account with |
| 38 | +"Owner" permissions, or access to the Sensitive 1Password vault (where the |
| 39 | +admin credentials are stored). |
| 40 | + |
| 41 | +To create a project, authenticate in Sentry and visit the [create new project |
| 42 | +page][create]. Pick the technology stack the team is using, a relevant name and |
| 43 | +the team responsible for it (you can create new teams by clicking the "+" |
| 44 | +icon). Finally, if you created a new team, add the relevant people to it. |
| 45 | + |
| 46 | +[auth]: https://sentry.io/auth/login/ |
| 47 | +[teams]: https://sentry.io/settings/rust-lang/teams/ |
| 48 | +[legal]: /core/legal.md |
| 49 | +[create]: https://sentry.io/organizations/rust-lang/projects/new/ |
0 commit comments