Deployerでデプロイ時にGrafanaのアノテーションをつける

Deployer

今作っているLaravelのプロジェクトはそれほど大きくないのでDeployerを使ってデプロイしています。
Zabbixを使ってAPサーバーとDBサーバーのメトリクスを取っているのでGrafanaを使ってダッシュボードを作っています。
最近Grafanaにアノテーションを追加するAPIが追加されました。
GrafanaにアノテーションをつけるAPIはこちらで簡単な記事にしましたのでご参照ください。

Deployerでデプロイした時にアノテーションつけれるといいなーと思ってDeployerのrecipesみてみたのですがなかったので既存のrecipesを参考にして作ってプルリクしたらマージしてもらえました。
Add grafana recipe and documentation
もしかしたら次のバージョンで配布されるかも・・・。

使い方

簡単な使い方。
設定するまえにGrafanaでAPIキーを取得しておきます。

deploy.phpに以下のように記載します。

set('grafana', [
    'token' => 'tokenを設定する',
    'url' => 'http://grafanaのIP or hostname/api/annotations',
    'tags' => ['deploy', 'production'], // 適当に
]);
after('success', 'grafana:annotation');

これでdeployタスクが成功するとsuccessタスク後にGrafanaにアノテーションが作成されます。

アノテーションがあるとデプロイした後に5xxのhttpステータスコードが増えたときに、あれいつデプロイしたっけ?みたいなことが少なくなると思います。