prometheus-squid-exporter(1)

Prometheus exporter which exposes Squid proxy

Section 1 prometheus-squid-exporter bookworm source

Description

PROMETHEUS-SQUID-EXPORTER

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

-listen string

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

-metrics-path string

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

-squid-hostname string

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

-squid-port int

Squid cache manager port (default: 3128).

-squid-login string

Optional username for Squid cache manager HTTP basic authentication.

-squid-password string

Optional password for Squid cache manager HTTP basic authentication.

-squid-pidfile string

Optional path to the squid PID file for additional metrics.

-label value

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

-version

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>