--- title: Gunicorn description: Monitor request rates and durations, log-message rates, and worker processes. breadcrumbs: Docs > Integrations > Gunicorn --- # Gunicorn Supported OS Integration version4.5.0 ## Overview{% #overview %} The Datadog Agent collects one main metric about Gunicorn: the number of worker processes running. It also sends one service check: whether or not Gunicorn is running. Gunicorn itself can provide further metrics using DogStatsD, including: - Total request rate - Request rate by status code (2xx, 3xx, 4xx, 5xx) - Request duration (average, median, max, 95th percentile, etc.) - Log message rate by log level (critical, error, warning, exception) **Minimum Agent version:** 6.0.0 ## Setup{% #setup %} ### Installation{% #installation %} The Datadog Agent's Gunicorn check is included in the [Datadog Agent](https://app.datadoghq.com/account/settings/agent/latest) package, so you don't need to install anything else on your Gunicorn servers. The Gunicorn check requires your Gunicorn app's Python environment to have the [`setproctitle`](https://pypi.python.org/pypi/setproctitle) package; without it, the Datadog Agent reports that it cannot find a `gunicorn` master process (and hence, cannot find workers, either). Install the `setproctitle` package in your app's Python environment if you want to collect the `gunicorn.workers` metric. ### Configuration{% #configuration %} Edit the `gunicorn.d/conf.yaml` file, in the `conf.d/` folder at the root of your [Agent's configuration directory](https://docs.datadoghq.com/agent/guide/agent-configuration-files/#agent-configuration-directory) to start collecting your Gunicorn metrics and logs. See the [sample gunicorn.yaml](https://github.com/DataDog/integrations-core/blob/master/gunicorn/datadog_checks/gunicorn/data/conf.yaml.example) for all available configuration options. #### Metric collection{% #metric-collection %} ##### Connect Gunicorn to DogStatsD{% #connect-gunicorn-to-dogstatsd %} 1. As of version 19.1, Gunicorn [provides an option](https://docs.gunicorn.org/en/stable/settings.html#statsd-host) to send its metrics to a daemon that implements the StatsD protocol, such as [DogStatsD](https://docs.datadoghq.com/guides/dogstatsd/). As with many Gunicorn options, you can either pass it to `gunicorn` on the CLI (`--statsd-host`) or set it in your app's configuration file (`statsd_host`). To ensure that you collect **all Gunicorn metrics**, configure your app to send metrics to [DogStatsD](https://docs.datadoghq.com/guides/dogstatsd/) at `"localhost:8125"`, and restart the app. 1. Add this configuration block to your `gunicorn.d/conf.yaml` file to start gathering Gunicorn metrics: ```yaml init_config: instances: ## @param proc_name - string - required ## The name of the gunicorn process. For the following gunicorn server: ## ## gunicorn --name .ini ## ## the name is `` - proc_name: ``` [Restart the Agent](https://docs.datadoghq.com/agent/guide/agent-commands/#start-stop-and-restart-the-agent) to begin sending Gunicorn metrics to Datadog. #### Log collection{% #log-collection %} *Available for Agent versions >6.0* 1. Collecting logs is disabled by default in the Datadog Agent, enable it in your `datadog.yaml` file: ```yaml logs_enabled: true ``` 1. Use the following command to configure the path of the [access log](https://docs.gunicorn.org/en/stable/settings.html#accesslog) file: `--access-logfile ` 1. Use the following command to configure the path of the [error log](https://docs.gunicorn.org/en/stable/settings.html#errorlog) file: `--error-logfile FILE, --log-file ` 1. Add this configuration block to your `gunicorn.d/conf.yaml` file to start collecting your Gunicorn logs: ```yaml logs: - type: file path: /var/log/gunicorn/access.log service: "" source: gunicorn - type: file path: /var/log/gunicorn/error.log service: "" source: gunicorn log_processing_rules: - type: multi_line name: log_start_with_date pattern: \[\d{4}-\d{2}-\d{2} ``` Change the `service` and `path` parameter values and configure them for your environment. See the [sample gunicorn.yaml](https://github.com/DataDog/integrations-core/blob/master/gunicorn/datadog_checks/gunicorn/data/conf.yaml.example) for all available configuration options. 1. [Restart the Agent](https://docs.datadoghq.com/agent/guide/agent-commands/#start-stop-and-restart-the-agent). ### Validation{% #validation %} [Run the Agent's status subcommand](https://docs.datadoghq.com/agent/guide/agent-commands/#agent-status-and-information) and look for `gunicorn` under the Checks section. If the status is not `OK`, see the Troubleshooting section. Use `netstat` to verify that Gunicorn is sending *its* metrics, too: ```text $ 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 ``` ## Data Collected{% #data-collected %} ### Metrics{% #metrics %} | | | | | **gunicorn.log.critical**(rate) | The rate of logged critical statements.*Shown as occurrence* | | **gunicorn.log.error**(rate) | The rate of logged errors.*Shown as occurrence* | | **gunicorn.log.exception**(rate) | The rate of logged exceptions.*Shown as occurrence* | | **gunicorn.log.warning**(rate) | The rate of logged warnings.*Shown as occurrence* | | **gunicorn.request.duration.95percentile**(gauge) | The 95th percentile of request duration time.*Shown as millisecond* | | **gunicorn.request.duration.avg**(gauge) | The average request duration time.*Shown as millisecond* | | **gunicorn.request.duration.count**(rate) | The rate of requests received.*Shown as request* | | **gunicorn.request.duration.max**(gauge) | The maximum request duration time.*Shown as millisecond* | | **gunicorn.request.duration.median**(gauge) | The median request duration time.*Shown as millisecond* | | **gunicorn.request.status.100**(rate) | The rate of requests that generate responses with a 100 status code.*Shown as request* | | **gunicorn.request.status.101**(rate) | The rate of requests that generate responses with a 101 status code.*Shown as request* | | **gunicorn.request.status.102**(rate) | The rate of requests that generate responses with a 102 status code.*Shown as request* | | **gunicorn.request.status.200**(rate) | The rate of requests that generate responses with a 200 status code.*Shown as request* | | **gunicorn.request.status.201**(rate) | The rate of requests that generate responses with a 201 status code.*Shown as request* | | **gunicorn.request.status.202**(rate) | The rate of requests that generate responses with a 202 status code.*Shown as request* | | **gunicorn.request.status.203**(rate) | The rate of requests that generate responses with a 203 status code.*Shown as request* | | **gunicorn.request.status.204**(rate) | The rate of requests that generate responses with a 204 status code.*Shown as request* | | **gunicorn.request.status.205**(rate) | The rate of requests that generate responses with a 205 status code.*Shown as request* | | **gunicorn.request.status.206**(rate) | The rate of requests that generate responses with a 206 status code.*Shown as request* | | **gunicorn.request.status.207**(rate) | The rate of requests that generate responses with a 207 status code.*Shown as request* | | **gunicorn.request.status.208**(rate) | The rate of requests that generate responses with a 208 status code.*Shown as request* | | **gunicorn.request.status.226**(rate) | The rate of requests that generate responses with a 226 status code.*Shown as request* | | **gunicorn.request.status.300**(rate) | The rate of requests that generate responses with a 300 status code.*Shown as request* | | **gunicorn.request.status.301**(rate) | The rate of requests that generate responses with a 301 status code.*Shown as request* | | **gunicorn.request.status.302**(rate) | The rate of requests that generate responses with a 302 status code.*Shown as request* | | **gunicorn.request.status.303**(rate) | The rate of requests that generate responses with a 303 status code.*Shown as request* | | **gunicorn.request.status.304**(rate) | The rate of requests that generate responses with a 304 status code.*Shown as request* | | **gunicorn.request.status.305**(rate) | The rate of requests that generate responses with a 305 status code.*Shown as request* | | **gunicorn.request.status.307**(rate) | The rate of requests that generate responses with a 307 status code.*Shown as request* | | **gunicorn.request.status.308**(rate) | The rate of requests that generate responses with a 308 status code.*Shown as request* | | **gunicorn.request.status.400**(rate) | The rate of requests that generate responses with a 400 status code.*Shown as request* | | **gunicorn.request.status.401**(rate) | The rate of requests that generate responses with a 401 status code.*Shown as request* | | **gunicorn.request.status.402**(rate) | The rate of requests that generate responses with a 402 status code.*Shown as request* | | **gunicorn.request.status.403**(rate) | The rate of requests that generate responses with a 403 status code.*Shown as request* | | **gunicorn.request.status.404**(rate) | The rate of requests that generate responses with a 404 status code.*Shown as request* | | **gunicorn.request.status.405**(rate) | The rate of requests that generate responses with a 405 status code.*Shown as request* | | **gunicorn.request.status.406**(rate) | The rate of requests that generate responses with a 406 status code.*Shown as request* | | **gunicorn.request.status.407**(rate) | The rate of requests that generate responses with a 407 status code.*Shown as request* | | **gunicorn.request.status.408**(rate) | The rate of requests that generate responses with a 408 status code.*Shown as request* | | **gunicorn.request.status.409**(rate) | The rate of requests that generate responses with a 409 status code.*Shown as request* | | **gunicorn.request.status.410**(rate) | The rate of requests that generate responses with a 410 status code.*Shown as request* | | **gunicorn.request.status.411**(rate) | The rate of requests that generate responses with a 411 status code.*Shown as request* | | **gunicorn.request.status.412**(rate) | The rate of requests that generate responses with a 412 status code.*Shown as request* | | **gunicorn.request.status.413**(rate) | The rate of requests that generate responses with a 413 status code.*Shown as request* | | **gunicorn.request.status.414**(rate) | The rate of requests that generate responses with a 414 status code.*Shown as request* | | **gunicorn.request.status.415**(rate) | The rate of requests that generate responses with a 415 status code.*Shown as request* | | **gunicorn.request.status.416**(rate) | The rate of requests that generate responses with a 416 status code.*Shown as request* | | **gunicorn.request.status.417**(rate) | The rate of requests that generate responses with a 417 status code.*Shown as request* | | **gunicorn.request.status.419**(rate) | The rate of requests that generate responses with a 419 status code.*Shown as request* | | **gunicorn.request.status.421**(rate) | The rate of requests that generate responses with a 421 status code.*Shown as request* | | **gunicorn.request.status.422**(rate) | The rate of requests that generate responses with a 422 status code.*Shown as request* | | **gunicorn.request.status.423**(rate) | The rate of requests that generate responses with a 423 status code.*Shown as request* | | **gunicorn.request.status.424**(rate) | The rate of requests that generate responses with a 424 status code.*Shown as request* | | **gunicorn.request.status.426**(rate) | The rate of requests that generate responses with a 426 status code.*Shown as request* | | **gunicorn.request.status.428**(rate) | The rate of requests that generate responses with a 428 status code.*Shown as request* | | **gunicorn.request.status.429**(rate) | The rate of requests that generate responses with a 429 status code.*Shown as request* | | **gunicorn.request.status.431**(rate) | The rate of requests that generate responses with a 431 status code.*Shown as request* | | **gunicorn.request.status.451**(rate) | The rate of requests that generate responses with a 451 status code.*Shown as request* | | **gunicorn.request.status.500**(rate) | The rate of requests that generate responses with a 500 status code.*Shown as request* | | **gunicorn.request.status.501**(rate) | The rate of requests that generate responses with a 501 status code.*Shown as request* | | **gunicorn.request.status.502**(rate) | The rate of requests that generate responses with a 502 status code.*Shown as request* | | **gunicorn.request.status.503**(rate) | The rate of requests that generate responses with a 503 status code.*Shown as request* | | **gunicorn.request.status.504**(rate) | The rate of requests that generate responses with a 504 status code.*Shown as request* | | **gunicorn.request.status.505**(rate) | The rate of requests that generate responses with a 505 status code.*Shown as request* | | **gunicorn.request.status.506**(rate) | The rate of requests that generate responses with a 506 status code.*Shown as request* | | **gunicorn.request.status.507**(rate) | The rate of requests that generate responses with a 507 status code.*Shown as request* | | **gunicorn.request.status.508**(rate) | The rate of requests that generate responses with a 508 status code.*Shown as request* | | **gunicorn.request.status.510**(rate) | The rate of requests that generate responses with a 510 status code.*Shown as request* | | **gunicorn.request.status.511**(rate) | The rate of requests that generate responses with a 511 status code.*Shown as request* | | **gunicorn.request.status.512**(rate) | The rate of requests that generate responses with a 512 status code.*Shown as request* | | **gunicorn.requests**(rate) | The rate of requests received.*Shown as request* | | **gunicorn.workers**(gauge) | The number of workers tagged by state (idle or working). A worker is busy if it has a recorded CPU-time increase over a 0.1-sec interval (through psutil). A worker is idle if no CPU-time change is detected, even if the worker is blocked on I/O (such as waiting on HTTP/database calls).*Shown as worker* | ### Events{% #events %} The Gunicorn check does not include any events. ### Service Checks{% #service-checks %} **gunicorn.is\_running** Returns `CRITICAL` if the Agent is unable to find the Gunicorn master process. Returns `OK` otherwise. *Statuses: ok, critical* ## Troubleshooting{% #troubleshooting %} ### Agent cannot find Gunicorn process{% #agent-cannot-find-gunicorn-process %} ```shell 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 ``` Either Gunicorn really isn't running, or your app's Python environment doesn't have the `setproctitle` package installed. If `setproctitle` is not installed, Gunicorn appears in the process table like so: ```text $ 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 ``` If it *is* installed, `gunicorn` processes appear in the format the Datadog Agent expects: ```text $ 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] ``` ## Further Reading{% #further-reading %} - [Monitor Gunicorn performance with Datadog](https://www.datadoghq.com/blog/monitor-gunicorn-performance)