---
name: "prometheus-squid-exporter"
section: "1"
platform: "linux"
package: "prometheus-squid-exporter"
version: "1.12.0-1+b9"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/prometheus-squid-exporter"
---

# prometheus-squid-exporter(1)

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

## 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-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

## SEE ALSO

[**squid**(8)](/squid/8.md)

## AUTHOR

Mohamad Arab \<boynux@gmail.com\>