TeamCity パイプラインでトレースを設定する

このドキュメントは最新ではありません。最新版はこちらをクリックして英語版をご覧ください。

選択したサイト () では、現時点では CI Visibility は利用できません。

互換性

  • 対応する TeamCity のバージョン: 2021.2 以降

  • 部分的なリトライ: 部分的にリトライされたパイプライン実行を表示

  • キュー時間: パイプラインのジョブが処理されるまでのキュー時間を表示

  • パイプラインの障害理由: エラーメッセージからパイプラインの障害原因を特定

Datadog インテグレーションの構成

TeamCity と Datadog CI Visibility のインテグレーションは、TeamCity プラグインで提供されています。 インテグレーションを有効にするには

  1. TeamCity サーバーで、Administration -> Plugins -> Browse Plugin Repository にアクセスして、Datadog CI Integration プラグインをダウンロードします。

  2. まだ持っていない場合は、ビルドチェーンの最後のビルドとして TeamCity 複合ビルドを追加します。このビルドは、ビルドチェーンの現在の最後のビルドに依存し、他のビルドに依存しない必要があります。最後のビルドとして複合ビルドを持たないビルドチェーンは、プラグインによって無視されます。以下は、Aggregating Results が最後の複合ビルドである、期待されるビルドチェーンの一例です。

    最後に複合ビルドがある TeamCity ビルドチェーン
    最終的な複合ビルドは、VCS Root がアタッチされ、VCS Trigger が設定され、バージョン管理設定が適切に行われている必要があります。

  3. TeamCity プロジェクトでは、以下の構成パラメーターが必要です。

    • datadog.ci.api.key: Datadog API キー。
    • datadog.ci.site: 。
    • datadog.ci.enabled: true (false を使用すると、特定のプロジェクトでプラグインを無効にすることができます)。

    これらの構成パラメーターは、TeamCity サブプロジェクトまたは TeamCity ルートプロジェクトのいずれかに追加することができます。ルートプロジェクトに追加すると、そのすべてのサブプロジェクトに伝搬されます。たとえば、すべてのプロジェクトでプラグインを有効にするには、ルートプロジェクトに datadog.ci.enabled を true という値で追加します。構成パラメーターの定義に関する詳細は、TeamCity Project Hierarchy のドキュメントを参照してください。

  4. プラグインを有効にするには、Administration -> Plugins ページで Enable uploaded plugins をクリックします。 または、TeamCity サーバーを再起動します。

Datadog でパイプラインデータを視覚化

パイプライン終了後、Pipelines と Pipeline Executions のページでデータを表示します。

注: Pipelines ページには、各リポジトリのデフォルトブランチのデータのみが表示されます。

Git ユーザー情報の構成

このプラグインは、TeamCity ユーザー名スタイルに基づいて、Git の作者名とメールを取得します。Datadog では、Author Name and Email または Author Email のいずれかのユーザー名スタイルを使用することを推奨しています。他のユーザー名スタイル (UserId または Author Name) のいずれかが使用されている場合、プラグインはユーザー名に @Teamcity を付加して、ユーザーのメールを自動的に生成します。例えば、UserId ユーザー名スタイルが使われていて、Git の作者のユーザー名が john.doe の場合、プラグインは john.doe@Teamcity を Git 作者のメールとして生成します。ユーザー名スタイルは VCS Roots で定義されており、VCS Root 設定で変更することができます。

注: Git の作者メールアドレスは請求のために使用されるため、メールアドレスを提供しないユーザー名スタイル (UserId または Author Name) を使用すると、コストが発生する可能性があります。使用例についてご質問がある場合は、Datadog のサポートチームまでご連絡ください。

プラグインリポジトリ

Datadog CI Integration プラグインのソースコードは、Apache 2.0 ライセンスでオープンソース化されています。

トラブルシューティング

Datadog CI Integration プラグインによって生成されたすべてのログは teamcity-server.log ファイルに保存され、TeamCity Server から Administration -> Diagnostic -> Server Logs にアクセスしてアクセスすることが可能です。これらのログを確認することで、プラグインに関する問題についての追加情報を得ることができます。

その他の参考資料

お役に立つドキュメント、リンクや記事:

パイプラインの実行結果とパフォーマンスを確認するドキュメント more more トラブルシューティング CIドキュメント more more