■ はじめに
Github Actions の処理結果を datadog で管理する必要ができたので調べてみた。
目次
【0】準備 1)公式ドキュメント:CI Visibility (CI/CDの可視化) 2)前提条件 【1】datadog の設定手順 - その1 1)datadog へのログイン 2)"Get Started with CI Visibility"画面での設定 【2】Github の設定手順 - その1 1)"Create GitHub App"画面での設定 【3】datadog の設定手順 - その2 1)"GitHub Applications" 画面での設定 【4】datadog の設定手順 - その3 1)"Manage GitHub Accounts and Repositories" 画面での設定 【5】動作確認:Github Actionsを動かしてみる
【0】準備
1)公式ドキュメント:CI Visibility (CI/CDの可視化)
* CI のメトリクスやデータを Datadog のダッシュボードに取り込みたい場合に 参考にするドキュメント
https://docs.datadoghq.com/ja/continuous_integration/
GitHub Actions のワークフローにトレースを設定する
https://docs.datadoghq.com/ja/continuous_integration/pipelines/github/
[公式ブログ] Monitor your GitHub Actions workflows with Datadog CI Visibility
https://www.datadoghq.com/ja/blog/datadog-github-actions-ci-visibility/
2)前提条件
[1] datadog のアカウント(無料でOK)を作成していること [2] github のアカウント(無料でOK)を作成していること [3] Github Actions が動かせる状況であること
【1】datadog の設定手順 - その1
の「Configure tracing for GitHub Actions」を参考にやっていく
1)datadog へのログイン
* 手順 "[1] Go to the Getting Started page and click on GitHub." を行う
[1] datalog Web UIを開く
https://docs.datadoghq.com/ja/continuous_integration/pipelines/github/#configure-tracing-for-github-actions
の「Configure tracing for GitHub Actions」の 手順 "[1] Go to the Getting Started page and click on GitHub."のリンク押下
[2] 画面右上にある対象リージョンを選択し、datadag にログインする
* 今回は「JP AP1 - Japan」 => ここで結構ハマった、、、
2)"Get Started with CI Visibility"画面での設定
* 手順 "[2] Click on Enable Account for the account you want to enable." を行う
[1] "Get Started with CI Visibility"画面での設定
* "Get Started with CI Visibility"画面で以下を設定する ① Which CI Provider are you using? : GitHub ② Manage GitHub Accounts and Repositories : "" => 以降は「[2] "Add New Github Integration"画面での設定」を参照
[2] "Add New Github Integration"画面での設定
* "Add New Github Integration"画面で以下を設定 Create App in GitHub」ボタン押下 => Github にログインし、「【2】Github の設定手順 - その1」に移行する ① Configure App + Select where to install (required):Personal Account ② Select Features + "CI Visibility: monitor Github Actions":チェックONのまま => さらに追加したかったら「show other future」リンク押下する とよさそうが、今回はやらない ③ Edit Permissions + "Actions":Read Only を選択したまま + それ以外:Noneを選択したまま
【2】Github の設定手順 - その1
* 監視用の GitHub App を作成する
1)"Create GitHub App"画面での設定
* 以下を入力し、 「Create GitHub App for <YOUR_GITHUB_ACCOUNT>」ボタン押下 + GitHub App name:34文字以内の任意の半角英数字 (e.g demo-monitor-actions-w-datadog) => datadog の Web UI にリダイレクト
【3】datadog の設定手順 - その2
* 作成した監視用の GitHub App を datadog にインストールする
1)"GitHub Applications" 画面での設定
[1] [Integrations] > [GitHub Applications]画面内のGithub acccountの 「Install GitHub App」ボタン押下 [2] 以下を入力し、「Install & Authrize」ボタン押下 + for these repositories:Only select repositories => [Select repositories]で対象リポジトリを選択
【4】datadog の設定手順 - その3
* 設定を有効にする
1)"Manage GitHub Accounts and Repositories" 画面での設定
[1] [Software Delivery]-[Settings]-[Github Settings]を選択 [2] 対象Githubアカウントの「Enable Account」ボタン押下 [3] 「Enable Selected Repositories」内の対象Githubアカウントの以下を入力する + Enable CI Visibility:チェックONにする + Enable Job Logs Collection:チェックONにする ※ [Software Delivery]-[Executions]で「Add Pipeline」ボタン押下... ってしてもできる
【5】動作確認:Github Actionsを動かしてみる
[1] 対象リポジトリのGithub Actionsを動かす(何でもいい) => Github 内の [Actions]タブでGithub Actionsの処理状況をみてみるといい [2] datadog にログインして、[Software Delivery]-[CI Pipeline List]を選択 => 動かしたGithub Actionsの処理結果が表示されていることを確認する
関連記事
datadog ~ 基礎知識編 ~
https://dk521123.hatenablog.com/entry/2024/03/30/004746
Github Actions ~ 基礎知識編 ~
https://dk521123.hatenablog.com/entry/2021/11/04/142835
Github Actions ~ 入門編 ~
https://dk521123.hatenablog.com/entry/2022/06/16/151443
Github Actions ~ 基本編 ~
https://dk521123.hatenablog.com/entry/2023/12/22/195715
Terraform ~ Datadog ~
https://dk521123.hatenablog.com/entry/2023/05/12/000000