Supported OS Linux Windows Mac OS

Versión de la integración9.0.0

Información general

Una integración que te permite:

  • visualizar y monitorizar las métricas recopiladas con GitLab y Gitaly a través de Prometheus.

Consulta Monitorización de GitLab con Prometheus para obtener más información.

Para lograr una monitorización más profunda de tus pipelines de GitLab, echa un vistazo a CI Pipeline Visibility. CI Pipeline Visibility brinda información minuciosa sobre el flujo de trabajo del usuario, permite acceder a metadatos detallados de Git y facilita el seguimiento del rendimiento de los pipelines a lo largo del tiempo.

Configuración

Esta integración basada en OpenMetrics tiene un modo más reciente (que se habilita al configurar openmetrics_endpoint de modo que apunte hacia el endpoint de destino) y un modo heredado (que se habilita al configurar prometheus_url en su lugar). Para obtener todas las características más actualizadas, Datadog recomienda habilitar el modo más reciente. Para obtener más información, consulta Control de versiones más reciente y heredado para las integraciones basadas en OpenMetrics.

Las métricas marcadas como [OpenMetricsV1] u [OpenMetricsV2] solo están disponibles con el uso del modo correspondiente de la integración de GitLab. Todas las demás métricas se recopilan en ambos modos.

Instalación

El check de GitLab está incluido en el paquete del Datadog Agent, por lo que no necesitas instalar nada más en tus servidores de GitLab.

Configuración

Host

Para configurar este check para un Agent que se ejecuta en un host, haz lo siguiente:

Recopilación de métricas
  1. Edita el archivo gitlab.d/conf.yaml, que se encuentra en la carpeta conf.d/ en la raíz del directorio de configuración del Agent, de modo que apunte hacia el endpoint de las métricas de GitLab. Revisa el archivo de ejemplo gitlab.d/conf.yaml para ver todas las opciones de configuración disponibles. Si ya tienes esta integración implementada, consulta el ejemplo del modo heredado.

  2. En la página de parámetros de GitLab, asegúrate de que la opción Enable Prometheus Metrics esté habilitada (se requiere acceso de administrador). Para obtener más información sobre cómo habilitar la recopilación de métricas, consulta Métricas de GitLab con Prometheus.

  3. Permite el acceso a los endpoints de monitorización al actualizar /etc/gitlab/gitlab.rb con la siguiente línea:

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

    Nota: Guarda el progreso y reinicia GitLab para ver los cambios.

  4. Reinicia el Agent.

Recopilación de logs
  1. La recopilación de logs se encuentra deshabilitada de manera predeterminada en el Datadog Agent; habilítala en el archivo datadog.yaml:

    logs_enabled: true
    
  2. Luego, edita gitlab.d/conf.yaml y quita los comentarios de las líneas logs de la parte inferior. Actualiza path con la ruta correcta a tus archivos de logs de 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. Reinicia el Agent.

Contenedores

En el caso de los entornos en contenedores, consulta las Plantillas de integración de Autodiscovery para obtener orientación sobre la aplicación de los parámetros que se indican abajo.

Recopilación de métricas
ParámetroValor
<INTEGRATION_NAME>gitlab
<INIT_CONFIG>en blanco o {}
<INSTANCE_CONFIG>{"gitlab_url":"http://%%host%%/", "openmetrics_endpoint":"http://%%host%%:10055/-/metrics"}
Recopilación de logs

La recopilación de logs se encuentra deshabilitada de manera predeterminada en el Datadog Agent. Para habilitarla, consulta Recopilación de logs de Kubernetes.

ParámetroValor
<LOG_CONFIG>{"source": "gitlab", "service": "gitlab"}

Validación

Ejecuta el subcomando de estado del Agent y busca gitlab en la sección Checks.

Datos recopilados

Métricas

Eventos

El check de GitLab no incluye eventos.

Checks de servicio

Puedes obtener más información sobre los checks de servicios gitlab.readiness.* en la documentación oficial de GitLab.

Solucionar problemas

¿Necesitas ayuda? Ponte en contacto con el servicio de asistencia de Datadog.

Integración del GitLab Runner

Información general

Una integración que te permite:

  • visualizar y monitorizar las métricas recopiladas con los ejecutores de GitLab a través de Prometheus;
  • comprobar que el GitLab Runner puede conectarse a GitLab.

Para obtener más información sobre el GitLab Runner y su integración con Prometheus, consulta la documentación del GitLab Runner.

Configuración

Sigue las instrucciones de abajo para instalar y configurar este check para un Agent que se ejecuta en un host. En el caso de entornos en contenedores, consulta las Plantillas de integración de Autodiscovery para obtener orientación sobre la aplicación de estas instrucciones.

Instalación

El check del GitLab Runner está incluido en el paquete del Datadog Agent, por lo que no necesitas instalar nada más en tus servidores de GitLab.

Configuración

Edita el archivo gitlab_runner.d/conf.yaml, que se encuentra en la carpeta conf.d/ en la raíz del directorio de configuración del Agent, de modo que apunte hacia el endpoint de las métricas de Prometheus del Runner y hacia el master de GitLab para tener un check de servicios. Consulta el archivo de ejemplo gitlab_runner.d/conf.yaml para conocer todas las opciones de configuración disponibles.

El elemento allowed_metrics de la sección init_config permite especificar las métricas que deben extraerse. Algunas métricas deben informarse como rate, por ejemplo: ci_runner_errors.

Validación

Ejecuta el subcomando status del Agent y busca gitlab_runner en la sección Checks.

Datos recopilados

Métricas

Recopilación de logs

  1. En el archivo de configuración gitlab_runner, cambia el formato de logs por json (Disponible para las versiones del GitLab Runner a partir de la 11.4.0):

    log_format = "json"
    
  2. La recopilación de logs se encuentra deshabilitada de manera predeterminada en el Datadog Agent; debes habilitarla en el archivo datadog.yaml:

    logs_enabled: true
    
  3. Añade el usuario dd-agent al grupo systemd-journal ejecutando lo siguiente:

    usermod -a -G systemd-journal dd-agent
    
  4. Añade este bloque de configuración al archivo gitlab_runner.d/conf.yaml para empezar a recopilar logs del GitLab Runner:

    logs:
      - type: journald
        source: gitlab-runner
    

    Consulta el archivo de ejemplo gitlab_runner.d/conf.yaml para ver todas las opciones de configuración disponibles.

  5. Reinicia el Agent.

Eventos

El check del GitLab Runner no incluye eventos.

Checks de servicio

El check del GitLab Runner brinda un check de servicios para confirmar que el Runner puede comunicarse con el master de GitLab y otro para comprobar que el endpoint local de Prometheus está disponible.

Solucionar problemas

¿Necesitas ayuda? Ponte en contacto con el servicio de asistencia de Datadog.

PREVIEWING: may/embedded-workflows