GitLab

·

GitLab の稼働データを収集し、メトリクスとしてGuanceに送信します。

設定¶

まず、GitLab サービスのデータ収集機能を有効にし、許可リストを設定します。詳しい手順は以降のセクションを参照してください。

GitLab の設定が完了したら、DataKit を設定します。GitLab のバージョンや設定によって、収集されるデータが異なる場合があります。

[[inputs.gitlab]]
    ## set true if you need to collect metric from url below
    enable_collect = true

    ## param type: string - default: http://127.0.0.1:80/-/metrics
    prometheus_url = "http://127.0.0.1:80/-/metrics"

    ## param type: string - optional: time units are "ms", "s", "m", "h" - default: 10s
    interval = "10s"

    ## datakit can listen to gitlab ci data at /v1/gitlab when enabled
    enable_ci_visibility = true

    ## Set true to enable election
    election = true

    ## Bearer token file for authentication
    bearer_token_file = ""

    ## HTTP headers
    [inputs.gitlab.http_headers]
    # X-Custom-Header = "custom-value"

    ## TLS configuration
    # tls_ca = "/path/to/ca.pem"
    # tls_cert = "/path/to/cert.pem"
    # tls_key = "/path/to/key.pem"
    # insecure_skip_verify = false

    ## extra tags for gitlab-ci data.
    ## these tags will not overwrite existing tags.
    [inputs.gitlab.ci_extra_tags]
    # some_tag = "some_value"
    # more_tag = "some_other_value"

    ## extra tags for gitlab metrics
    [inputs.gitlab.tags]
    # some_tag = "some_value"
    # more_tag = "some_other_value"

GitLab のデータ収集機能を有効にする¶

GitLab で Prometheus データ収集機能を有効にします（英語 UI の例）：

• 管理者アカウントで GitLab インスタンスにログインします
• Admin Area > Settings > Metrics and profiling に移動します
• Metrics - Prometheus を選択し、Enable Prometheus Metrics、save change の順にクリックします
• GitLab サービスを再起動します

詳細については、公式設定ドキュメントを参照してください。

データアクセス許可リストを設定する¶

データ収集機能を有効にするだけでは不十分です。GitLab ではデータアクセスが厳密に管理されるため、アクセス元の許可リストも設定します。

• GitLab 設定ファイル /etc/gitlab/gitlab.rb を編集し、gitlab_rails['monitoring_whitelist'] = ['::1/128'] を見つけて、配列に DataKit のアクセス IP を追加します（通常は DataKit を実行するホストの IP。GitLab がコンテナで稼働している場合は、環境に応じた IP を追加してください）
• GitLab サービスを再起動します

詳細については、公式設定ドキュメントを参照してください。

GitLab CI の可視化を有効にする¶

GitLab Webhook を設定すると、GitLab CI を可視化できます。DataKit が GitLab Webhook を受信するデフォルト URL は http://DataKit-IP:9529/v1/gitlab です。

GitLab の左サイドバーで Settings ➔ Webhooks に移動します。URL に上記のアドレスを設定し、Trigger で Job events と Pipeline events を選択して、Add webhook をクリックします。

メトリクス¶

以下で収集されるすべてのデータには、デフォルトでグローバル選出 tag が追加されます。設定で追加のタグを指定することもできます。

• 設定の [inputs.gitlab.tags] で GitLab メトリクスデータの追加タグを指定できます。

[inputs.gitlab.tags]
# some_tag = "some_value"
# more_tag = "some_other_value"
# ...

• 設定の [inputs.gitlab.ci_extra_tags] で GitLab CI データの追加タグを指定できます。

[inputs.gitlab.ci_extra_tags]
# some_tag = "some_value"
# more_tag = "some_other_value"
# ...

注：GitLab CI を正常に動作させるため、GitLab CI データに指定した extra tags は既存のタグを上書きしません（GitLab CI のタグ一覧は以下を参照）。

gitlab¶

GitLab runtime metrics

gitlab_base¶

GitLab programming language level metrics

gitlab_http¶

GitLab HTTP metrics

ログ¶

gitlab_pipeline¶

GitLab Pipeline event metrics

gitlab_job¶

GitLab Job Event metrics