Skip to main content

Creating Pingdom checks

Overview

Pingdom is a global performance and availability monitor for your web application. The aim of this document is to provide you with the necessary information to create Pingdom checks via the cloud-platform-environments pipeline, and then send failing checks to a Slack channel of your choosing.

Prerequisites

This guide assumes the following:

Create a Pingdom check

Add the below 2 files in in the resources directory of your namespace in your cloud-platform-environments repository. You can define the conditions of your check using the resources outlined in the Terraform community provider. Here’s a working example of a basic check.

  1. Add the below code to the required_providers block in versions.tf

        pingdom = {
      source  = "DrFaust92/pingdom"
      version = "~> 1.3.1"
    }

    A working example of versions.tf with pingdom included will look like this.

    terraform {
  required_version = ">= 1.2.5"
  required_providers {
    aws = {
      source = "hashicorp/aws"
    }
    kubernetes = {
      source = "hashicorp/kubernetes"
    }
    pingdom = {
      source  = "DrFaust92/pingdom"
      version = "~> 1.3.1"
    }
  }
}

  2. Add a pingdom.tf file

    provider "pingdom" {
}

resource "pingdom_check" "claim-criminal-injuries-compensation-uat" {
  type                     = "http"
  name                     = "cica - uat - cloud-platform - claim"
  host                     = "uat.claim-criminal-injuries-compensation.service.justice.gov.uk"
  resolution               = 1
  notifywhenbackup         = true
  sendnotificationwhendown = 6
  notifyagainevery         = 0
  url                      = "/"
  encryption               = true
  port                     = 443
  tags                     = "businessunit_platforms,application_prometheus,component_healthcheck,isproduction_true,environment_uat,infrastructuresupport_platforms"
  probefilters             = "region:EU"
}

Note: You’ll need to include the provider "pingdom" and terraform blocks either in this file or in a main.tf file.

You can define the conditions of your check using the resources outlined in the Terraform community provider.

Here’s a working example of a basic check.

This basic check simply checks that the host/url (in this case; uat.claim-criminal-injuries-compensation.service.justice.gov.uk) returns a 200 every minute (resolution = 1 minute). When six (sendnotificationwhendown = 6) consecutive checks fail it triggers an alarm.

This page explains all the attributes used in the check.

All resources, including Pingdom checks must be tagged and adhere to the technical guidance outlined here. Ensure your check has appropriate tags before submitting a pull request.

Once reviewed and merged to main, the Apply Pipeline will create your check in the MoJ Pingdom account.

Adding Slack notification

You can enable the option to send a failing alert to Slack via a webhook by adding a Pingdom integration id to your pingdom.tf file.

The Cloud Platform team can generate an integration id for you. Create a user support issue requesting a Pingdom integration id, providing the following information in the issue description:

  • team name
  • application name
  • the target slack channel

Once this is submitted, the Cloud Platform team will respond by providing you with an integration id.

You can now add integrationids to your pingdom.tf. Appending the example above, your check will now appear as follows (assuming you were given 1000 as the integration id):

provider "pingdom" {
}

resource "pingdom_check" "claim-criminal-injuries-compensation-uat" {
  type                     = "http"
  name                     = "cica - uat - cloud-platform - claim"
  host                     = "uat.claim-criminal-injuries-compensation.service.justice.gov.uk"
  resolution               = 1
  notifywhenbackup         = true
  sendnotificationwhendown = 6
  notifyagainevery         = 0
  url                      = "/"
  encryption               = true
  port                     = 443
  tags                     = "businessunit_platforms,application_prometheus,component_healthcheck,isproduction_true,environment_uat,infrastructuresupport_platforms"
  probefilters             = "region:EU"
  integrationids           = [1000]
}
This page was last reviewed on 23 February 2024. It needs to be reviewed again on 23 August 2024 by the page owner #cloud-platform .
This page was set to be reviewed before 23 August 2024 by the page owner #cloud-platform. This might mean the content is out of date.