TeamCity

ホスト

ホストで実行中の Agent に対してこのチェックを構成するには:

Agent のコンフィギュレーションディレクトリのルートにある conf.d/ フォルダーの teamcity.d/conf.yaml を編集します。使用可能なすべてのコンフィギュレーションオプションの詳細については、サンプル teamcity.d/conf.yaml を参照してください。

TeamCity チェックは、データ収集の 2 つのメソッドを提供します。TeamCity 環境を最適にモニターするには、2 つの別々のインスタンスを構成して、それぞれの方法からメトリクスを収集します。

1. OpenMetricsV2 メソッド(Python バージョン 3 が必要です):

   TeamCity の /metrics Prometheus エンドポイントからメトリクスを収集するために use_openmetrics: true を有効化します。

   init_config:
   
   instances:
       ## @param server - 文字列 - 必須
       ## TeamCity インスタンスのサーバー名を指定します。
       ## インスタンスでゲスト認証を有効にするか、
       ## オプションの `basic_http_authentication` 構成パラメーターを有効にして、データを収集します。
       ## `basic_http_authentication` を使用する場合は、以下を指定します。
       ##
       ## server: http://<USER>:<PASSWORD>@teamcity.<ACCOUNT_NAME>.com
       #
     - server: http://teamcity.<ACCOUNT_NAME>.com
       ## @param use_openmetrics - ブール値 - オプション - デフォルト: false
       ## 最新の OpenMetrics V2 実装を使用して、
       ## TeamCity サーバーの Prometheus メトリクスエンドポイントからメトリクスを収集します。
       ## Python バージョン 3 が必要です。
       ##
       ## Prometheus のメトリクスを収集するために別のインスタンスで有効化します。
       ## このオプションは、TeamCity REST API からイベント、サービスチェック、メトリクスを収集しません。
       #
       use_openmetrics: true
   

注: OpenMetrics 準拠のヒストグラムとサマリーのメトリクスを収集するには (TeamCity Server 2022.10+ から利用可能)、内部プロパティである teamcity.metrics.followOpenMetricsSpec=true を追加してください。TeamCity 内部プロパティを参照してください。

2. TeamCity Server REST API メソッド:

   TeamCity サーバーの REST API から追加のビルド固有のメトリクス、サービスチェック、ビルドステータスイベントを収集するために、teamcity.d/conf.yaml ファイルに別のインスタンスを構成します。projects オプションを使用して、プロジェクトとビルド構成を指定します (Python バージョン 3 が必要です)。

   init_config:
   
   instances:
     - server: http://teamcity.<ACCOUNT_NAME>.com
   
       ## @param projects - マッピング - オプション
       ## TeamCity REST API からイベントとメトリクスを収集するための
       ## TeamCity プロジェクトとビルド構成のマッピング。
       #
       projects:
         <PROJECT_A>:
           include:    
           - <BUILD_CONFIG_A>
           - <BUILD_CONFIG_B>
           exclude:
           - <BUILD_CONFIG_C>
         <PROJECT_B>:
           include:
           - <BUILD_CONFIG_D>
         <PROJECT_C>: {}
   

オプションの include と exclude フィルターを使用して、監視に含めるビルド構成 ID と監視から除外するビルド構成 ID をそれぞれ指定し、各プロジェクトのビルド構成監視をカスタマイズします。ビルド構成 ID のマッチングパターンを指定するために、include と exclude のキーで RegEx パターンがサポートされています。もし include と exclude の両方のフィルターが省略された場合、指定したプロジェクトのすべてのビルド構成が監視されます。

Python バージョン 2 の場合、build_configuration オプションを使用して、インスタンスごとに 1 つのビルド構成 ID を構成します。

init_config:

instances:
  - server: http://teamcity.<ACCOUNT_NAME>.com

    ## @param projects - マッピング - オプション
    ## TeamCity REST API からイベントとメトリクスを収集するための
    ## TeamCity プロジェクトとビルド構成のマッピング。
    #
    build_configuration: <BUILD_CONFIGURATION_ID>

Agent を再起動すると、TeamCity イベントが収集され、Datadog に送信されます。

ログの収集

1. TeamCity ログ設定を構成します。

2. デフォルトでは、Datadog のインテグレーションパイプラインは以下のログフォーマットをサポートします。

   [2020-09-10 21:21:37,486]   INFO -  jetbrains.buildServer.STARTUP - Current stage: System is ready
   

   別の変換パターンを定義する場合は、インテグレーションパイプラインを複製して編集してください。

3. Datadog Agent で、ログの収集はデフォルトで無効になっています。以下のように、datadog.yaml ファイルでこれを有効にします。

   logs_enabled: true
   

4. teamcity.d/conf.yaml ファイルで以下のコンフィギュレーションブロックのコメントを削除します。環境に基づいて、path パラメーターの値を変更します。使用可能なすべてのコンフィギュレーションオプションについては、teamcity.d/conf.yaml のサンプルを参照してください。

   logs:
     - type: file
       path: /opt/teamcity/logs/teamcity-server.log
       source: teamcity
     - type: file
       path: /opt/teamcity/logs/teamcity-activities.log
       source: teamcity
     - type: file
       path: /opt/teamcity/logs/teamcity-vcs.log
       source: teamcity
     - type: file
       path: /opt/teamcity/logs/teamcity-cleanup.log
       source: teamcity
     - type: file
       path: /opt/teamcity/logs/teamcity-notifications.log
       source: teamcity
     - type: file
       path: /opt/teamcity/logs/teamcity-ws.log
       source: teamcity
   

5. Agent を再起動します。

コンテナ化

コンテナ環境の場合は、オートディスカバリーのインテグレーションテンプレートのガイドを参照して、次のパラメーターを適用してください。

ログの収集

Datadog Agent で、ログの収集はデフォルトで無効になっています。有効にする方法については、Kubernetes ログ収集を参照してください。