Back to Netdata

uWSGI

src/go/plugin/go.d/collector/uwsgi/README.md

2.10.39.0 KB
Original Source
<!--startmeta custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/uwsgi/README.md" meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/uwsgi/metadata.yaml" sidebar_label: "uWSGI" learn_status: "Published" learn_rel_path: "Collecting Metrics/Collectors/Web Servers and Proxies" keywords: ['application server', 'python', 'web applications'] message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" endmeta-->

uWSGI

Plugin: go.d.plugin Module: uwsgi

Overview

Monitors UWSGI worker health and performance by collecting metrics like requests, transmitted data, exceptions, and harakiris.

It fetches Stats Server statistics over TCP.

This collector is supported on all platforms.

This collector supports collecting metrics from multiple instances of this integration, including remote instances.

Default Behavior

Auto-Detection

Automatically discovers and collects UWSGI statistics from the following default locations:

  • localhost:1717

Limits

The default configuration for this integration does not impose any limits on data collection.

Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.

Setup

You can configure the uwsgi collector in two ways:

MethodBest forHow to
UIFast setup without editing filesGo to Nodes → Configure this node → Collectors → Jobs, search for uwsgi, then click + to add a job.
FileIf you prefer configuring via file, or need to automate deployments (e.g., with Ansible)Edit go.d/uwsgi.conf and add a job.

:::important

UI configuration requires paid Netdata Cloud plan.

:::

Prerequisites

Enable the uWSGI Stats Server

See Stats Server for details.

Configuration

Options

The following options can be defined globally: update_every, autodetection_retry.

<details open><summary>Config options</summary>
GroupOptionDescriptionDefaultRequired
Collectionupdate_everyData collection frequency.1no
autodetection_retryRecheck interval in seconds. Zero means no recheck will be scheduled.0no
TargetaddressThe IP address and port where the UWSGI Stats Server listens for connections.127.0.0.1:1717yes
timeoutConnection, read, and write timeout duration in seconds. The timeout includes name resolution.1no
Virtual NodevnodeAssociates this data collection job with a Virtual Node.no
</details>

via UI

Configure the uwsgi collector from the Netdata web interface:

  1. Go to Nodes.
  2. Select the node where you want the uwsgi data-collection job to run and click the :gear: (Configure this node). That node will run the data collection.
  3. The Collectors → Jobs view opens by default.
  4. In the Search box, type uwsgi (or scroll the list) to locate the uwsgi collector.
  5. Click the + next to the uwsgi collector to add a new job.
  6. Fill in the job fields, then click Test to verify the configuration and Submit to save.
    • Test runs the job with the provided settings and shows whether data can be collected.
    • If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.

via File

The configuration file name for this integration is go.d/uwsgi.conf.

The file format is YAML. Generally, the structure is:

yaml
update_every: 1
autodetection_retry: 0
jobs:
  - name: some_name1
  - name: some_name2

You can edit the configuration file using the edit-config script from the Netdata config directory.

bash
cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/uwsgi.conf
Examples
Basic

A basic example configuration.

<details open><summary>Config</summary>
yaml
jobs:
  - name: local
    address: 127.0.0.1:1717

</details>
Multi-instance

Note: When you define multiple jobs, their names must be unique.

Collecting metrics from local and remote instances.

<details open><summary>Config</summary>
yaml
jobs:
  - name: local
    address: 127.0.0.1:1717

  - name: remote
    address: 203.0.113.0:1717

</details>

Alerts

There are no alerts configured by default for this integration.

Metrics

Metrics grouped by scope.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.

Per uWSGI instance

These metrics refer to the entire monitored application.

This scope has no labels.

Metrics:

MetricDimensionsUnit
uwsgi.transmitted_datatxbytes/s
uwsgi.requestsrequestsrequests/s
uwsgi.harakirisharakirisharakiris/s
uwsgi.respawnsrespawnsrespawns/s

Per worker

These metrics refer to the Worker process.

Labels:

LabelDescription
worker_idWorker ID.

Metrics:

MetricDimensionsUnit
uwsgi.worker_transmitted_datatxbytes/s
uwsgi.worker_requestsrequestsrequests/s
uwsgi.worker_delta_requestsdelta_requestsrequests/s
uwsgi.worker_average_request_timeavgmilliseconds
uwsgi.worker_harakirisharakirisharakiris/s
uwsgi.worker_exceptionsexceptionsexceptions/s
uwsgi.worker_statusidle, busy, cheap, pause, sigstatus
uwsgi.worker_request_handling_statusaccepting, not_acceptingstatus
uwsgi.worker_respawnsrespawnsrespawns/s
uwsgi.worker_memory_rssrssbytes
uwsgi.worker_memory_vszvszbytes

Troubleshooting

Debug Mode

Important: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.

To troubleshoot issues with the uwsgi collector, run the go.d.plugin with the debug option enabled. The output should give you clues as to why the collector isn't working.

  • Navigate to the plugins.d directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the plugins setting under [directories].

    bash
    cd /usr/libexec/netdata/plugins.d/
    
  • Switch to the netdata user.

    bash
    sudo -u netdata -s
    
  • Run the go.d.plugin to debug the collector:

    bash
    ./go.d.plugin -d -m uwsgi
    

    To debug a specific job:

    bash
    ./go.d.plugin -d -m uwsgi -j jobName
    

Getting Logs

If you're encountering problems with the uwsgi collector, follow these steps to retrieve logs and identify potential issues:

  • Run the command specific to your system (systemd, non-systemd, or Docker container).
  • Examine the output for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.

System with systemd

Use the following command to view logs generated since the last Netdata service restart:

bash
journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep uwsgi

System without systemd

Locate the collector log file, typically at /var/log/netdata/collector.log, and use grep to filter for collector's name:

bash
grep uwsgi /var/log/netdata/collector.log

Note: This method shows logs from all restarts. Focus on the latest entries for troubleshooting current issues.

Docker Container

If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:

bash
docker logs netdata 2>&1 | grep uwsgi