テンプレートリファレンス - Amazon Managed Grafana
テンプレートデータテンプレート関数

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

テンプレートリファレンス

このドキュメントトピックは、Grafana バージョン 9.x をサポートする Grafana ワークスペース向けに設計されています。

Grafana バージョン 10.x をサポートする Grafana ワークスペースについては、「」を参照してくださいGrafana バージョン 10 での作業。

Grafana バージョン 8.x をサポートする Grafana ワークスペースについては、「」を参照してくださいGrafana バージョン 8 での作業。

このセクションでは、テンプレートを作成するためのリファレンス情報を提供します。

テンプレートデータ

次のデータがメッセージテンプレートに渡されます。

名前 型 メモ

Receiver

string

通知の送信先の連絡先の名前。

Status

string

少なくとも 1 つのアラートが発せられている場合は発せられます。それ以外の場合は解決されます。

Alerts

アラート

この通知に含まれるアラートオブジェクトのリスト (以下を参照）。

GroupLabels

KeyValue

これらのアラートがグループ化されたラベル。

CommonLabels

KeyValue

この通知に含まれるすべてのアラートに共通するラベル。

CommonAnnotations

KeyValue

この通知に含まれるすべてのアラートに共通する注釈。

ExternalURL

string

通知を送信した Grafana へのバックリンク。外部 Alertmanager を使用している場合は、この Alertmanager へのリンクを戻します。

Alerts タイプは、返されたアラートをフィルタリングするための 2 つの関数を公開します。

  • Alerts.Firing – 発声アラートのリストを返します。

  • Alerts.Resolved – 解決されたアラートのリストを返します。

アラート (タイプ）

アラートタイプには、次のデータが含まれます。

名前 型 メモ

ステータス

string

firing-または-resolved

ラベル

KeyValue

アラートにアタッチされたラベルのセット。

‏注釈

KeyValue

アラートにアタッチされた注釈のセット。
[値] KeyValue Classic 条件を含むすべての式の値

StartsAt

時刻

アラートが発せられた時刻。

EndsAt

時刻

アラートの終了時刻がわかっている場合にのみ設定されます。それ以外の場合は、最後のアラートが受信されてから設定可能なタイムアウト期間に設定されます。

GeneratorURL

string

Grafana または外部 Alertmanager へのバックリンク。

SilenceURL

string

アラートを無音にするリンク (このアラートのラベルがあらかじめ入力されています）。Grafana マネージドアラートの場合のみ。

DashboardURL

string

アラートルールが 1 つに属している場合は、grafana ダッシュボードにリンクします。Grafana マネージドアラートの場合のみ。

PanelURL

string

アラートルールが 1 つに属している場合は、grafana ダッシュボードパネルにリンクします。Grafana マネージドアラートの場合のみ。

フィンガープリント

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 ワークスペースまたは Alertmanager へのリンク。

{{ .ExternalURL }}

KeyValue タイプ

KeyValue タイプは、ラベルと注釈を表すキーと値の文字列ペアのセットです。

として保存されたデータの直接アクセスに加えてKeyValue、データのソート、削除、変換の方法もあります。

名前 引数 戻り値 メモ 例

SortedPairs

キーと値の文字列ペアのソート済みリスト

{{ .Annotations.SortedPairs }}

Remove

[]文字列

KeyValue

指定されたキーなしでキー/値マップのコピーを返します。

{{ .Annotations.Remove "summary" }}

名前

[]文字列

ラベル名のリスト

{{ .Names }}

[値]

[]文字列

ラベル値のリスト

{{ .Values }}

Time (時間)

時間は Go timeパッケージからのものです。時刻はさまざまな形式で印刷できます。例えば、アラートが発生した時刻を 形式で出力するにはMonday, 1st January 2022 at 10:00AM、次のテンプレートを記述します。

{{ .StartsAt.Format "Monday, 2 January 2006 at 3:04PM" }}

Go の時刻形式のリファレンスは、 で確認できます。

テンプレート関数

テンプレート関数を使用すると、ラベルと注釈を処理して動的通知を生成できます。以下の関数を使用できます。

名前 引数の型 戻り型 説明

humanize

数値または文字列

string

メトリクスプレフィックスを使用して、数値をより読み取り可能な形式に変換します。

humanize1024

数値または文字列

string

ヒューマナイズと同様に、 は 1000 ではなく 1024 をベースとして使用します。

humanizeDuration

数値または文字列

string

時間を秒単位でより読み取りやすい形式に変換します。

humanizePercentage

数値または文字列

string

比率値を 100 の分数に変換します。

humanizeTimestamp

数値または文字列

string

Unix タイムスタンプを秒単位でより読みやすい形式に変換します。

title

string

string

strings.Title、各単語の最初の文字を大文字にします。

toUpper

string

string

strings。ToUpper、すべての文字を大文字に変換します。

toLower

string

string

strings。ToLower、すべての文字を小文字に変換します。

match

パターン、テキスト

ブール値

regexp. アンカーされていない regexp 一致のMatchString テスト。

reReplaceAll

パターン、置換、テキスト

string

Regexp.ReplaceAllString Regexp 置換、アンカーなし。

graphLink

string - exprおよび datasourceフィールドを含む JSON オブジェクト

string

指定された式とデータソースについて、Explore でグラフィカルビューへのパスを返します。

tableLink

string - exprおよび datasourceフィールドを含む JSON オブジェクト

string

指定された式とデータソースについて、Explore の表形式ビューへのパスを返します。

args

[]インターフェイス{}

map[string]interface{}

オブジェクトのリストを、arg0、arg1 などのキーを持つマップに変換します。この関数を使用して、複数の引数をテンプレートに渡します。

externalURL

なし

string

外部 URL を表す文字列を返します。

pathPrefix

なし

string

外部 URL のパスを返します。

次の表は、各関数の使用例を示しています。

機能 TemplateString 入力 予想

ヒューマナイズ

{ $value をヒューマナイズ}

1234567.0

1.235 メートル

humanize1024

{ humanize1024 $value }

1048576.0

1Mi

humanizeDuration

{ humanizeDuration $value }

899.99

14 分 59 秒

humanizePercentage

{ humanizePercentage $value }

0.1234567

12.35%

humanizeTimestamp

{ humanizeTimestamp $value }

1435065584.128

2015-06-23 13:19:44.128 +0000 UTC

title

{ $value | title }

aa bB CC

Aa Bb Cc

toUpper

{ $value | toUpper }

aa bB CC

AA BB CC

toLower

{ $value | toLower }

aa bB CC

aa bb cc

一致

{ 「a+」$labels.instance } に一致

aa

true

reReplaceAll

{{ reReplaceAll "localhost:(.*)" "my.domain:$1" $labels.instance }}

localhost:3000

my.domain:3000

graphLink

{{ graphLink "{\"expr\": \"up\", \"datasource\": \"gdev-prometheus\"}" }}

/explore?left=["now-1h"now"gdev-prometheus",{"datasource"gdev-prometheus"expr"up"instant":false,"range":true}]

tableLink

{{ tableLink "{\"expr\":\"up\", \"datasource\":\"gdev-prometheus\"}" }}

/explore?left=["now-1h"now"gdev-prometheus",{"datasource"gdev-prometheus"expr"up"instant":true,"range":false}]

args

{{define "x"}}{{.arg0}} {{.arg1}}{{end}}{{template "x" (args 1 "2")}}

1 2

externalURL

{ externalURL }

http://localhost/path/prefix

pathPrefix

{ pathPrefix }

/path/prefix