テンプレートの例

Prometheusは、アラートのアノテーションとラベル、および提供されるコンソールページでテンプレートをサポートしています。テンプレートは、ローカルデータベースに対してクエリを実行したり、データを反復処理したり、条件を使用したり、データをフォーマットしたりすることができます。Prometheusのテンプレート言語は、Goテンプレートシステムに基づいています。

シンプルなアラートフィールドテンプレート

alert: InstanceDown
expr: up == 0
for: 5m
labels:
  severity: page
annotations:
  summary: "Instance {{$labels.instance}} down"
  description: "{{$labels.instance}} of job {{$labels.job}} has been down for more than 5 minutes."

アラートフィールドテンプレートは、アラートが発動するたびに、各ルールイテレーション中に実行されるため、クエリとテンプレートは軽量に保ってください。より複雑なアラートテンプレートが必要な場合は、代わりにコンソールへのリンクをお勧めします。

シンプルなイテレーション

これは、インスタンスのリストと、それらが稼働しているかどうかを表示します。

{{ range query "up" }}
  {{ .Labels.instance }} {{ .Value }}
{{ end }}

特別な.変数は、各ループイテレーションの現在のサンプルの値を含みます。

1つの値を表示

{{ with query "some_metric{instance='someinstance'}" }}
  {{ . | first | value | humanize }}
{{ end }}

GoとGoのテンプレート言語は両方とも厳密に型付けされているため、実行エラーを避けるためにサンプルが返されたことを確認する必要があります。これは、スクレイピングやルール評価がまだ実行されていない場合や、ホストがダウンしている場合などに発生する可能性があります。

付属のprom_query_drilldownテンプレートはこれを処理し、結果の書式設定、および式ブラウザへのリンクを可能にします。

コンソールURLパラメータの使用

{{ with printf "node_memory_MemTotal{job='node',instance='%s'}" .Params.instance | query }}
  {{ . | first | value | humanize1024 }}B
{{ end }}

console.html?instance=hostnameとしてアクセスされた場合、.Params.instanceはhostnameと評価されます。

高度なイテレーション

<table>
{{ range printf "node_network_receive_bytes{job='node',instance='%s',device!='lo'}" .Params.instance | query | sortByLabel "device"}}
  <tr><th colspan=2>{{ .Labels.device }}</th></tr>
  <tr>
    <td>Received</td>
    <td>{{ with printf "rate(node_network_receive_bytes{job='node',instance='%s',device='%s'}[5m])" .Labels.instance .Labels.device | query }}{{ . | first | value | humanize }}B/s{{end}}</td>
  </tr>
  <tr>
    <td>Transmitted</td>
    <td>{{ with printf "rate(node_network_transmit_bytes{job='node',instance='%s',device='%s'}[5m])" .Labels.instance .Labels.device | query }}{{ . | first | value | humanize }}B/s{{end}}</td>
  </tr>{{ end }}
</table>

ここでは、すべてのネットワークデバイスを繰り返し処理し、それぞれのネットワークトラフィックを表示します。

rangeアクションは変数を指定しないため、.がループ変数となるため、ループ内で.Params.instanceは利用できません。

再利用可能なテンプレートの定義

Prometheusは、再利用可能なテンプレートの定義をサポートしています。これは、コンソールライブラリのサポートと組み合わせることで、コンソール間でテンプレートを共有できるため、特に強力です。

{{/* Define the template */}}
{{define "myTemplate"}}
  do something
{{end}}

{{/* Use the template */}}
{{template "myTemplate"}}

テンプレートは1つの引数に制限されています。args関数を使用して、複数の引数をラップできます。

{{define "myMultiArgTemplate"}}
  First argument: {{.arg0}}
  Second argument: {{.arg1}}
{{end}}
{{template "myMultiArgTemplate" (args 1 2)}}