client_golangを使ってPrometheusのtext formatに即したファイルを生成する

以下のツイートをして早二月が経過しようとしていたので、慌ててBlogを起こしている。先月は時間に余裕があったので勝手に達成していたが、今月はFF14のパッチ5.35が来たり仕事が忙しくて危うく10月が終わるところだった。殆どボズヤに籠もりっぱなしである。

月に一本は雑でも良いのでBlogを書くという目標を勝手に立てて勝手に完了した。

— silver_hawk(銀鷹) (@yutaka_j08) September 2, 2020

以下本題。

仕事で時折PrometheusのExporerを自作していたが、あまり乱立させるのもどうかと思い、node exporterのtextfile collectorを通して提供する形に変更する検証を行っていた。その際に、先行事例を調べたが、すぐ見つかる範囲ではシェルスクリプトやワンライナーを定期実行している事例が多く、client_golang を使った事例をあまり見かけなかったので簡単に記載する。

まず、大枠としてはWriteToTextfile を利用すれば良い。ドキュメントにも記載があるとおり、一時ファイルに書き込んだ後リネームするため細かいことを心配する必要も無い。

個人的に少し引っかかったのは、第二引数のGatherer で返却するdto.MetricFamily だった。

MetricFamilyを生成するための関数も無く、どのような形で生成するのがいいか迷っていたが、テストコード中でMetricFamilyを生成している箇所を発見して事なきを得た。

https://github.com/prometheus/client_golang/blob/v1.8.0/prometheus/registry_test.go#L73-L94

元がprotoファイルから生成されたモデルなので、proto.String 等を利用すれば良いらしい。せめて、ドキュメントのどこかに一言くらい言及があると嬉しかったかも知れない。

textfile collectorへの置き換え自体は完了していないので、今は掲載するコードがないが、終わった暁にはサンプルも掲載したい。（単に10月が終わりそうで間に合わないというのも大きいが･･･）