Scroll to navigation

PROMETHEUS-SQUID-EXPORTER(1) prometheus-squid-exporter man page PROMETHEUS-SQUID-EXPORTER(1)

NAME

prometheus-squid-exporter - Prometheus exporter which exposes Squid proxy server metrics obtained via the cache manager API.

SYNOPSIS

prometheus-squid-exporter [options]

DESCRIPTION

This exporter parses Squid proxy server metrics from the cache manager API and exposes them as Prometheus metrics, including:

Cache hit counters
Client HTTP request / byte counters
Server HTTP / FTP requests
Request error counters

OPTIONS

Address on which to expose exporter (default ":9301").

Path under which to expose metrics (default "/metrics").

Squid server to connect to (default "localhost").

Squid cache manager port (default: 3128).

Optional username for Squid cache manager HTTP basic authentication.

Optional password for Squid cache manager HTTP basic authentication.

Use proxy headers when fetching metrics from Squid

Optional path to the squid PID file for additional metrics.

Extract service times metrics (default true).

Custom metrics to attach to metrics, use -label multiple times for each additional label.

Print version and exit.

ENVIRONMENT

The following environment variables can be used to override default parameters:

SQUID_EXPORTER_LISTEN
SQUID_EXPORTER_METRICS_PATH
SQUID_HOSTNAME
SQUID_PORT
SQUID_LOGIN
SQUID_PASSWORD

SEE ALSO

squid(8)

AUTHOR

Mohamad Arab <boynux@gmail.com>

February 2024 1.11.0