.TH PROMETHEUS-SQUID-EXPORTER 1 "January 2019" "1.4" "prometheus-squid-exporter man page"
.SH NAME
prometheus-squid-exporter \- Prometheus exporter which exposes Squid proxy
server metrics obtained via the cache manager API.
.SH SYNOPSIS
prometheus-squid-exporter [options]
.SH DESCRIPTION
This exporter parses Squid proxy server metrics from the cache manager API and
exposes them as Prometheus metrics, including:

.PP
 * Cache hit counters
 * Client HTTP request / byte counters
 * Server HTTP / FTP requests
 * Request error counters
.SH OPTIONS
.PP
\f[B]\-listen\f[] \f[I]string\f[] Address on which to expose exporter (default
":9301").
.PP
\f[B]\-metrics\-path\f[] \f[I]string\f[] Path under which to expose metrics
(default "/metrics").
.PP
\f[B]\-squid\-hostname\f[] \f[I]string\f[] Squid server to connect to (default
"localhost").
.PP
\f[B]\-squid\-login\f[] \f[I]string\f[] Optional username for Squid cache
manager HTTP basic authentication.
.PP
\f[B]\-squid\-password\f[] \f[I]string\f[] Optional password for Squid cache
manager HTTP basic authentication.
.PP
\f[B]\-squid\-port\f[] \f[I]int\f[] Squid cache manager port (default: 3128).
.PP
\f[B]\-version\f[] Print version and exit.
.SH SEE ALSO
\f[B]squid\f[](8)
.SH AUTHOR
Mohamad Arab <boynux@gmail.com>