GitHub アプリ

概要

Datadog と GitHub アプリを連携させることで、リポジトリのアクセス許可を有効にして、エラーにコードスニペットを表示することができます。また、Datadog のノートブックやインシデントタイムラインに GitHub の PR や課題へのリンクを表示することができます。

セットアップ

インストール

Datadog GitHub アプリインテグレーションタイルを使って、インテグレーションタイルをインストールします。

コンフィギュレーション

GitHub 組織の管理者であれば、GitHub アプリを構成することができます。

GitHub アプリインテグレーションタイルで、Configuration タブに移動します。
Link GitHub Account をクリックして、GitHub アプリを新規に作成します。
Configure で、Organization を選択して組織名を入力するか、Personal Account を選択します。オプションで、GitHub Enterprise Server インスタンス (バージョン 2.22 以上) の URL を指定し、Datadog サーバーが Enterprise インスタンスに接続できることを確認します。サーバー IP は、IP Ranges の Webhooks セクションで入手できます。
Edit Permissions で、課題、プルリクエスト、コンテンツに対する Datadog の読み取りアクセス許可を有効にします。少なくとも 1 つのアクセス許可を選択する必要があります。
Create App in GitHub をクリックすると、GitHub アプリ名を入力する画面が表示されるので、入力します。
GitHub アプリ名フィールドに名前を入力し、Create GitHub App をクリックします。
Configuration タブで、Install GitHub App と Install & Authorize をクリックします。

GitHub アプリがインテグレーションタイルに表示されます。スタックトレースでインラインコードスニペットを有効にするには、ソースコードインテグレーションの設定を参照してください。

ノートブック

ノートブックでは、GitHub の課題やプルリクエストは自動的にプレビューホバーボックスを生成し、コミット履歴、著者、日付などの詳細を追加表示します。

Notebooks > New Notebook の順に移動します。
Text セルを追加し、Edit フィールドに GitHub 上の課題またはプルリクエストを記載します (例: https://github.com/project/repository/pull/#)。
Done をクリックすると、リンクされた課題またはプルリクエストの横に GitHub のアイコンが表示されます。
Connect to Preview と Authorize をクリックします。
リンク先の課題またはプルリクエストにカーソルを合わせると、説明のプレビューが表示されます。

収集されるデータ - テレメトリー

監査ログ

監査ログは、GitHub の組織全体のすべてのアクティビティとイベントを網羅します。アプリケーションのインストール時に、Organization Administration 権限で読み取りアクセスを許可します。これにより、アプリケーションは GitHub の監査ストリームを GitHub 組織に代わってログとして収集し始めます。

監査ログの収集を停止するには、GitHub Apps のインテグレーションタイルの Telemetery タブで該当する組織を探し、Audit Log collection を切り替えてください。

監査ログについては、GitHub のドキュメントの監査ログアクションと Datadog へのストリーミングの設定を参照してください。