My External Storage

Feb 7, 2021 - 4 minute read - Comments - go newrelic o11y github

[Go] 新規追加した関数にNew RelicのSegmentを入れ忘れていたら警告するGitHub Actionsを作った

Goのアプリで新規関数を含むPull Requset（PR）を作ったとき、New RelicのSegmentをいれてなかったら怒るreviewdogのGitHub Actionsを作った。

TL;DR

実際のコメント

GitHub MarketPlaceにも公開している。

https://github.com/marketplace/actions/action-newrelic-segment-lint

Spanを計測していない関数を追加するPull Request（PR）はGitHub Checksで警告したい

New RelicでGoのアプリケーションのSpanを取得するには、関数やメソッドごとにSegmentsを明示的に埋め込んでいく必要がある。

func SampleHandler(w http.ResponseWriter, req *http.Request) {
  defer newrelic.FromContext(req.Context()).StartSegment("sample_handler").End()
  fmt.Fprintf(w, "Hello, %q", req.URL.Path)
}

以前、既存コードの関数やメソッドに対してFunctions Segmentを埋め込むnrsegコマンドを作った。

しかし、普段開発しているサービスが完全にコードフリーズされていることは少ないだろう。
我々は常にコードを変更したり、追加している。そのため、ある時点で存在するコードに対してだけでなく、今後追加されていく関数やメソッドもSpanを計測しているか確認していく必要がある。
そのため、GitHub Acrionsとreviewdogを使って「PRで追加された関数がSegmentを埋め込んでいなかったらエラーを返す」Actionを作成した。

このようなYAMLを.github/workflowディレクトリ以下に配置しておくだけで利用ができる。

name: nrseg
on: [pull_request]
jobs:
  linter_name:
    name: runner / nrseg inspect
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: budougumi0617/action-newrelic-segment-lint@v0
        with:
          github_token: ${{ secrets.github_token }}
          # 無視したいディレクトリと対象ディレクトリ
          nrseg_flags: "-i testing ./src"
          reporter: github-pr-review
          level: warning

実際の挙動はサンプルPRを見てもらったほうが早いだろう。

上記PRのコメントのように新しく追加されたコードの中でSegmentを呼んでいないコードに対して警告をコメントする。

実際のコメント

これで新しく追加される関数にSegmentが正しく宣言されているかチェックできる体制が作れる。

作ったときのTips

機能説明は以上なので、以降は作ったときのメモなど。

reviewdogを使ったActionsの作り方

PRで該当箇所にコメントするにはreviewdogを利用している。

reviewdogを使ったActionsはtemplateを使えばすぐ作れる。
バージョンアップをサポートするActionや、Action内で使うツールの更新を検知するActionなども一緒に定義されていてとても便利。

reviewdogに自作ツールの結果を読み込ませる

reviewdogが認識できる警告のフォーマットはREADMEの通り。

今回はgolangci-lintと同じ出力形式でエラーを出力しているのでreviewdogがサポートしてくれる。
注意点としてはエラー出力ではなく標準出力で解析結果を出力すること。

Actionsの動作確認をしたいとき

実際に別のリポジトリでActionsを動かしてみると思ったとおりに実行されなかったりすることがある。
そういうときはACTIONS_RUNNER_DEBUGとACTIONS_STEP_DEBUGというsecret定数をどちらも値をtrueで宣言する。 そうするとActionsの実行ログにデバッグ出力も表示されるようになる。

GitHubにリリースされた圧縮ファイルを実行するワンライナー

Actions内でgithub.com/budougumi0617/nrsegのリリースされているTarファイルを解凍して実行ファイルを使いたいとする。
このような場合以下のようなcURLコマンドを実行すると該当のTarファイルが取得できる。grepはUbuntuで実行可能なバイナリが入っている圧縮ファイル名前を確認すること。
Goのコマンドならバイナリさえリリースされていれば、特別なコンテナを用意せずにActionsが書ける。

TEMP_PATH="$(mktemp -d)"
PATH="${TEMP_PATH}:$PATH"

curl -L "$(curl -Ls https://api.github.com/repos/budougumi0617/nrseg/releases/latest | grep -o -E "https://.+?_Linux_x86_64.tar.gz")" -o nrseg.tar.gz
tar -zxvf nrseg.tar.gz -C "${TEMP_PATH}" 
rm nrseg.tar.gz

終わりに

今回はじめてActionsを作ったが、reviewdogの周辺ツールがとてもリッチなのですぐ完了できた。
「静的解析ツールを作る -> reviewdogでactionsにする」を速く開発できればどんどん自動コードレビューを手厚くできそう。

実際の関数の判定ロジックなどはnrsegリポジトリに実装してあるのだが、だいぶ汚いコードになってしまったので直しておきたい。

参考

関連記事