Datadog ソースコードインテグレーション

docs>integrations>Datadog ソースコードインテグレーション

概要

ソースコードインテグレーションは以下をサポートします:

言語:

Go
Java
JavaScript (トランスパイルされた JavaScript はサポートしていません)
Python

Git プロバイダー:

GitHub
GitLab
BitBucket

セルフホストインスタンスやプライベート URL はサポートされていません。

Datadog のソースコードインテグレーションは、GitHub、GitLab、Bitbucket でホストされている Git リポジトリとテレメトリーを接続することが可能です。ソースコードインテグレーションを有効にすると、ソースコードの関連行に素早くアクセスして、スタックトレース、スロープロファイル、その他の問題をデバッグすることができます。

Java RuntimeException のインラインコードスニペットと GitHub でコードを見るためのボタン

セットアップ

Datadog Agent v7.35.0 以降が必要です。

APM をすでに設定している場合は、Integrations > Link Source Code に移動し、バックエンドサービスのソースコードインテグレーションを構成してください。

テレメトリーのタグ付け

データを特定のコミットに関連付けるには、テレメトリーに git.commit.sha と git.repository_url タグを付けます。git.repository_url タグにプロトコルが含まれていないことを確認してください。例えば、リポジトリの URL が https://github.con/example_repo である場合、git.repository_url タグの値は github.com/example_repo となります。

この方法は、Docker、または containerd >= 1.5.6 を必要とします。AWS Fargate 上で動作するコンテナには対応していません。その他のコンテナ設定については、その他のセクションを参照してください。

コンテナでアプリを実行している場合、Datadog はイメージの Docker ラベルから直接ソースコード情報を抽出することができます。ビルド時に、オープンコンテナスタンダードに従って、git commit SHA とリポジトリ URL を Docker ラベルとして追加します。

docker build . \
  -t my-application \
  --label org.opencontainers.image.revision=$(git rev-parse HEAD) \
  --label org.opencontainers.image.source=git-provider.example/me/my-repo

Kubernetes を使用している場合は、Datadog のタグオートディスカバリーを使用してデプロイされたポッドにポッドアノテーションを付けます。

ad.datadoghq.com/tags: '{"git.commit.sha": "<FULL_GIT_COMMIT_SHA>", "git.repository_url": "git-provider.example/me/my-repo"}'

git.commit.sha と git.repository_url はテレメトリーでタグ付けされています。

トレース、スパン、プロファイルに git.commit.sha と git.repository_url というタグを付けるには、環境変数 DD_TAGS でトレーサーを構成します。

export DD_TAGS="git.commit.sha:<FULL_GIT_COMMIT_SHA>,git.repository_url:git-provider.example/me/my-repo"
./my-application start

Datadog はリポジトリの URL、現在のブランチのコミット SHA、追跡されたファイルパスのリストをキャプチャするだけで、ユーザーコードを取り込んだり保存したりすることはありません。

リポジトリの構成

GitHub SaaS ユーザーの場合、テレメトリーをソースコードにリンクさせるために、Datadog の GitHub インテグレーションを GitHub インテグレーションタイルにインストールします。インテグレーションタイルで権限を指定する際、Contents に対して Datadog の読み取り権限を有効にしてください。

GitHub とのインテグレーションを設定することで、エラー追跡にインラインコードスニペットを表示することができます。詳しくは、インラインソースコードをご覧ください。

テレメトリーをソースコードにリンクさせるために、Datadog は datadog-ci git-metadata upload コマンドで Git リポジトリから全てのコミット SHA についてメタデータを収集します。

Git リポジトリ内で datadog-ci git-metadata upload を実行すると、Datadog はリポジトリの URL、現在のブランチのコミット SHA、そして追跡したファイルのパスのリストを受け取ります。

検証

データが収集されていることを確認するために、CI パイプラインで datadog-ci git-metadata upload を実行します。

以下のような出力が期待できます。

Reporting commit 007f7f466e035b052415134600ea899693e7bb34 from repository git@github.com:my-org/my-repository.git.
180 tracked file paths will be reported.
✅  Handled in 0.077 seconds.

使用方法

Git プロバイダーへのリンク

トレースは GitHub のソースリポジトリのエラー追跡で直接アクセスできます。

APM > Error Tracking の順に移動します。
課題をクリックします。右側に Issue Details パネルが表示されます。
Latest Event の下で、フレームの右側にある View ボタンをクリックするか、View file、View Git blame、View commit を選択すると、ソースコード管理ツールにリダイレクトされます。

エラー追跡のエラースタックトレースの右側に、3 つのオプション (view file、view blame、view commit) を持つビューリポジトリボタンがあります

トレースは、Continuous Profiler で GitHub 上のソースリポジトリに直接アクセスすることができます。

APM > Profile Search の順に移動します。
プロファイルをクリックし、フレームグラフのメソッドにカーソルを合わせます。右側に More actions というラベルの付いたケバブアイコンが表示されます。
More actions* > View in repo をクリックし、トレースをソースコードリポジトリで開きます。

インラインソースコード

GitHub SaaS ユーザーの場合、Datadog の GitHub インテグレーションをインストールすると、エラー追跡のスタックトレースに GitHub リポジトリからコードスニペットを直接インラインで表示することができます。インテグレーションタイルで権限を指定する際、Contents に対して Datadog の読み取り権限を有効にしてください。

APM > Error Tracking の順に移動します。
課題をクリックします。右側に Issue Details パネルが表示されます。
Connect to Preview と Authorize をクリックして、エラーを含むソースコードスニペットにアクセスします。
Latest Event の下で、フレームの右側にある View Code ボタンをクリックするか、View file、View Git blame、View commit を選択すると、ソースコード管理ツールにリダイレクトされます。