tf-module-gcp-slos

Module for creating Service Level Objectives (SLOs) in Google Cloud. The slo object in the input follows the same structure as the official terraform module, which means this module can create whatever SLOs it supports (v6.0.1). A burn rate alert can be created using the alert argument. This alert can be turned on and tweaked by setting the alert object in each SLO. More information on the input argument structure can be found below or in examples.

Usage

module "gcp_slos" {
  source  = "path/to/module"
  project = "your-project-id"

  services = [
    {
      service = {
        name = "example-service"
        type = "CLOUD_RUN"
        user_labels = {
          team = "platform"
        }
      }
      slos = [
        {
          display_name = "Availability SLO"
          goal = 0.99
          rolling_period_days = 28
          basic_sli = {
            availability = {
              enabled = true
            }
          }
          alert = {
            enabled = true
          }
        }
      ]
    }
  ]
}

Name	Description	Type	Default	Required
project	Project ID to create monitoring resources in	string	n/a	yes
default_user_labels	User labels to be set for all alerts	map(any)	{}	no
fallback_notification_channels	List of display names or ids for notification channels to be set for all alerts, if unspecified in the alert.	list(any)	[]	no
notification_channel_ids	Enables you to provide the NCs 'display name' instead of 'id', { nc_display_name: nc_id } or output from tf-module-gcp-notification-channels	map(string)	{}	no
fallback_alert_documentation	Documentation to be set for all alerts, if unspecified in the alert.	string	null	no
services	List of services and their SLOs	any	n/a	yes

services object

The main input for this module is the services list. Each service can have multiple SLOs, and each SLO can have its own alert configuration. The argument to slos is a list of objects that follows the same structure as the 📖 official terraform slo module. Take a look in examples for a better understanding of how to use this module. This module supports Cloud Run or Custom services. For Cloud Run, use the same name for automatic linking (so it's visible in the SLO tab in the console). For Custom services, it's possible to provide the telemetry_resource_name.

📖 Terraform Docs
✅ Examples

services = [
  {
    service = {
      name                    = string
      type                    = string       # "CUSTOM" or "CLOUD_RUN"
      user_labels             = map(string)  # Optional
      telemetry_resource_name = string       # Optional, for CUSTOM services
    }
    slos = [
      {
        display_name        = string
        goal                = number
        rolling_period_days = number       # Optional
        calendar_period     = string       # Optional, one of "DAY", "WEEK", "FORTNIGHT", "MONTH"
        user_labels         = map(string)  # Optional

        # One of the following SLI types must be specified:
        basic_sli = {
          # ... (structure as per Terraform documentation)
        }
        request_based_sli = {
          # ... (structure as per Terraform documentation)
        }
        windows_based_sli = {
          # ... (structure as per Terraform documentation)
        }

        alert = {
          enabled               = bool    # Optional, default = false
          title                 = string  # Optional
          documentation         = string  # Optional
          threshold_value       = number  # Optional
          condition_name        = string  # Optional
          lookback_duration     = string  # Optional
          threshold_value       = number  # Optional
          duration              = string  # Optional
          notification_channels = list(string)  # Optional
        }
      }
    ]
  }
]

Outputs

services output structure

{
  "service_name" = {
    id   = string
    name = string
    type = string  # "CUSTOM" or "CLOUD_RUN"
  }
}

slos output structure

{
  "service_name-slo_name" = {
    id           = string
    name         = string
    service_name = string
  }
}

alerts output structure

{
  "service_name-slo_name" = {
    id           = string
    name         = string
    service_name = string
  }
}