Opsgenie alert method

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

The OpsGenie alert method sends alerts through Opsgenie to notify whenever an incident is triggered.

Authentication

Two authentication methods are supported for Opsgenie API integration:

• Basic is a base64 hash created from the API Key, for example, YTU5ODNiZjYtZTM3OC00Yzk3LWE2YWItOGJlMzU4OWUxOTBm.

• GenieKey (default) only requires the API Key obtained directly from the Opsgenie panel, so it is easier to use.

The choice between the two authentication methods is offered for convenience, as some users may only have access to one of the methods.

Creating Opsgenie API Key

1. Log in to your Opsgenie account.

2. Go to Teams in the top navbar, then click the Add team button:

Image 1: Add a new team to your Opsgenie account

3. Hover over and click the name of the team that you've created:

Image 2: Go to Opsgenie team details

4. Go to Integrations in the left sidebar, and click the Add integration button:

Image 3: Create an Opsgenie integration

5. Click the API icon:

Image 4: Add opsgenie API key

6. Copy your Opsgenie API Key:

Image 5: Opsgenie API key for the Nobl9 integration

Known limitations

Currently, Nobl9 doesn't return the severity level when an OpsGenie alert is triggered.

Configuring the Opsgenie alert method

You can configure your Opsgenie alert method directly in the Nobl9 UI, or by applying a YAML file in sloctl.

Nobl9 Web

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

1. Navigate to Integrations > Alert Methods.
2. Click .
3. Click the relevant Alert Method icon.

Then, in the OpsGenie Configuration Wizard:

1. Enter the URL (mandatory).
   The URL must start with https://api.opsgenie.com or https://api.eu.opsgenie.com.

2. Choose the Basic or GenieKey type of Authentication Method from the drop-down list.
   The default value is GenieKey. For more information, refer to the Authentication section.

3. Enter the API Key (mandatory).
   Paste the API Key from Opsgenie. For more information, refer to the Authentication section.

4. Select a Project.
   Specifying a project is helpful when multiple users are spread across multiple teams or projects. When the Project field is left blank, Nobl9 uses the default project.
5. Enter a Display Name.
   You can enter a user-friendly name with spaces in this field.
6. Enter a Name.
   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.
7. Enter a Description.
   Here you can add details such as who is responsible for the integration (team/owner) and the purpose of creating it.
8. Click Add Alert Method.

OpsGenie alerts severity mapping

OpsGenie returns priority levels, which Nobl9 maps to its own severity levels for consistency in handling alerts. Below is the mapping of Nobl9 severity levels to the priority levels returned by OpsGenie:

OpsGenie Priority	Nobl9 Severity
P5	Low
P3	Medium
P1	High

YAML configuration for Opsgenie

General YAML

General YAML sample for Opsgenie alert method

apiVersion: n9/v1alpha
kind: AlertMethod
metadata:
  name: string # Mandatory
  displayName: string # Optional
  # 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
  opsgenie:
    auth: string # Mandatory. One of: GenieKey with key | Basic with token
    url: string # Mandatory

Example with GenieKey auth

YAML sample with GenieKey auth

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

Example with basic auth

YAML sample with basic auth

- apiVersion: n9/v1alpha
  kind: AlertMethod
  metadata:
    name: opsgenie-basic-auth
    displayName: Opsgenie Alert Method with Basic auth
    project: default
    annotations:
      area: latency
      env: prod
      region: us
      team: sales
  spec:
    description: Example Opsgenie Alert Method with Basic auth
    opsgenie:
      auth: Basic 123
      url: https://api.opsgenie.com

Testing the Opsgenie alert method in the UI

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:

OpsGenie alert methodTerraform provider