Skip to main content


Plugin: python.d.plugin Module: squid


This collector monitors statistics about the Squid Clients and Servers, like bandwidth and requests.

It collects metrics from the endpoint where Squid exposes its counters data.

This collector is supported on all platforms.

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

Default Behavior


By default, this collector will try to autodetect where Squid presents its counters data, by trying various configurations.


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.


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 Squid instance

These metrics refer to each monitored Squid instance.

This scope has no labels.


squid.clients_netin, out, hitskilobits/s
squid.clients_requestsrequests, hits, errorsrequests/s
squid.servers_netin, outkilobits/s
squid.servers_requestsrequests, errorsrequests/s


There are no alerts configured by default for this integration.



Configure Squid's Cache Manager

Take a look at Squid's official documentation on how to configure access to the Cache Manager.



The configuration file name for this integration is python.d/squid.conf.

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

cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config python.d/squid.conf


There are 2 sections:

  • Global variables
  • One or more JOBS that can define multiple different instances to monitor.

The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.

Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.

Every configuration JOB starts with a job_name value which will appear in the dashboard, unless a name parameter is specified.

Config options
update_everySets the default data collection frequency.1no
priorityControls the order of charts at the netdata dashboard.60000no
autodetection_retrySets the job re-check interval in seconds.0no
penaltyIndicates whether to apply penalty to update_every in case of failures.yesno
nameJob name. This value will overwrite the job_name value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.localno
hostThe host to connect to.yes
portThe port to connect to.yes
requestThe URL to request from Squid.yes



A basic configuration example.

name: 'local'
host: 'localhost'
port: 3128
request: 'cache_object://localhost:3128/counters'


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

Collecting metrics from local and remote instances.

name: 'local'
host: ''
port: 3128
request: 'cache_object://'

name: 'remote'
host: ''
port: 3128
request: 'cache_object://'


Debug Mode

To troubleshoot issues with the squid collector, run the python.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].

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

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

    ./python.d.plugin squid debug trace

Getting Logs

If you're encountering problems with the squid 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:

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

System without systemd

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

grep squid /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:

docker logs netdata 2>&1 | grep squid

Do you have any feedback for this page? If so, you can open a new issue on our netdata/learn repository.