GitLab

·

采集 GitLab 运行数据并以指标的方式上报到观测云。

配置¶

首先需要打开 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

    ## 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 数据采集功能，开启方式如下（以英文页面为例）：

• 以管理员账号登陆己方 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 运行在容器中需根据实际情况添加）
• 重启 GitLab 服务

详情见官方配置文档。

开启 GitLab CI 可视化¶

确保已有 DataFlux Func 平台

通过配置 GitLab Webhook，可以实现 GitLab CI 可视化。需要通过 DataFlux Func 进行数据上报，开启步骤如下：

1. 在 DataFlux Func 上安装 GitLab CI 集成（脚本 ID：guance_gitlab_ci），安装流程参考GitLab CI 集成配置;
2. 在 GitLab 转到 Settings -> Webhooks 中，将 URL 配置为第一步的 API 地址，Trigger 配置 Job events 和 Pipeline events 两项，点击 Add webhook 确认添加；

触发 GitLab CI 流程，执行结束后可以登陆观测云查看 CI 执行情况。

指标¶

以下所有数据采集，默认会追加全局选举 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

• 标签

NA

• 指标列表

gitlab_http¶

GitLab HTTP metrics

• 标签

• 指标列表

gitlab_pipeline¶

GitLab Pipeline event metrics

• 标签

• 指标列表

gitlab_job¶

GitLab Job Event metrics

• 标签

• 指标列表