PROMETH...EXPORTER(1)

📦
version 1.13.0 · 2 versions
, in debian trixie, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 NAME 💖

prometheus-squid-exporter — it's the Prometheus exporter that spills all the Squid proxy server metrics it got from the cache manager API. no cap, that's literally the whole job. 🦑

✨ SYNOPSIS ✨

prometheus-squid-exporter [options]

🌸 DESCRIPTION 🌸

Okay bestie, listen. This little icon grabs Squid proxy server metrics by talking to the cache manager API, and then serves them right back up as Prometheus metrics. It's giving middle-man, but make it observability. 💅

Here's the tea on what it exposes:

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

Periodt. That's the menu. 🎀

👑 OPTIONS 👑

  • -listen string — the address where the exporter parks itself and shows off (default ":9301").
  • -metrics-path string — the path under which metrics get exposed (default "/metrics").
  • -squid-hostname string — which Squid server we're connecting to (default "localhost").
  • -squid-port int — the 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. 🙈 keep it secret, keep it safe.
  • -squid-use-proxy-header — use proxy headers when fetching metrics from Squid.
  • -squid-pidfile string — optional path to the squid PID file, for bonus extra metrics. 🍓
  • -extractservicetimes — extract service times metrics (default true).
  • -label value — custom metrics to attach to metrics; hit -label multiple times, once for each additional label you want. the way that stacks up... obsessed. 🌈
  • -version — print version and exit. bye bestie 👋

🦋 ENVIRONMENT 🦋

These environment variables can override the default parameters, iykyk:

  • SQUID_EXPORTER_LISTEN
  • SQUID_EXPORTER_METRICS_PATH
  • SQUID_HOSTNAME
  • SQUID_PORT
  • SQUID_LOGIN
  • SQUID_PASSWORD

💜 SEE ALSO 💜

squid(8) — go say hi to the main character. 👑

🧚 AUTHOR 🧚

Mohamad Arab <boynux@gmail.com>

and that's the whole page, bestie — version 1.11.0, from February 2024, brought to you by the prometheus-squid-exporter man page. slay, stay hydrated, and may your counters always increment. 💖✨🎀

📦 where this page comes from