carta
prometheus-squid-exporter(1)

prometheus-squid-exporter1

Prometheus exporter which exposes squid proxy server metrics obtained via the cache manager api.

Usage

prometheus-squid-exporter [options]

Overview

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-use-proxy-header

Use proxy headers when fetching metrics from Squid

-squid-pidfile string

Optional path to the squid PID file for additional metrics.

-extractservicetimes

Extract service times metrics (default true).

-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

History

  • Debian 13 (Trixie): the text shown here
  • Debian 12 (Bookworm) to Debian 11 (Bullseye)
  • Debian 10 (Buster)

-extractservicetimes since Debian 13 (Trixie); -label since Debian 11 (Bullseye); -listen since Debian 11 (Bullseye); -metrics-path since Debian 11 (Bullseye); -squid-hostname since Debian 11 (Bullseye); -squid-login since Debian 11 (Bullseye); -squid-password since Debian 11 (Bullseye); -squid-pidfile since Debian 11 (Bullseye); -squid-port since Debian 11 (Bullseye); -squid-use-proxy-header since Debian 13 (Trixie); -version since Debian 11 (Bullseye).

Author

Mohamad Arab <[email protected]>

From prometheus-squid-exporter 1.12.0-1+b9 in Debian 13 (Trixie). Parsed by carta from the page's man source.