翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# 通知のカスタマイズ
****
このドキュメントのトピックは、**Grafana バージョン 9.x** をサポートする Grafana ワークスペース向けです。
Grafana バージョン 10.x をサポートする Grafana ワークスペースについては、「[Grafana バージョン 10 での作業](using-grafana-v10.md)」を参照してください。
Grafana バージョン 8.x をサポートする Grafana ワークスペースについては、「[Grafana バージョン 8 での作業](using-grafana-v8.md)」を参照してください。
通知テンプレートを使用して、通知をカスタマイズします。
通知テンプレートを使用して、通知内のメッセージのタイトル、メッセージ、形式を変更できます。
通知テンプレートは、E メールや Slack などの特定のコンタクトポイント統合には関連付けられていません。ただし、異なるコンタクトポイント統合用に個別の通知テンプレートを作成することもできます。
通知テンプレートを使用すると、次のことができます。
+ 概要、説明、ラベルと注釈、値、リンクなど、通知内の情報を追加、削除、または並べ替える
+ テキストを太字と斜体で書式設定し、改行を追加または削除する
通知テンプレートを次の目的には使用できません。
+ Slack や Microsoft Teams などのインスタントメッセージングサービスで通知のデザインを変更する
**Topics**
+ [Go のテンプレート言語の使用](v9-alerting-notifications-go-templating.md)
+ [通知テンプレートの作成](v9-alerting-create-templates.md)
+ [テンプレートリファレンス](v9-alerting-template-reference.md)
# Go のテンプレート言語の使用
****
このドキュメントのトピックは、**Grafana バージョン 9.x** をサポートする Grafana ワークスペース向けです。
Grafana バージョン 10.x をサポートする Grafana ワークスペースについては、「[Grafana バージョン 10 での作業](using-grafana-v10.md)」を参照してください。
Grafana バージョン 8.x をサポートする Grafana ワークスペースについては、「[Grafana バージョン 8 での作業](using-grafana-v8.md)」を参照してください。
Go のテンプレート言語である [text/template](https://pkg.go.dev/text/template) で通知テンプレートを書き込みます。
このセクションでは、Go のテンプレート言語の概要と、text/template でのテンプレートの作成について説明します。
## dot
text/template には dot と呼ばれる特別なカーソルがあり、`.` として記述されます。このカーソルは、テンプレート内の使用場所に応じて値が変化する変数と考えることができます。例えば、通知テンプレートの開始時に `.` は、`Alerts`、`Status`、`GroupLabels`、`CommonLabels`、`CommonAnnotations` および `ExternalURL` を含む多数のフィールドを含む `ExtendedData` オブジェクトを参照します。ただし、dot は、リスト上の `range` で使用される場合、`with` 内で使用される場合、または他のテンプレートで使用する機能テンプレートを記述する場合、他の何かを参照する場合があります。これの例は [通知テンプレートの作成](v9-alerting-create-templates.md) で、すべてのデータと関数は [テンプレートリファレンス](v9-alerting-template-reference.md) で確認できます。
## 開始と終了のタグ
テキスト/テンプレートでは、テンプレートが変数を印刷するか、if ステートメントなどのコントロール構造を実行するかに関係なく、テンプレートは `{{`で始まり、`}}` で終わります。これは、変数の出力に `{{` と `}}` を使用し、制御構造に `{%` と `%}` を使用する Jinja などの他のテンプレート言語とは異なります。
## 印刷
何かの値を印刷するには、`{{` と `}}` を使用します。dot の値、dot のフィールド、関数の結果、[[変数]](#v9-go-variables)の値を印刷できます。例えば、dot が `ExtendedData` を参照する `Alerts` フィールドを印刷するには、次のように記述します。
```
{{ .Alerts }}
```
## アラートを反復処理する
アラートに関するすべての情報ではなく、各アラートのラベルのみを印刷するには、`range` を使用して `ExtendedData` でアラートを反復処理できます。
```
{{ range .Alerts }}
{{ .Labels }}
{{ end }}
```
範囲内の dot は、`ExtendedData` ではなく `Alert` を参照します。`{{ .Labels }}` を使用して、各アラートのラベルを印刷できます。これは、アラートのリスト内の現在のアラートを参照するように `{{ range .Alerts }}` が dot を変えるために機能します。範囲が終了すると、dot は範囲の開始前に存在していた値にリセットされます。この例では `ExtendedData` です。
```
{{ range .Alerts }}
{{ .Labels }}
{{ end }}
{{/* does not work, .Labels does not exist here */}}
{{ .Labels }}
{{/* works, cursor was reset */}}
{{ .Status }}
```
## 注釈とラベルを反復処理する
各アラートのラベルを `The name of the label is $name, and the value is $value` の形式で印刷するテンプレートを書きましょう。ここで、`$name` と `$value` には各ラベルの名前と値が含まれます。
前の例と同様に、`.Alerts` の範囲を使用して のアラートを繰り返し、dot がアラートのリスト内の現在のアラートを参照するようにし、ソートされたラベルで 2 番目の範囲を使用して、dot が現在のラベルを参照するように 2 回目に更新されます。2 番目の範囲内では、 `.Name` と `.Value` を使用して各ラベルの名前と値を出力します。
```
{{ range .Alerts }}
{{ range .Labels.SortedPairs }}
The name of the label is {{ .Name }}, and the value is {{ .Value }}
{{ end }}
{{ range .Annotations.SortedPairs }}
The name of the annotation is {{ .Name }}, and the value is {{ .Value }}
{{ end }}
{{ end }}
```
## If ステートメント
テンプレートでは if ステートメントを使用できます。例えば、`.Alerts` にアラートがない場合に `There are no alerts` を出力するには、次のように記述します。
```
{{ if .Alerts }}
There are alerts
{{ else }}
There are no alerts
{{ end }}
```
## With
With は if ステートメントと似ていますが、if ステートメントとは異なり、`with` は dot を更新して with の値を参照します。
```
{{ with .Alerts }}
There are {{ len . }} alert(s)
{{ else }}
There are no alerts
{{ end }}
```
## [変数]
text/template の変数は、テンプレート内に作成する必要があります。例えば、`$variable` という変数を現在の dot の値で作成するには、次のように記述します。
```
{{ $variable := . }}
```
範囲内の `$variable` または `with` を使用でき、これらは変数が定義された時点の dot の値を参照します。dot の現在の値は参照されません。
例えば、2 番目の範囲で `{{ .Labels }}` を使用するテンプレートを記述することはできません。ここでは、現在のアラートではなく、現在のラベルが dot で参照されるためです。
```
{{ range .Alerts }}
{{ range .Labels.SortedPairs }}
{{ .Name }} = {{ .Value }}
{{/* does not work because in the second range . is a label not an alert */}}
There are {{ len .Labels }}
{{ end }}
{{ end }}
```
これを修正するには、最初の範囲と 2 番目の範囲の前に `$alert` という変数を定義します。
```
{{ range .Alerts }}
{{ $alert := . }}
{{ range .Labels.SortedPairs }}
{{ .Name }} = {{ .Value }}
{{/* works because $alert refers to the value of dot inside the first range */}}
There are {{ len $alert.Labels }}
{{ end }}
{{ end }}
```
## インデックスを含む範囲
範囲の開始時にインデックス変数と値変数を定義することで、範囲内の各アラートのインデックスを取得できます。
```
{{ $num_alerts := len .Alerts }}
{{ range $index, $alert := .Alerts }}
This is alert {{ $index }} out of {{ $num_alerts }}
{{ end }}
```
## テンプレートの定義
`define` とテンプレートの名前を二重引用符で囲むことで、他のテンプレート内で使用できるテンプレートを定義できます。`__subject`、`__text_values_list`、`__text_alert_list`、`default.title`、`default.message` などのデフォルトテンプレートを含め、他のテンプレートと同じ名前のテンプレートを設定しないでください。デフォルトテンプレートと同じ名前のテンプレート、または別の通知テンプレート内のテンプレートと同じ名前で作成されている場合、Grafana はいずれかのテンプレートを使用することになり、混乱が生じます。Grafana は、同じ名前のテンプレートが 2 つ以上ある場合、エラーメッセージを返しません。
```
{{ define "print_labels" }}
{{ end }}
```
## テンプレートを埋め込む
`template`、二重引用符で囲まれたテンプレートの名前、およびテンプレートに渡されるカーソルを使用して、テンプレート内で定義されたテンプレートを埋め込むことができます。
```
{{ template "print_labels" . }}
```
## テンプレートにデータを渡す
テンプレート内では、dot はテンプレートに渡される値を参照します。
例えば、テンプレートに発射アラートのリストが渡された場合、dot は発射アラートのリストを参照します。
```
{{ template "print_alerts" .Alerts }}
```
テンプレートにアラートのソート済みラベルが渡された場合、dot はソート済みラベルのリストを参照します。
```
{{ template "print_labels" .SortedLabels }}
```
これは、再利用可能なテンプレートを記述する場合に役立ちます。例えば、すべてのアラートを出力するには、次のように記述します。
```
{{ template "print_alerts" .Alerts }}
```
次に、発射アラートのみを出力するには、次のように記述します。
```
{{ template "print_alerts" .Alerts.Firing }}
```
これは、`.Alerts` と `.Alerts.Firing` の両方がアラートのリストであるために機能します。
```
{{ define "print_alerts" }}
{{ range . }}
{{ template "print_labels" .SortedLabels }}
{{ end }}
{{ end }}
```
## コメント
`{{/*` および `*/}}` を使用してコメントを追加できます。
```
{{/* This is a comment */}}
```
コメントが改行を追加しないようにするには、以下を使用します。
```
{{- /* This is a comment with no leading or trailing line breaks */ -}}
```
## インデント
タブとスペースの両方のインデントと改行を使用して、テンプレートをより読みやすくすることができます。
```
{{ range .Alerts }}
{{ range .Labels.SortedPairs }}
{{ .Name }} = {{ .Value }}
{{ end }}
{{ end }}
```
ただし、テンプレートのインデントはテキストにも適用されます。次に、削除する方法を説明します。
## スペースと改行を削除する
text/template では、 `{{-` と `-}}` を使用して、先頭と末尾のスペースと改行を削除します。
例えば、インデントと改行を使用してテンプレートをより読みやすくする場合です。
```
{{ range .Alerts }}
{{ range .Labels.SortedPairs }}
{{ .Name }} = {{ .Value }}
{{ end }}
{{ end }}
```
インデントと改行はテキストにも表示されます。
```
alertname = "Test"
grafana_folder = "Test alerts"
```
各範囲の先頭の `}}` を `-}}` に変更することで、テキストからインデントと改行を削除できます。
```
{{ range .Alerts -}}
{{ range .Labels.SortedPairs -}}
{{ .Name }} = {{ .Value }}
{{ end }}
{{ end }}
```
これにより、テンプレートのインデントと改行がテキストから取り除かれます。
```
alertname = "Test"
grafana_folder = "Test alerts"
```
# 通知テンプレートの作成
****
このドキュメントのトピックは、**Grafana バージョン 9.x** をサポートする Grafana ワークスペース向けです。
Grafana バージョン 10.x をサポートする Grafana ワークスペースについては、「[Grafana バージョン 10 での作業](using-grafana-v10.md)」を参照してください。
Grafana バージョン 8.x をサポートする Grafana ワークスペースについては、「[Grafana バージョン 8 での作業](using-grafana-v8.md)」を参照してください。
コンタクトポイントに送信するため、再利用可能な通知テンプレートを作成できます。
通知テンプレートには 1 つ以上のテンプレートを追加できます。
通知テンプレート名は、一意である必要があります。同じ通知テンプレートまたは異なる通知テンプレートに、同じ名前のテンプレートを 2 つ使用することはできません。`__subject`、`__text_values_list`、`__text_alert_list`、`default.title`、`default.message` などのデフォルトテンプレートと同じ名前のテンプレートを定義しないでください。
[コンタクトポイント] タブには、通知テンプレートのリストが表示されます。
## 通知テンプレートの作成
**通知テンプレートを作成するには**
1. **[テンプレートの追加]** をクリックします。
1. `email.subject` などの通知テンプレートの名前を選択します。
1. テンプレートの内容をコンテンツフィールドに書き込みます。
例えば、次のようになります。
```
{{ if .Alerts.Firing -}}
{{ len .Alerts.Firing }} firing alerts
{{ end }}
{{ if .Alerts.Resolved -}}
{{ len .Alerts.Resolved }} resolved alerts
{{ end }}
```
1. 保存をクリックします。
`{{ define "email.subject" }}` (`email.subject` はテンプレートの名前) と `{{ end }}` はコンテンツの先頭と末尾に自動的に追加されます。
**複数のテンプレートを含む通知テンプレートを作成するには**
1. **[テンプレートの追加]** をクリックします。
1. 通知テンプレート全体の名前を入力します。例えば、`email`。
1. 各テンプレートの最初と最後に `{{ define "name-of-template" }}` と `{{ end }}` を含む各テンプレートをコンテンツフィールドに書き込みます。`email.subject` や `email.message` など、通知テンプレート内の各テンプレートにわかりやすい名前を使用できます。この場合、上記で入力した通知テンプレートの名前は再度使用しないでください。
次のセクションでは、作成するテンプレートの詳細な例を示します。
1. 保存をクリックします。
## E メールの件名テンプレートの作成
この例では、発射アラートと解決済みアラートの数を含む E メールの件名のテンプレートを作成します。
```
1 firing alerts, 0 resolved alerts
```
**E メールの件名のテンプレートを作成するには**
1. `email.subject` というテンプレートを次の内容で作成します。
```
{{ define "email.subject" }}
{{ len .Alerts.Firing }} firing alerts, {{ len .Alerts.Resolved }} resolved alerts
{{ end }}
```
1. テンプレートは、キーワード `template` を使用して**件名**フィールドに配置して、コンタクトポイント統合を作成するときに使用します。
```
{{ template "email.subject" . }}
```
## E メールのメッセージ用のテンプレート作成
この例では、すべての発射アラートと解決済みアラートの概要を含む E メールのメッセージ用のテンプレートを作成します。
```
There are 2 firing alerts, and 1 resolved alerts
Firing alerts:
- alertname=Test 1 grafana_folder=GrafanaCloud has value(s) B=1
- alertname=Test 2 grafana_folder=GrafanaCloud has value(s) B=2
Resolved alerts:
- alertname=Test 3 grafana_folder=GrafanaCloud has value(s) B=0
```
**E メールのメッセージ用のテンプレートを作成するには**
1. `email` という名前の通知テンプレートを、コンテンツに `email.message_alert` と `email.message` という 2 つのテンプレートで作成します。
`email.message_alert` テンプレートは、`email.message` テンプレートに E メールの構造が含まれている間、各発射アラートと解決済みアラートのラベルと値を印刷するために使用されます。
```
{{- define "email.message_alert" -}}
{{- range .Labels.SortedPairs }}{{ .Name }}={{ .Value }} {{ end }} has value(s)
{{- range $k, $v := .Values }} {{ $k }}={{ $v }}{{ end }}
{{- end -}}
{{ define "email.message" }}
There are {{ len .Alerts.Firing }} firing alerts, and {{ len .Alerts.Resolved }} resolved alerts
{{ if .Alerts.Firing -}}
Firing alerts:
{{- range .Alerts.Firing }}
- {{ template "email.message_alert" . }}
{{- end }}
{{- end }}
{{ if .Alerts.Resolved -}}
Resolved alerts:
{{- range .Alerts.Resolved }}
- {{ template "email.message_alert" . }}
{{- end }}
{{- end }}
{{ end }}
```
1. テンプレートは、キーワード `template` を使用して**テキスト本文**フィールドに配置して、コンタクトポイント統合を作成するときに使用します。
```
{{ template "email.message" . }}
```
## Slack メッセージのタイトルのテンプレート作成
この例では、発射アラートと解決済みアラートの数を含む Slack メッセージのタイトルのテンプレートを作成します。
```
1 firing alerts, 0 resolved alerts
```
**Slack メッセージのタイトルのテンプレートを作成するには**
1. `slack.title` というテンプレートを次の内容で作成します。
```
{{ define "slack.title" }}
{{ len .Alerts.Firing }} firing alerts, {{ len .Alerts.Resolved }} resolved alerts
{{ end }}
```
1. テンプレートは、キーワード `template` を使用して**タイトル**フィールドに配置して、コンタクトポイント統合を作成するときに使用します。
```
{{ template "slack.title" . }}
```
## Slack メッセージのコンテンツのテンプレート作成
すべての発射アラートと解決済みアラートの説明 (ラベル、注釈、ダッシュボード URL など) を含む Slack メッセージのコンテンツのテンプレートを作成します。
```
1 firing alerts:
[firing] Test1
Labels:
- alertname: Test1
- grafana_folder: GrafanaCloud
Annotations:
- description: This is a test alert
Go to dashboard: https://example.com/d/dlhdLqF4z?orgId=1
1 resolved alerts:
[firing] Test2
Labels:
- alertname: Test2
- grafana_folder: GrafanaCloud
Annotations:
- description: This is another test alert
Go to dashboard: https://example.com/d/dlhdLqF4z?orgId=1
```
**Slack メッセージのコンテンツのテンプレートを作成するには**
1. コンテンツに `slack.print_alert` と`slack.message` の 2 つのテンプレートを使用して、`slack` という名前のテンプレートを作成します。
`slack.print_alert` テンプレートはラベル、注釈、および DashboardURL の印刷に使用され、`slack.message` テンプレートには通知の構造が含まれます。
```
{{ define "slack.print_alert" -}}
[{{.Status}}] {{ .Labels.alertname }}
Labels:
{{ range .Labels.SortedPairs -}}
- {{ .Name }}: {{ .Value }}
{{ end -}}
{{ if .Annotations -}}
Annotations:
{{ range .Annotations.SortedPairs -}}
- {{ .Name }}: {{ .Value }}
{{ end -}}
{{ end -}}
{{ if .DashboardURL -}}
Go to dashboard: {{ .DashboardURL }}
{{- end }}
{{- end }}
{{ define "slack.message" -}}
{{ if .Alerts.Firing -}}
{{ len .Alerts.Firing }} firing alerts:
{{ range .Alerts.Firing }}
{{ template "slack.print_alert" . }}
{{ end -}}
{{ end }}
{{ if .Alerts.Resolved -}}
{{ len .Alerts.Resolved }} resolved alerts:
{{ range .Alerts.Resolved }}
{{ template "slack.print_alert" .}}
{{ end -}}
{{ end }}
{{- end }}
```
1. テンプレートは、キーワード `template` を使用して**テキスト本文**フィールドに配置して、コンタクトポイント統合を作成するときに使用します。
```
{{ template "slack.message" . }}
```
## 共有テンプレートを使用して E メールと Slack の両方にテンプレートを作成する
E メールや Slack など、コンタクトポイントごとに個別の通知テンプレートを作成する代わりに、同じテンプレートを共有できます。
例えば、この件名の E メールを送信し、このタイトル `1 firing alerts, 0 resolved alerts` の Slack メッセージを送信する場合は、共有テンプレートを作成できます。
**共有テンプレートを作成するには**
1. `common.subject_title` というテンプレートを次の内容で作成します。
```
{{ define "common.subject_title" }}
{{ len .Alerts.Firing }} firing alerts, {{ len .Alerts.Resolved }} resolved alerts
{{ end }}
```
1. E メールの場合は、E メールコンタクトポイント統合の件名フィールドからテンプレートを実行します。
```
{{ template "common.subject_title" . }}
```
1. Slack の場合は、Slack コンタクトポイント統合のタイトルフィールドからテンプレートを実行します。
```
{{ template "common.subject_title" . }}
```
## 通知テンプレートの使用
コンタクトポイントのテンプレートを使用して通知をカスタマイズします。
**コンタクトポイントの作成時にテンプレートを使用するには**
1. **[アラート]**メニューから、**[コンタクトポイント]** を選択して、既存のコンタクトポイントのリストを表示します。
1. **[コンタクトポイントを追加]** を選択します。または、編集するコンタクトポイントの横にある **[編集]** アイコン (ペン) を選択して、既存のコンタクトポイントを編集することもできます。
1. **[Message]** (メッセージ) や **[Subject]** (件名) などの 1 つ以上のフィールドに、使用するテンプレートを入力します。テンプレートを入力するには、`{{ template "template_name" . }}` フォームを使用し、 *template\$1name* を使用するテンプレートの名前に置き換えます。
1. **[コンタクトポイントの保存]** をクリックします。
# テンプレートリファレンス
****
このドキュメントのトピックは、**Grafana バージョン 9.x** をサポートする Grafana ワークスペース向けです。
Grafana バージョン 10.x をサポートする Grafana ワークスペースについては、「[Grafana バージョン 10 での作業](using-grafana-v10.md)」を参照してください。
Grafana バージョン 8.x をサポートする Grafana ワークスペースについては、「[Grafana バージョン 8 での作業](using-grafana-v8.md)」を参照してください。
このセクションでは、テンプレートを作成するためのリファレンス情報を提供します。
## テンプレートのデータ
メッセージテンプレートには、次のデータが渡されます。
| 名前 | 型 | 注意事項 |
| --- | --- | --- |
| `Receiver` | string | コンタクトポイント (通知先) の名前。 |
| `Status` | string | 少なくとも 1 つのアラートが発生している場合は「発生中」となり、それ以外の場合「解決済」となります。 |
| `Alerts` | アラート | この通知に含まれるアラートオブジェクトのリスト (以下を参照)。 |
| `GroupLabels` | KeyValue | これらのアラートがグループ化されたラベル。 |
| `CommonLabels` | KeyValue | この通知に含まれるすべてのアラートに共通のラベル。 |
| `CommonAnnotations` | KeyValue | この通知に含まれるすべてのアラートに共通する注釈。 |
| `ExternalURL` | string | 通知の送信元である Grafana へのリンク。外部のアラートマネージャーを使用している場合、そのアラートマネージャーへのリンク。 |
`Alerts` 型には、返されたアラートをフィルタリングするための 2 つの関数があります。
+ `Alerts.Firing` – 発生中のアラートのリストを返します。
+ `Alerts.Resolved` – 解決済みのアラートのリストを返します。
**アラート (型)**
アラート型には、次のデータがあります。
| 名前 | 型 | 注意事項 |
| --- | --- | --- |
| ステータス | string | `firing` または `resolved` |
| ラベル | KeyValue | アラートに付与された一連のラベル。 |
| 注釈 | KeyValue | アラートに付与された一連の注釈。 |
| 値 | KeyValue | クラシック条件を含むすべての式の値 |
| StartsAt | time.Time | アラートが発行された時刻。 |
| EndsAt | time.Time | アラートの終了時刻がわかっている場合にのみ設定されます。それ以外の場合、最後にアラートを受信してから設定可能なタイムアウト期間が適用されます。 |
| GeneratorURL | string | Grafana または外部アラートマネージャーへのリンク。 |
| SilenceURL | string | アラートをサイレンスするリンク (このアラートのラベルがあらかじめ入力されています)。Grafana 管理のアラートのみ。 |
| DashboardURL | string | Grafana ダッシュボードへのリンク (アラートルールが Grafana に属している場合)。Grafana 管理のアラートのみ。 |
| PanelURL | string | Grafana ダッシュボードパネルへのリンク (アラートルールが Grafana に属している場合)。Grafana 管理のアラートのみ。 |
| Fingerprint | string | アラートの識別に使用するフィンガープリント。 |
| ValueString | string | アラート内の各削減された式のラベルと値を含む文字列。 |
**ExtendedData**
ExtendedData オブジェクトには、以下のプロパティが含まれています。
| 名前 | [Kind] (種類) | 説明 | 例 |
| --- | --- | --- | --- |
| レシーバー | `string` | 通知を送信するコンタクトポイントの名前。 | `{{ .Receiver }}` |
| ステータス | `string` | ステータスは`firing if at least one alert is firing, otherwise resolved.`です。 | `{{ .Status }}` |
| アラート | `[]Alert` | この通知のすべての発生アラートと解決済みアラートのリスト。 | `There are {{ len .Alerts }} alerts` |
| 発生アラート | `[]Alert` | この通知のすべての発生アラートのリスト。 | `There are {{ len .Alerts.Firing }} firing alerts` |
| 解決済みアラート | `[]Alert` | この通知で解決されたすべてのアラートのリスト。 | `There are {{ len .Alerts.Resolved }} resolved alerts` |
| GroupLabels | `KeyValue` | これらのアラートをこの通知にグループ化するラベル。 | `{{ .GroupLabels }}` |
| CommonLabels | `KeyValue` | この通知のすべてのアラートに共通するラベル。 | `{{ .CommonLabels }}` |
| CommonAnnotations | `KeyValue` | この通知のすべてのアラートに共通する注釈。 | `{{ .CommonAnnotations }}` |
| ExternalURL | `string` | この通知を送信した Grafana ワークスペースまたはアラートマネージャーへのリンク。 | `{{ .ExternalURL }}` |
**KeyValue 型**
`KeyValue` 型は、キー (ラベル) 値 (注釈) の文字列を組み合わせたものです。
`KeyValue` として保存されたデータに直接アクセスするメソッドだけでなく、データをソート、削除、変換するメソッドも備えています。
| 名前 | 引数 | 戻り値 | 注意事項 | 例 |
| --- | --- | --- | --- | --- |
| SortedPairs | | キーと値の文字列のソート済みのリスト | | `{{ .Annotations.SortedPairs }}` |
| 削除 | []string | KeyValue | 指定したキーを除いたキー/値のマップのコピーを返します。 | `{{ .Annotations.Remove "summary" }}` |
| 名前 | | []string | ラベル名のリスト | `{{ .Names }}` |
| 値 | | []string | ラベル値のリスト | `{{ .Values }}` |
**[時間]**
時間は Go [https://pkg.go.dev/time#Time](https://pkg.go.dev/time#Time) パッケージからのものです。時間はさまざまな形式で印刷できます。例えば、アラートが発生した時刻を `Monday, 1st January 2022 at 10:00AM` 形式で出力するには、次のテンプレートを作成します。
```
{{ .StartsAt.Format "Monday, 2 January 2006 at 3:04PM" }}
```
Go の時間形式に関するリファレンスは、[こちら](https://pkg.go.dev/time#pkg-constants)を参照してください。
## テンプレート関数
テンプレート関数を使用すると、ラベルと注釈を処理して動的に通知を生成できます。以下の機能を使用できます。
| 名前 | 引数の型 | 戻り型 | 説明 |
| --- | --- | --- | --- |
| `humanize` | 数値または文字列 | string | メトリクスプレフィックスを使用して、数値をより読み取り可能な形式に変換します。 |
| `humanize1024` | 数値または文字列 | string | humanize と同様に、1000 ではなく 1024 を基準にします。 |
| `humanizeDuration` | 数値または文字列 | string | 時間を秒単位のより読みやすい形式に変換します。 |
| `humanizePercentage` | 数値または文字列 | string | 比率の値を 100 分の 1 の形に変換します。 |
| `humanizeTimestamp` | 数値または文字列 | string | Unix のタイムスタンプを秒単位のより読みやすい形式に変換します。 |
| `title` | string | string | strings.Title を使用すると、各単語の最初の文字が大文字になります。 |
| `toUpper` | string | string | strings.ToUpper を使用すると、文字列がすべて大文字に変換されます。 |
| `toLower` | string | string | strings.ToLower を使用すると、文字列がすべて小文字に変換されます。 |
| `match` | パターン、テキスト | ブール値 | regexp.MatchString を使用すると、アンカーなしでの正規表現の一致テストを実行できます。 |
| `reReplaceAll` | パターン、置換、テキスト | string | Regexp.ReplaceAllString を使用すると、アンカーなしでの正規表現による置換が実行できます。 |
| `graphLink` | 文字列 - `expr` および `datasource` フィールドを持つ JSON オブジェクト | string | 指定された式とデータソースに対するグラフィカルビューへのパスを返します。 |
| `tableLink` | 文字列 - `expr` および `datasource` フィールドを持つ JSON オブジェクト | string | 指定された式とデータソースに対するタブ形式ビューへのパスを返します。 |
| `args` | []interface\$1\$1 | map[string]interface\$1\$1 | オブジェクトのリストを arg0、arg1 などのキーを持つマップに変換します。複数の引数をテンプレートに渡す場合、この関数を使用します。 |
| `externalURL` | なし | string | 外部 URL を表す文字列を返します。 |
| `pathPrefix` | なし | string | 外部 URL のパスを返します。 |
次の表に、各関数の使用例を紹介します。
| 関数 | TemplateString | Input | 予想 |
| --- | --- | --- | --- |
| humanize | \$1 humanize \$1value \$1 | 1234567.0 | 1.235M |
| humanize1024 | \$1 humanize1024 \$1value \$1 | 1048576.0 | 1Mi |
| humanizeDuration | \$1 humanizeDuration \$1value \$1 | 899.99 | 14 分 59 秒 |
| humanizePercentage | \$1 humanizePercentage \$1value \$1 | 0.1234567 | 12.35% |
| humanizeTimestamp | \$1 humanizeTimestamp \$1value \$1 | 1435065584.128 | 2015-06-23 13:19:44.128 \$10000 UTC |
| title | \$1 \$1value \$1 title \$1 | aa bB CC | Aa Bb Cc |
| toUpper | \$1 \$1value \$1 toUpper \$1 | aa bB CC | AA BB CC |
| toLower | \$1 \$1value \$1 toLower \$1 | aa bB CC | aa bb cc |
| match | \$1 match "a\$1" \$1labels.instance \$1 | aa | 真 |
| reReplaceAll | \$1\$1 reReplaceAll "localhost:(.\$1)" "my.domain:\$11" \$1labels.instance \$1\$1 | localhost:3000 | my.domain:3000 |
| graphLink | \$1\$1 graphLink "\$1\$1"expr\$1": \$1"up\$1", \$1"datasource\$1": \$1"gdev-prometheus\$1"\$1" \$1\$1 | | /explore?left=["now-1h","now","gdev-prometheus",\$1"datasource":"gdev-prometheus","expr":"up","instant":false,"range":true\$1] |
| tableLink | \$1\$1 tableLink "\$1\$1"expr\$1":\$1"up\$1", \$1"datasource\$1":\$1"gdev-prometheus\$1"\$1" \$1\$1 | | /explore?left=["now-1h","now","gdev-prometheus",\$1"datasource":"gdev-prometheus","expr":"up","instant":true,"range":false\$1] |
| args | \$1\$1define "x"\$1\$1\$1\$1.arg0\$1\$1 \$1\$1.arg1\$1\$1\$1\$1end\$1\$1\$1\$1template "x" (args 1 "2")\$1\$1 | | 1 2 |
| externalURL | \$1 externalURL \$1 | | http://localhost/path/prefix |
| pathPrefix | \$1 pathPrefix \$1 | | /path/prefix |