-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(discord): Add discord integration doc (#8160)
* feat(discord): Add discord integration doc * Fix typo * Update src/docs/product/accounts/getting-started/index.mdx Co-authored-by: Liza Mock <[email protected]> * Update src/docs/product/alerts/create-alerts/routing-alerts.mdx Co-authored-by: Liza Mock <[email protected]> * Update src/docs/product/alerts/create-alerts/routing-alerts.mdx Co-authored-by: Liza Mock <[email protected]> * Update src/docs/product/alerts/create-alerts/routing-alerts.mdx Co-authored-by: Liza Mock <[email protected]> * Update src/docs/product/alerts/create-alerts/routing-alerts.mdx Co-authored-by: Liza Mock <[email protected]> * style(lint): Auto commit lint changes * Update src/docs/product/integrations/notification-incidents/discord/index.mdx Co-authored-by: Liza Mock <[email protected]> * Update src/docs/product/integrations/notification-incidents/discord/index.mdx Co-authored-by: Liza Mock <[email protected]> * Update src/docs/product/integrations/notification-incidents/discord/index.mdx Co-authored-by: Liza Mock <[email protected]> * Update src/docs/product/integrations/notification-incidents/discord/index.mdx Co-authored-by: Liza Mock <[email protected]> * style(lint): Auto commit lint changes * style(lint): Auto commit lint changes * style(lint): Auto commit lint changes * Update src/docs/product/integrations/notification-incidents/discord/index.mdx Co-authored-by: Liza Mock <[email protected]> * Update src/docs/product/integrations/notification-incidents/discord/index.mdx Co-authored-by: Liza Mock <[email protected]> * style(lint): Auto commit lint changes * style(lint): Auto commit lint changes * style(lint): Auto commit lint changes * Update src/docs/product/integrations/notification-incidents/discord/index.mdx Co-authored-by: Liza Mock <[email protected]> * style(lint): Auto commit lint changes * style(lint): Auto commit lint changes * style(lint): Auto commit lint changes * Update src/docs/product/integrations/notification-incidents/discord/index.mdx Co-authored-by: Liza Mock <[email protected]> * Update src/docs/product/integrations/notification-incidents/discord/index.mdx Co-authored-by: Liza Mock <[email protected]> * Update src/docs/product/integrations/notification-incidents/discord/index.mdx Co-authored-by: Liza Mock <[email protected]> * Update src/docs/product/integrations/notification-incidents/discord/index.mdx Co-authored-by: Liza Mock <[email protected]> * Update src/docs/product/integrations/notification-incidents/discord/index.mdx Co-authored-by: Liza Mock <[email protected]> * Update src/docs/product/integrations/notification-incidents/discord/index.mdx Co-authored-by: Liza Mock <[email protected]> * Update src/docs/product/integrations/notification-incidents/discord/index.mdx Co-authored-by: Liza Mock <[email protected]> * Update src/docs/product/integrations/notification-incidents/discord/index.mdx Co-authored-by: Liza Mock <[email protected]> * Update src/docs/product/integrations/notification-incidents/discord/index.mdx Co-authored-by: Liza Mock <[email protected]> * Update src/docs/product/integrations/notification-incidents/discord/index.mdx Co-authored-by: Liza Mock <[email protected]> * style(lint): Auto commit lint changes * style(lint): Auto commit lint changes * style(lint): Auto commit lint changes * style(lint): Auto commit lint changes * style(lint): Auto commit lint changes * style(lint): Auto commit lint changes * style(lint): Auto commit lint changes * style(lint): Auto commit lint changes * Apply suggestions from code review Co-authored-by: Liza Mock <[email protected]> * style(lint): Auto commit lint changes --------- Co-authored-by: Liza Mock <[email protected]> Co-authored-by: getsantry[bot] <66042841+getsantry[bot]@users.noreply.github.com>
- Loading branch information
1 parent
6de018d
commit 5c96f65
Showing
20 changed files
with
143 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file added
BIN
+45.3 KB
src/docs/product/alerts/create-alerts/alerts-notifications-discord.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file added
BIN
+97.8 KB
...ocs/product/integrations/notification-incidents/discord/discord-action-form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+377 KB
...product/integrations/notification-incidents/discord/discord-add-issue-alert.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+69.4 KB
...oduct/integrations/notification-incidents/discord/discord-copy-channel-link.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+307 KB
.../product/integrations/notification-incidents/discord/discord-developer-mode.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+105 KB
...duct/integrations/notification-incidents/discord/discord-identity-link-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+149 KB
...uct/integrations/notification-incidents/discord/discord-integration-details.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+8.02 MB
...roduct/integrations/notification-incidents/discord/discord-issue-alert-demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+57.9 KB
...ocs/product/integrations/notification-incidents/discord/discord-issue-alert.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+31.9 KB
...product/integrations/notification-incidents/discord/discord-link-channel-id.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+80 KB
src/docs/product/integrations/notification-incidents/discord/discord-login.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+1.5 MB
...oduct/integrations/notification-incidents/discord/discord-metric-alert-demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+331 KB
...s/product/integrations/notification-incidents/discord/discord-server-select.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
127 changes: 127 additions & 0 deletions
127
src/docs/product/integrations/notification-incidents/discord/index.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,127 @@ | ||
--- | ||
title: Discord | ||
sidebar_order: 1 | ||
redirect_from: | ||
- /integrations/discord/ | ||
- /product/integrations/discord/ | ||
description: "Learn more about Sentry's Discord integration and how you can get notified and manage issues right in Discord." | ||
--- | ||
|
||
Set up a Discord integration so you can get notified about, then triage, resolve, and archive Sentry issues directly from Discord. | ||
|
||
## Install | ||
|
||
<Note> | ||
|
||
Sentry owner, manager, or admin permissions are required to install this integration. | ||
|
||
</Note> | ||
|
||
1. Navigate to **Settings > Integrations > Discord** in [Sentry](https://sentry.io). | ||
|
||
2. Click "Add Installation". You should see a pop up window. | ||
|
||
![Install Discord integration](discord-integration-details.png) | ||
|
||
3. Log in to your Discord account. If you're already logged in, this login step will not be displayed. | ||
|
||
4. Use the dropdown menu to select the Discord server you'd like to add Sentry to and click "Continue". | ||
|
||
<Note> | ||
You'll need to have the "Manage Server" permission enabled for your Discord | ||
account in the server you're trying to add the bot to. | ||
</Note> | ||
|
||
![Select server](discord-server-select.png) | ||
|
||
5. Once you've selected the server, click "Authorize" to create the integration and add the Sentry Discord bot. | ||
|
||
Your Discord integration will now be available for all projects in your Sentry organization. | ||
|
||
## Configure | ||
|
||
Our Discord integration currently supports issue and metric alert rules. Support for personal notifications is planned for future updates. | ||
|
||
### Issue Alerts | ||
|
||
To create an issue alert that sends notifications to Discord, follow the steps below: | ||
|
||
1. Go to the **Alerts** page in Sentry and click "Create Alert". | ||
|
||
2. Select "Issues" and then click "Set Conditions". | ||
|
||
![Create issue alert](discord-add-issue-alert.png) | ||
|
||
3. Configure your issue alert conditions. | ||
|
||
4. Select "Send a Discord notification" from the "THEN" actions dropdown. | ||
|
||
5. Choose the Discord server and channel you'd like to send the alert to. You'll also have the option to specify any tags you'd like to include in the notification. | ||
|
||
Note that the channel field must be filled in with a Discord channel ID, **_not_** a channel name. To get it, right click on your channel, select "Copy Link", then highlight the string of numbers at the end. | ||
|
||
![Discord Channel Link](discord-copy-channel-link.png) | ||
|
||
For example, if the URL is `https://discord.com/channels/server-id/channel-id`, the ID is `channel-id`. | ||
|
||
![Channel ID in Link](discord-link-channel-id.png) | ||
|
||
6. Test your configuration by clicking "Send Test Notification". If the bot has access to the given channel, you should see an example notification there. | ||
|
||
![Discord issue alert](discord-issue-alert.png) | ||
|
||
Check out the gif below for a walkthrough of how to create an alert that sends Discord notifications: | ||
|
||
![Issue alert creation](discord-issue-alert-demo.gif) | ||
|
||
### Metric Alerts | ||
|
||
To set up a metric alert that sends Discord notifications, follow the steps below. | ||
|
||
1. Go to the **Alerts** page in Sentry and click "Create Alert". | ||
|
||
2. Select "Number of Errors" or "Users Experiencing Errors", then "Set Conditions". | ||
|
||
3. Configure your metric alert conditions as desired. | ||
|
||
4. Click "Add Action", then select your Discord server from the second dropdown. | ||
|
||
5. Add the channel ID you'd like to send the alert to. | ||
|
||
Note that the channel field must be filled in with a Discord channel ID, **_not_** a channel name. To get it, right click on your channel, select "Copy Link", then highlight the string of numbers at the end. | ||
|
||
![Discord Channel Link](discord-copy-channel-link.png) | ||
|
||
For example, if the URL is `https://discord.com/channels/server-id/channel-id`, the ID is `channel-id`. | ||
|
||
![Channel ID in Link](discord-link-channel-id.png) | ||
|
||
6. Name and save your alert rule. | ||
|
||
The gif below walks through how to create a metric alert that sends Discord notifications. | ||
|
||
![Metric alert creation](discord-metric-alert-demo.gif) | ||
|
||
### Identity Linking | ||
|
||
Having your Discord account linked to your Sentry account allows you to resolve, archive, and assign issues directly in Discord. | ||
|
||
When a user installs the Discord bot to their server, their identity gets linked in the process. To verify which Sentry account a Discord account is linked to, use the `/link` command. | ||
|
||
Any user on a Discord server with the Sentry bot can link their account. To do so, use the `/link` command. The bot will reply with a link to our identity linking page. When you open the link, be sure you're signed into the Sentry account you want to link to, then click "Link with Discord". | ||
|
||
![Discord identity linking page](discord-identity-link-page.png) | ||
|
||
To unlink your accounts, use the `/unlink` command. Follow the link and click "Unlink from Discord" | ||
|
||
### Troubleshooting | ||
|
||
Here are some ideas to help with troubleshooting. | ||
|
||
#### Your channel ID isn't working in the alert creation wizard | ||
|
||
If you're trying to create an alert with a Discord action and Sentry can't access the channel you've provided, please double-check the following: | ||
|
||
- You're giving us a channel ID and not a channel name or something else. See [Configure](#configure) for more details. | ||
- The channel you're trying to add is in the same server as the one selected in the alert action. | ||
- The bot has access to the channel you're trying to use. A quick way to verify this is to check whether you can find the bot in the desired channel's member list. If you don't see the bot in the list of users, you may need to update your Discord role and/or channel permissions to allow the bot access. See [Install](#install) for more details. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
5c96f65
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Successfully deployed to the following URLs:
sentry-docs – ./
docs.sentry.io
sentry-docs.sentry.dev
sentry-docs-git-master.sentry.dev