TRAFFICSERVER_EXPORTER(1)

💖 TRAFFICSERVER_EXPORTER(1) 💖

okay bestie, pull up a chair, we're doing the prometheus-trafficserver-exporter manual page and honestly? it's giving "small utility, big feelings." this lil guy lives in the User Commands section and its whole job is being a Prometheus exporter for Apache Traffic Server. no cap. 🦋

🌸 NAME 🌸

prometheus-trafficserver-exporter — a Prometheus exporter for Apache Traffic Server. that's it, that's the name, she's simple and she knows it 💅

✨ DESCRIPTION ✨

here's the usage, verbatim, don't @ me:

usage: prometheus-trafficserver-exporter [-h] [--endpoint ENDPOINT]
       [--metrics-file METRICS_FILE] [--addr ADDR]

       [--port PORT] [--pidfile PIDFILE] [--procstats]
              [--no-procstats] [--no-ssl-verification] [--max-retries
              MAX_RETRIES] [-v]

Traffic Server exporter for Prometheus. that's the whole pitch. main character energy fr fr 👑

🎀 optional arguments 🎀

so this is where it gets juicy. every single one, let's go:

• -h, --help — shows this help message and then dips. classic. exit stage left. 🚪
• --endpoint ENDPOINT — the URL of Traffic Server's stats_over_http plugin. default is http://127.0.0.1/_stats. that's where the tea gets spilled ☕
• --metrics-filefR METRICS_FILE — the YAML file that holds the metrics definition. default: it just uses the metrics file shipped inside the package. and YES, the flag is literally spelled --metrics-filefR with a stray fR in there — not me, not a typo on my end, that's just what the page says, iykyk 😭 (the usage line up top says --metrics-file, so like… be aware, bestie. type carefully.)
• --addr ADDR — the address to bind and listen on. default is empty — like, nothing, blank, the void. default: (nothing) 🫥
• --port PORT — the port to bind and listen on. default: 9122 🔢
• --pidfile PIDFILE — path to the trafficserver PID file. this one only matters when you're using --procstats. default: /var/run/trafficserver/server.lock 📁
• --procstats — turn ON process metric collection. default: True 🌟
• --no-procstats — turn OFF process metric collection. default: True 🙈
• --no-ssl-verification — disables SSL certificate verification while collecting metrics. default: True 🔓

okay real talk for a sec — --no-ssl-verification is exactly what it sounds like. you're turning off cert checking. be normal about it and only do it when you actually mean it, bestie. 🚨

• --max-retries MAX_RETRIES — maximum retries for DNS lookups or connection timeouts/failures (and yes, the original spells it "connnection" with three n's, we are keeping that energy 🫶). default: 0
• -v, --verbose — verbose logging. repeat it for more verbosity, stack those v's like accessories. default: 0 🗣️

🔥 SEE ALSO 🔥

the full documentation for prometheus-trafficserver-exporter is maintained as a Texinfo manual. so if info and the prometheus-trafficserver-exporter programs are properly installed at your site, this command:

info prometheus-trafficserver-exporter

should give you access to the complete manual. go get your lore, queen 📚✨

and that's the whole page!! every flag, every default, every weird little typo, preserved with love 💜

signing off from the prometheus-trafficserver-expor... corner of the world, August 2018 edition, living under TRAFFICSERVER_EXPORTER(1) — mwah, stay slaying 💅🎀🌈