PagerDuty Health Check

With PagerDuty, you can use a previous or current PagerDuty incident, or a defined PagerDuty service as your Health Check. This lets you use your existing alerts and signals to measure the health of your service, and halt ongoing tests if your service becomes unhealthy.

You can retrieve a list of incidents from the PagerDuty web app. See List incidents in the PagerDuty documentation for more information.

Example incident or serviceInput value
Any triggered incidents (web)https://acm.eu.pagerduty.com/incidents?status=triggered
Any triggered incidents (API)https://api.pagerduty.com/incidents?statuses[]=triggered
Specific incident with ID (web)https://acm.eu.pagerduty.com/incidents/Q2K42T1G8
Specific incident with ID (API)https://api.pagerduty.com/incidents?statuses[]=triggered&service_ids[]=PE8X
All services and any incident raised (web)https://andcm.eu.pagerduty.com/service-directory?direction=asc&query=&sort_by=name&team_ids=all
All services and any incident raised (API)https://api.pagerduty.com/incidents?statuses[]=triggered
Specific service by ID and any incident raised on it (web)https://andcm.eu.pagerduty.com/service-directory?direction=asc&query=&sort_by=name&team_ids=all
Specific service by ID and any incident raised on it (API)https://api.pagerduty.com/incidents?statuses[]=triggered

To add a PagerDuty Health Check:

  • Open the Health Checks page in the Gremlin web app, click + Health Check, then select PagerDuty from the Integrations drop-down.
  • If PagerDuty is already authenticated, go to step 3. Otherwise, continue with these steps:
  • In the PagerDuty web app, create a new API key or copy an existing one.
  • In the Gremlin web app, paste your PagerDuty API key into the API Key text box under the Authentication section.
  • Click Authenticate Observability Tool. To validate the endpoint with the added header, Gremlin calls the following API: <span class="code-class-custom">https://api.pagerduty.com/abilities</span>
  • If the authentication passes, click Save Authentication, then click Next.
  • In the PagerDuty web app, copy the Incident or Service ID URL of the monitor you want to use.
  • Back in the Gremlin web app, update the PagerDuty Incident or Service ID URL with the PagerDuty Incident or Service ID.
  • Click Test Health Check. Gremlin will validate the JSON response and look for any triggered incident returned in the list associated with the input URL.
  • If the monitor is OK, the response will look similar to this:
Datadog test OK
  • If the monitor is in another state like <span class="code-class-custom">Alert</span>, <span class="code-class-custom">Ignored</span>, <span class="code-class-custom">No Data</span>, <span class="code-class-custom">Skipped</span>, <span class="code-class-custom">Unknown</span>, or <span class="code-class-custom">Warn</span>, you can still save the Health Check, but it will not evaluate to successful once a Reliability Test is run, impacting the Service's Reliability Score.
  • Click Create Health Check.
No items found.
This is some text inside of a div block.
Installing the Gremlin Agent
Authenticating the Gremlin Agent
Configuring the Gremlin Agent
Managing the Gremlin Agent
User Management
Health Checks
Command Line Interface
Updating Gremlin
Reliability Management (RM) Quick Start Guide
Services and Dependencies
Detected Risks
Reliability Tests
Reliability Score
Deploying Failure Flags on AWS Lambda
Deploying Failure Flags on AWS ECS
Deploying Failure Flags on Kubernetes
Classes, methods, & attributes
API Keys
Container security
Additional Configuration for Helm
Amazon CloudWatch Health Check
AppDynamics Health Check
Blackhole Experiment
CPU Experiment
Certificate Expiry
Custom Health Check
Custom Load Generator
DNS Experiment
Datadog Health Check
Disk Experiment
Dynatrace Health Check
Grafana Cloud Health Check
Grafana Cloud K6
IO Experiment
Install Gremlin on Kubernetes manually
Install Gremlin on OpenShift 4
Installing Gremlin on AWS - Configuring your VPC
Installing Gremlin on Kubernetes with Helm
Installing Gremlin on Windows
Installing Gremlin on a virtual machine
Installing the Failure Flags SDK
Latency Experiment
Memory Experiment
Network Tags
New Relic Health Check
Packet Loss Attack
PagerDuty Health Check
Preview: Gremlin in Kubernetes Restricted Networks
Private Network Integration Agent
Process Collection
Process Killer Experiment
Prometheus Health Check
Configuring Role Based Access Control (RBAC)
Running Failure Flags experiments
Scheduling Scenarios
Shared Scenarios
Shutdown Experiment
Managing Teams
Time Travel Experiment
Troubleshooting Gremlin on OpenShift
User Authentication via SAML and Okta
Managing Users
Integration Agent for Linux
Test Suites
Restricting Testing Times
Process Exhaustion Experiment
Enabling DNS collection
Authenticating Users with Microsoft Entra ID (Azure Active Directory) via SAML
AWS Quick Start Guide