Discord alert method

Reading time: 0 minute(s) (0 words)

The Discord alert method sends alerts through Discord to notify Nobl9 users whenever an incident is triggered.

Authentication

To set up the Discord integration, you’ll need to provide a Discord Webhook URL. This allows you to send an automated notification to a channel of your choice. For details, see Discord documentation.

Known limitations

Currently, Nobl9 doesn't return the severity level when a Discord alert is triggered.

Adding the Discord alert method

You can add the Discord alert method directly in the Nobl9 Web application.

Alternatively, utilize the SLOs-as-code approach by:

• Applying an alert method YAML configuration with the sloctl apply command.
• Configuring the Discord alert method definition programmatically using the Nobl9 Terraform provider.

Nobl9 Web

To set up the alert method in the Nobl9 Web, follow these steps:

1. Navigate to Integrations > Alert methods.
2. Click .
3. Select Discord.

4. Enter the URL (mandatory).
   This is your Discord Webhook URL. For more information, refer to the Authentication section.

5. Select a Project (mandatory).
   Project is a way to organize your Nobl9 resources and manage access to them.
   When Project is skipped, Nobl9 uses the default project.
6. Enter a Display Name (optional).
   Spaces are allowed.
7. Enter a Name (mandatory).
   The name is mandatory and can only contain lowercase, alphanumeric characters, and dashes (for example, my-alert-method-1). Nobl9 duplicates the display name here, transforming it into the supported format, but you can edit the result.
8. Enter a Description (optional).
   Provide extra details about it, its purpose, responsible persons, etc.
   Up to 1050 characters.

9. Click Add alert method.

YAML configuration

YAML

General YAML sample for discord

apiVersion: n9/v1alpha
kind: AlertMethod
metadata:
  name: string # Mandatory
  displayName: string # Optional
  project: default # Mandatory
  # Optional
  # The key value: only alphanumeric characters, `-`, `_`, or `.` are allowed.
  # The key value must start and end with an alphanumeric character.
  # An optional DNS subdomain prefix followed by `/` is allowed.
  annotations:
    key: value
spec:
  description: string # Optional
  discord:
    url: # URL to Discord webhook, must start with https://

Example

Working YAML sample for Discord

apiVersion: n9/v1alpha
kind: AlertMethod
metadata:
  name: discord
  displayName: Discord Alert Method
  project: default
  annotations:
    area: latency
    env: prod
    region: us
    team: sales
spec:
  description: Example Discord Alert Method
  discord:
    url: https://discord.com/api/webhooks/123/secret

Testing the Discord alert method in the Web

You can test alert methods for all notification services supported by the Nobl9 platform through the UI.

To verify the correctness of your alert method configuration:

1. Navigate to Integrations > Alert methods.
2. Click the required alert method.
   Its Details page opens.
3. Click Test under the alert method name:
   
   
   • When the configuration is correct, Nobl9 displays Test completed successfully! under the button.
   • Otherwise, the Test failed message appears. It contains the details of incorrect settings.

Useful links

For a more in-depth look, consult additional resources:

Discord alert methodTerraform provider