`google_monitoring_alert_policy`: support `documentation.subject`

[tgeoghegan]

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
• Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritize the request
• If you are interested in working on this issue or have submitted a pull request, please leave a comment. If the issue is assigned to the "modular-magician" user, it is either in the process of being autogenerated, or is planned to be autogenerated soon. If the issue is assigned to a user, that user is claiming responsibility for the issue. If the issue is assigned to "hashibot", a community member has claimed the issue already.

Description

An alerting policy can have a "documentation" block which allows interpolating labels from resources and metrics into alert notifications. The API object has fields for subject and content (1). I can't set the subject in Terraform, though, because google_monitoring_alert_policy.documentation only has content and mime_type fields.

New or Affected Resource(s)

• google_monitoring_alert_policy

Potential Terraform Configuration

resource "google_monitoring_alert_policy" "kubernetes_pod_waiting" {
  display_name = "Pod waiting a long time"
  combiner     = "OR"
  documentation {
    content = <<-DESC
    Container $${metric.label.container} has been waiting for fifteen minutes, in
    pod $${metric.label.pod}, in namespace $${resource.label.namespace} due to $${metric.label.reason}.
    DESC
    # The line below is not currently allowed
    subject = "Pod $${resource.label.namespace}/$${resource.label.pod} stuck waiting"
  }
  conditions {
    display_name = "condition 1"
    condition_prometheus_query_language {
      alert_rule = "kubernetes_pod_waiting"
      rule_group = "default"
      query      = <<-QUERY
      sum by (namespace, pod, container, reason) (
            min_over_time(kube_pod_container_status_waiting_reason[15m]) * kube_pod_container_status_waiting_reason
          *
            (kube_pod_container_status_waiting_reason offset 15m)
        >
          0
      )
      QUERY
    }
  }
}

References

• 0000

b/310896720

[lhenn]

Thanks for creating this issue. ~I'm noticing that the documentation now indicates that a subject field is available, but it doesn't seem to be implemented yet, causing some confusion.~ I see this has been fixed in v5.5.0 despite this issue still being open.