Información general

El Datadog Agent recopila una métrica principal sobre Gunicorn: el número de procesos de workers en ejecución. También envía un check de servicio: si Gunicorn se está ejecutando o no.

El propio Gunicorn puede proporcionar más métricas utilizando DogStatsD, incluyendo:

• Frecuencia total de solicitudes
• Frecuencia de solicitudes por código de estado (2xx, 3xx, 4xx, 5xx)
• Duración de solicitudes (media, mediana, máxima, percentil 95, etc.)
• Frecuencia de mensajes de log por nivel de log (crítico, error, advertencia, excepción)

Configuración

Instalación

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

El check de Gunicorn requiere que el entorno Python de tu aplicación Gunicorn tenga el paquete setproctitle. Sin él, el Datadog Agent informa que no puede encontrar un proceso principal gunicorn (y por lo tanto, tampoco puede encontrar workers). Instala el paquete setproctitle en el entorno Python de tu aplicación si quieres recopilar la métrica gunicorn.workers.

Configuración

Edita el archivo gunicorn.d/conf.yaml, en la carpeta conf.d/ en la raíz de tu directorio de configuración del Agent para comenzar a recopilar tus métricas y logs de Gunicorn. Consulta el ejemplo gunicorn.yaml para conocer todas las opciones de configuración disponibles.

Recopilación de métricas

Conexión de Gunicorn con DogStatsD

1. A partir de la versión 19.1, Gunicorn te ofrece la opción de enviar tus métricas a un daemon que implemente el protocolo StatsD, como DogStatsD. Como sucede con muchas opciones de Gunicorn, puedes pasarlo a gunicorn en la CLI (--statsd-host) o configurarlo en el archivo de configuración de tu aplicación (statsd_host). Para asegurarte de recopilar todas las métricas de Gunicorn, configura tu aplicación para que envíe métricas a DogStatsD en "localhost:8125" y reinicia la aplicación.

2. Añade este bloque de configuración a tu archivo gunicorn.d/conf.yaml para empezar a recopilar tus métricas de Gunicorn:

init_config:

instances:
    ## @param proc_name - string - required
    ## The name of the gunicorn process. For the following gunicorn server:
    ##
    ## gunicorn --name <WEB_APP_NAME> <WEB_APP_CONFIG>.ini
    ##
    ## the name is `<WEB_APP_NAME>`
  - proc_name: <YOUR_APP_NAME>

3. Reinicia el Agent para comenzar a enviar métricas de Gunicorn a Datadog.

Recopilación de logs

Disponible para las versiones 6.0 o posteriores del Agent

1. La recopilación de logs está desactivada en forma predeterminada en el Datadog Agent, actívala en tu archivo datadog.yaml:

   logs_enabled: true
   

2. Utiliza el siguiente comando para configurar la ruta del archivo de logs de acceso: --access-logfile <MY_FILE_PATH>

3. Utiliza el siguiente comando para configurar la ruta del archivo de logs de error: --error-logfile FILE, --log-file <MY_FILE_PATH>

4. Añade este bloque de configuración a tu archivo gunicorn.d/conf.yaml para empezar a recopilar logs de Gunicorn:

   logs:
     - type: file
       path: /var/log/gunicorn/access.log
       service: "<MY_SERVICE>"
       source: gunicorn
   
     - type: file
       path: /var/log/gunicorn/error.log
       service: "<MY_SERVICE>"
       source: gunicorn
       log_processing_rules:
         - type: multi_line
           name: log_start_with_date
           pattern: \[\d{4}-\d{2}-\d{2}
   

   Cambia los valores de los parámetros service y path y configúralos para tu entorno. Consulta el ejemplo gunicorn.yaml para conocer todas las opciones de configuración disponibles.

5. Reinicia el Agent.

Validación

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

Si el estado no es OK, consulte la sección Solucionar problemas.

Utiliza netstat para verificar que Gunicorn también envía tus métricas:

$ sudo netstat -nup | grep "127.0.0.1:8125.*ESTABLISHED"
udp        0      0 127.0.0.1:38374         127.0.0.1:8125          ESTABLISHED 15500/gunicorn: mas

Datos recopilados

Métricas

Eventos

El check de Gunicorn no incluye eventos.

Checks de servicio

gunicorn.is_running

Devuelve CRITICAL si el Agent no puede encontrar el proceso principal de Gunicorn. Devuelve OK en caso contrario.

Estados: ok, crítico

Solucionar problemas

El Agent no encuentra el proceso Gunicorn

  Checks
  ======

    gunicorn (5.12.1)
    -----------------
      - instance #0 [ERROR]: 'Found no master process with name: gunicorn: master [my_web_app]'
      - Collected 0 metrics, 0 events & 1 service check
      - Dependencies:
          - psutil: 4.4.1

O bien Gunicorn realmente no se está ejecutando, o bien el entorno Python entorno de tu aplicación no tiene instalado el paquete setproctitle.

Si setproctitle no está instalado, Gunicorn aparece en la tabla de procesos de la siguiente forma:

$ ps -ef | grep gunicorn
ubuntu   18013 16695  2 20:23 pts/0    00:00:00 /usr/bin/python /usr/bin/gunicorn --config test-app-config.py gunicorn-test:app
ubuntu   18018 18013  0 20:23 pts/0    00:00:00 /usr/bin/python /usr/bin/gunicorn --config test-app-config.py gunicorn-test:app
ubuntu   18019 18013  0 20:23 pts/0    00:00:00 /usr/bin/python /usr/bin/gunicorn --config test-app-config.py gunicorn-test:app

Si está instalado, los procesos gunicorn aparecerán en el formato esperado por el Datadog Agent:

$ ps -ef | grep gunicorn
ubuntu   18457 16695  5 20:26 pts/0    00:00:00 gunicorn: master [my_app]
ubuntu   18462 18457  0 20:26 pts/0    00:00:00 gunicorn: worker [my_app]
ubuntu   18463 18457  0 20:26 pts/0    00:00:00 gunicorn: worker [my_app]

Referencias adicionales

• Monitorizar el rendimiento de Gunicorn con Datadog