Application Real-Time Monitoring Service:通知テンプレートと Webhook テンプレートの設定

このトピックでは、次のサンプルコードを使用して、一般的な Go テンプレート構文について説明します。

{
  "alerts": [
    {
      "annotations": {
        "message": "Namespace: arms-prom / Pod: kube-state-metrics-ccb59dbff-jljg4 / Container: kube-state-metrics memory usage has exceeded 80%, current value 15.52%",
        "value": "15.521240234375"
      },
      "endsAt": "2023-02-22T07:27:15.404000000Z",
      "fingerprint": "bec72890cc2c7b4a027e008df0cd1013",
      "labels": {
        "container": "kube-state-metrics",
        "severity": "warning",
        "instance": "10.0.80.186:10255",
        "clustername": "klyz1688-kubernetes-1",
        "alertname": "Container memory usage exceeds 80%",
        "_aliyun_arms_involvedObject_name": "klyz1688-kubernetes-1",
        "pod_name": "kube-state-metrics-ccb59dbff-jljg4",
        "_aliyun_arms_involvedObject_kind": "cluster",
        "name": "k8s_kube-state-metrics_kube-state-metrics-ccb59dbff-jljg4_arms-prom_359508f3-7e76-4740-b915-41ea48849641_0",
        "namespace": "arms-prom"
      },
      "startsAt": "2023-02-22T07:18:15.578000000Z",
      "status": "firing"
    }
  ],
  "commonAnnotations": {
    "message": "Namespace: arms-prom / Pod: kube-state-metrics-ccb59dbff-jljg4 / Container: kube-state-metrics memory usage has exceeded 80%, current value 15.52%",
    "value": "15.521240234375"
  },
  "commonLabels": {
    "container": "kube-state-metrics",
    "severity": "warning",
    "instance": "10.0.80.186:10255",
    "clustername": "klyz1688-kubernetes-1",
    "alertname": "Container memory usage exceeds 80%",
    "_aliyun_arms_involvedObject_name": "klyz1688-kubernetes-1",
    "pod_name": "kube-state-metrics-ccb59dbff-jljg4",
    "_aliyun_arms_involvedObject_kind": "cluster",
    "name": "k8s_kube-state-metrics_kube-state-metrics-ccb59dbff-jljg4_arms-prom_359508f3-7e76-4740-b915-41ea48849641_0",
    "namespace": "arms-prom"
  },
  "groupLabels": {
    "alertname": "Container memory usage exceeds 80%"
  },
  "status": "firing",
  "startTime":"2023-02-22 07:18:15",
  "endTime":"Alert resolution time",
  "level":"error",
  "dispatchRuleName":"notification policy name",
  "alarmId":"123456"
},

例 1：最上位スコープからすべての内容を取得します。最上位スコープは、サンプルコードのコンテキストデータ全体です。

{{ . }}

例 2: コンテキストデータから level フィールドを取得します。

{{ .level }}

戻り値：

error

例 3: コンテキストデータから commonLabels.alertname フィールドを取得します。

{{ .commonLabels.alertname }}

戻り値：

Container memory usage exceeds 80%

例 1: アラート名を $alertname に代入し、次に $alertname を出力します。

{{ $alertname := .commonLabels.alertname }} {{$alertname}}

戻り値：

Container memory usage exceeds 80%

例 2: alerts リストの最初の アラートを $alert0 に代入し、その alertname を出力します。

{{ $alert0 := index .alerts 0 }} {{$alert0.labels.alertname}}

戻り値：

Container memory usage exceeds 80%

例 1: アラートイベントの severity ラベルの値が warning の場合、P3 alert を出力します。

{{if eq "warning" .commonLabels.severity }} P3 alert {{ end }}

戻り値：

P3 alert

例 2: アラートイベントの severity ラベルの値が critical の場合、P1 alert を出力します。それ以外の場合、P2 alert を出力します。

{{if eq "critical" .commonLabels.severity }} P1 alert {{ else }} P2 alert {{ end }}

戻り値：

P2 alert

例 1: alerts リストを反復処理して、各アラートの alertname を取得します。

{{ for .alerts}} {{.labels.alertname}} \n {{end}}

戻り値：

Container memory usage exceeds 80%
 

例 1：リストを反復処理して、各要素のインデックスと値を取得します。

{{ range $index, $alert := .alerts }}Index {{ $index }}: {{ $alert.labels.alertname }}\n{{ end }}

戻り値：

Index 0: Container memory usage exceeds 80% 

例 1： alerts リストから最初の要素を取得し、$alert0 に割り当てます。

{{ $alert0 := index .alerts 0 }} {{$alert0.labels.alertname}}

戻り値：

Container memory usage exceeds 80%

例：commonLabels 内の severity ラベルの値が warning と等しい場合、P3 alert を出力します。

{{if eq "warning" .commonLabels.severity }} P3 alert {{ end }}

戻り値：

P3 alert

例：commonLabels 内の severity ラベルの値が warning または warnning と等しい場合、P3 alert を出力します。

{{if or (eq "warning" .commonLabels.severity) (eq "warnning" .commonLabels.severity) }} P3 alert {{ end }}

戻り値：

P3 alert

例: alerts リストの最初のアラートの value を、小数点以下 2 桁にフォーマットして出力します。

{{ $alert0 := index .alerts 0 }} {{ printf "%.2f" $alert0.annotations.value }}

戻り値：

15.52

例：文字列 "0.95332123123124" を、より読みやすいパーセンテージに変換します。

{{ "0.95332123123124" | humanizePercentage }}

戻り値：

95.33%

例：タイムスタンプ 1671074058234 を日付に変換します。

{{ "1671074058234" | humanizeDate }}

戻り値：

2022-12-15 11:14:18

例：alerts リストの長さを取得します。

{{ len .alerts }}

戻り値：

1

表示結果の例：

Alert name: Container memory usage exceeds 80%
Cluster name: klyz1688-kubernetes-1
Notification policy: notification policy name
Alert time: 2023-02-22 07:18:15
Alert content: Namespace: arms-prom / Pod: kube-state-metrics-ccb59dbff-jljg4 / Container: kube-state-metrics memory usage has exceeded 80%, current value 15.52%

出力は Markdown で表示されます。機能のサポート状況はチャットボットによって異なります。

• ブロッククォート: >

• フォント色：

  <font color='#ff0000'>root cause</font>

  説明

  フォント色の変更をサポートしているのは DingTalk と WeCom のみです。Lark はサポートしていません。

• 改行：

  • DingTalk：テンプレートに改行を 2 つ追加します。

  • Lark：テンプレートに改行を 1 つ追加します。

  • WeCom：テンプレートに改行を 1 つ追加します。

表示結果の例：

{
  "alert_name": "Container memory usage exceeds 80%",
  "cluster_name": "klyz1688-kubernetes-1",
  "notification_policy": "notification policy name",
  "alert_time": "2023-02-22 07:18:15",
  "alert_content": "Namespace: arms-prom / Pod: kube-state-metrics-ccb59dbff-jljg4 / Container: kube-state-metrics memory usage has exceeded 80%, current value 15.52%"
}