Create a PagerDuty notifier

To create a PagerDuty notifier, set up PagerDuty and then create the notifier in Chronosphere Observability Platform. Before you begin, enure you have your PagerDuty integration key.

Set up PagerDuty

Before creating a PagerDuty notifier in Observability Platform, configure the integration in PagerDuty. To configure a PagerDuty notifier:

In PagerDuty, go to Services > Service Directory and click New Service.
Enter a name and description for the service and follow the remaining prompts.
Select Chronosphere from the integration types list and create the service.
After PagerDuty redirects you to the new service, click the Integrations tab, which displays the integration key.
Copy the integration key, which you enter when creating a PagerDuty notifier in Observability Platform.

Next, create a PagerDuty notifier in Observability Platform.

Create a PagerDuty notifier in Observability Platform

After setting up PagerDuty, you can create a PagerDuty notifier in Observability Platform. The Observability Platform PagerDuty notifier sends alert details to PagerDuty as a string for improved readability in the PagerDuty user interface. The alert details can also be sent as a JSON object for use in downstream PagerDuty AIOps features. The JSON format makes it easier to consume alert details programmatically, while retaining data visibility in the user interface. To enable JSON format, contact Chronosphere Support. Select from the following methods to create a PagerDuty notifier. You can use variables in your notifiers.

Web
Chronoctl
Terraform
API

To create a PagerDuty notifier:

In the navigation menu select Alerting > Notifiers.
Click Create notifier.
Enter a descriptive name for the notifier.
Select PagerDuty as the type of notifier you want to create.
In the Service key field, enter the integration key you created in PagerDuty.
In the URL field, enter the PagerDuty Events API v2 endpoint, which is called as a POST request:
https://events.pagerduty.com/v2/enqueue
In the Severity dropdown, select a severity for the event.
Optional: Select Notify when resolved to send a resolved alert notification.
Click Save.

To create one or more notifiers using Chronoctl, create a YAML file that defines them and apply the configuration to your instance.

You can use the notifiers scaffold command to generate an example notifier, and then copy the resource definition for your notifier type:

chronoctl notifiers scaffold

Define the resource definition for your PagerDuty notifier by adding the following information to a YAML file:
Chronoctl example
api_version: v1/config kind: Notifier spec: name: NAME slug: SLUG pagerduty: routing_key: ROUTING_KEY url: https://events.pagerduty.com/v2/enqueue severity: SEVERITY
Replace the following:
- NAME: A descriptive name, such as team-pagerduty.
- SLUG: A unique identifier, such as team-pagerduty.
- ROUTING_KEY: Your PagerDuty integration key.
- SEVERITY: A severity, such as critical or warning.
Apply the changes:
chronoctl apply -f FILE_NAME.yaml
Replace FILE_NAME with the name of the notifier YAML file you previously created.

To create a PagerDuty notifier:

Create a PagerDuty notifier with Terraform by using the chronosphere_pagerduty_alert_notifier type followed by a name in a resource declaration:

Terraform example

resource "chronosphere_pagerduty_alert_notifier" "pagerduty_notifier" {
  name = "PagerDuty Notifier"

  # Optional slug of the pagerduty notifier.
  slug = "pd-notifier"

  ## Notifier-specific required configuration
  severity      = "info"
  url           = "https://events.pagerduty.com/v2/enqueue"

  # Exactly one of service_key or routing_key has to be specified
  # service_key = "XXXXX"
  routing_key = "my-routing-key"

  ## Notifier-specific optional configurations
  class       = "my_class"
  client      = "my_client"
  client_url  = "https://my_client_url"
  component   = "my_component"
  description = "helpful description"
  details     = {
    "first_detail" = "interesting detail"
  }
  group       = "my_group"

  # Can have multiple images.
  image {
    # src is required for every image
    src  = "https://example.com/image/myimage.png"
    alt  = "Chronosphere"
    href = ""
  }

  # Can have multiple links.
  link {
    # href is required for every link
    href = "https://chronosphere.io/"
    text = "some text"
  }

  ## (Optional) Base configuration common to all notifiers
  send_resolved = true # The default value

  ## (Optional) HTTP configuration common to HTTP notifiers
  basic_auth_username = "username"
  basic_auth_password = "strong+p@ssword"
  # Can use bearer_token instead of basic auth
  tls_insecure_skip_verify = false
}

In the severity field, specify a severity, such as critical or warning.
In the routing_key field, enter your PagerDuty integration key as the value.
Add the following URL, called as a POST request, to the url key:
https://events.pagerduty.com/v2/enqueue
Run terraform apply to create the notifier resource.
terraform apply

See send an alert event in the PagerDuty documentation for more information.

To complete this action with the Chronosphere API, use the pagerduty object in the CreateNotifier endpoint.Because the Chronosphere API requires authentication, include an API token with your curl request, as shown in the following example. For more details, see Create an API token.

export CHRONOSPHERE_API_TOKEN="TOKEN"
export CHRONOSPHERE_DOMAIN="INSTANCE.chronosphere.io"

curl -H "API-Token: ${CHRONOSPHERE_API_TOKEN}" \
     -X METHOD "https://${CHRONOSPHERE_DOMAIN}/ENDPOINT_PATH"

Replace the following:

TOKEN: Your API token.
INSTANCE: The subdomain name for your organization’s Observability Platform instance.
METHOD: The HTTP method to use with the request, such as GET or POST.
ENDPOINT_PATH: The specific endpoint you want to access.

Observability Platform

Telemetry Pipeline

More information

Set up PagerDuty

Create a PagerDuty notifier in Observability Platform

​Set up PagerDuty

​Create a PagerDuty notifier in Observability Platform

Set up PagerDuty

Create a PagerDuty notifier in Observability Platform