GitLab

Supported OS Linux Windows Mac OS

インテグレーションバージョン9.0.0

概要

このインテグレーションを使用して

  • GitLab と Gitaly を使って Prometheus から収集されたメトリクスを視覚化および監視できます。

詳しくは、Prometheus による GitLab の監視をご覧ください。

GitLab パイプラインのさらに詳細なモニタリングについては、CI Pipeline Visibility をご確認ください。CI Pipeline Visibility では、ユーザーワークフローの詳細な洞察を提供し、詳細な Git メタデータにアクセスでき、時間をかけてパイプラインのパフォーマンスを追跡します。

セットアップ

この OpenMetrics ベースのインテグレーションには、最新モード (ターゲットエンドポイントを指すように openmetrics_endpoint を設定することで有効) とレガシーモード (代わりに prometheus_url を設定することで有効) があります。すべての最新機能を利用するために、Datadog は最新モードを有効にすることを推奨します。詳しくは、OpenMetrics ベースのインテグレーションにおける最新バージョニングとレガシーバージョニングを参照してください。

[OpenMetricsV1] または [OpenMetricsV2] とマークされたメトリクスは、GitLab インテグレーションの対応するモードを使用した場合にのみ利用できます。その他のメトリクスはどちらのモードでも収集されます。

インストール

GitLab チェックは Datadog Agent パッケージに含まれています。GitLab サーバーに追加でインストールする必要はありません。

構成

    ホスト

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

    メトリクスの収集

    1. Agent の構成ディレクトリのルートにある conf.d/ フォルダ内の gitlab.d/conf.yaml ファイルを編集し、GitLab のメトリクスエンドポイントを指すようにします。 利用可能なすべての構成オプションについては、gitlab.d/conf.yaml のサンプルを参照してください。以前にこのインテグレーションを実装したことがある場合は、レガシー例を参照してください。

    2. GitLab の設定ページで、オプション Enable Prometheus Metrics が有効になっていることを確認します (管理者権限が必要です)。メトリクスの収集を有効にする方法については、GitLab Prometheus メトリクスを参照してください。

    3. /etc/gitlab/gitlab.rb を更新して次の行を含めることで、監視エンドポイントへのアクセスを許可します。

      gitlab_rails['monitoring_whitelist'] = ['127.0.0.0/8', '192.168.0.1']

      注 保存して GitLab を再起動すると変更を確認できます。

    4. Agent を再起動します。

    ログ収集

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

      logs_enabled: true

    2. 次に、下部にある logs 行のコメントを解除して、gitlab.d/conf.yaml を編集します。ログの path を GitLab ログファイルの正しいパスで更新してください。

        logs:
    - type: file
      path: /var/log/gitlab/gitlab-rails/production_json.log
      service: '<SERVICE_NAME>'
      source: gitlab
    - type: file
      path: /var/log/gitlab/gitlab-rails/production.log
      service: '<SERVICE_NAME>'
      source: gitlab
    - type: file
      path: /var/log/gitlab/gitlab-rails/api_json.log
      service: '<SERVICE_NAME>'
      source: gitlab

    3. Agent を再起動します。

    コンテナ化

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

    メトリクスの収集
    パラメーター値
    <INTEGRATION_NAME>gitlab
    <INIT_CONFIG>空白または {}
    <INSTANCE_CONFIG>{"gitlab_url":"http://%%host%%/", "openmetrics_endpoint":"http://%%host%%:10055/-/metrics"}
    ログ収集

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

    パラメーター値
    <LOG_CONFIG>{"source": "gitlab", "service": "gitlab"}

    検証

    Agent の status サブコマンドを実行し、Checks セクションで gitlab を探します。

    収集データ

    メトリクス

    イベント

    GitLab チェックには、イベントは含まれません。

    サービスチェック

    gitlab.readiness.* のサービスチェックについての詳細は、公式の GitLab ドキュメントに記載されています。

    トラブルシューティング

    ご不明な点は、Datadog のサポートチームまでお問い合わせください。

    GitLab Runner インテグレーション

    概要

    このインテグレーションを使用して

    • GitLab Runners を使って Prometheus から収集されたメトリクスを視覚化および監視できます。
    • GitLab Runner が GitLab に接続できるかどうかを検証できます。

    GitLab Runner と Prometheus とのインテグレーションについては、GitLab Runner ドキュメントを参照してください。

    セットアップ

    ホストで実行されている Agent 用にこのチェックをインストールおよび構成する場合は、以下の手順に従ってください。コンテナ環境の場合は、オートディスカバリーのインテグレーションテンプレートのガイドを参照してこの手順を行ってください。

    インストール

    GitLab Runner チェックは Datadog Agent パッケージに含まれています。GitLab サーバーに追加でインストールする必要はありません。

    構成

    Runner の Prometheus メトリクスエンドポイントおよびサービスチェックを持つ GitLab マスターを指定するには、Agent のコンフィギュレーションディレクトリのルートにある conf.d/ フォルダーの gitlab_runner.d/conf.yaml ファイルを編集します。使用可能なすべてのコンフィギュレーションオプションについては、サンプル gitlab_runner.d/conf.yaml を参照してください。

    init_config セクションの allowed_metrics 項目で、抽出するメトリクスを指定することができます。いくつかのメトリクスは rate として報告されるべきです (例: ci_runner_errors)。

    検証

    Agent の status サブコマンドを実行し、Checks セクションで gitlab_runner を探します。

    収集データ

    メトリクス

    ログ収集

    1. gitlab_runner コンフィギュレーションファイルで、ログフォーマットを json に変更します (GitLab Runner のバージョン 11.4.0 以降で利用可能) :

      log_format = "json"

    2. Datadog Agent で、ログの収集はデフォルトで無効になっています。以下のように、datadog.yaml でこれを有効にする必要があります。

      logs_enabled: true

    3. 以下を実行して、systemd-journal グループに dd-agent ユーザーを追加します。

      usermod -a -G systemd-journal dd-agent

    4. GitLab Runner のログの収集を開始するには、次の構成ブロックを gitlab_runner.d/conf.yaml ファイルに追加します。

      logs:
  - type: journald
    source: gitlab-runner

      使用可能なすべてのコンフィギュレーションオプションの詳細については、サンプル gitlab_runner.d/conf.yaml を参照してください。

    5. Agent を再起動します。

    イベント

    GitLab Runner チェックには、イベントは含まれません。

    サービスチェック

    GitLab Runner チェックは、Runner が GitLab マスターと通信できるかを確認するサービスのチェック機能、およびローカルの Prometheus エンドポイントが使用可能かを確認するサービスのチェック機能を提供します。

    トラブルシューティング

    ご不明な点は、Datadog のサポートチームまでお問い合わせください。

    PREVIEWING: may/embedded-workflows