PGEXPORTER(1)

📦 version 0.7.0, in alpine 3.24

💅 PGEXPORTER(1) — like, the whole vibe

okay so bestie, welcome to PGEXPORTER, a page from the General Commands Manual (section 1, obvi), and it's literally the most main-character tool for getting your PostgreSQL stats out into Prometheus. let's get into it ✨

🌸 NAME 🌸

pgexporter — a Prometheus exporter for PostgreSQL. that's it, that's the whole name, and honestly? iconic. 👑

🦋 SYNOPSIS 🦋

pgexporter [ -c CONFIG_FILE ] [ -u USERS_FILE ] [ -d ]

that's the bare minimum of what you can throw at it. the rest of the options? they're down there, don't worry, we're getting to all of them fr fr.

💖 DESCRIPTION 💖

Prometheus exporter for PostgreSQL.

no cap, that's genuinely the description. it exports PostgreSQL metrics so Prometheus can eat them up. simple, clean, ate. 💅

✨ OPTIONS ✨

okay this is the part you actually came for, so let's go, one by one, no skipping, we don't do that here 🫶

  • -c, --config CONFIG_FILE — sets the path to the pgexporter.conf file. your main config, the moment. 🎀
  • -u, --users USERS_FILE — sets the path to the pgexporter_users.conf file. that's where your user situation lives.
  • -A, --admins ADMINS_FILE — sets the path to the pgexporter_admins.conf file. admin business, very important, we respect it.
  • -D, --directory DIRECTORY — sets the configuration directory. like, the whole folder, not just one file. highkey convenient.
  • -Y, --yaml METRICS_FILE_DIR — sets the path to a YAML file or directory. yes, file or directory, both are valid, we love flexibility. 🦋
  • -d, --daemon — run as a daemon. bye bye foreground, hello background vibes. 🌈
  • -C, --colectors NAME_1,NAME_2,...,NAME_N — enable only specific collectors. (yes, it's spelled --colectors in the manual — keep it exactly like that, don't be the person who "fixes" it, i'm begging 🙈) you give it a comma-separated list of names.
  • -V, --version — display version information. the classic "which one am i even running" check. 💀
  • -?, --help — display help. the -? is a whole mood but it works, trust.
fr fr, copy those flag spellings character for character — --colectors and -? are not typos on my end, they're straight from the source and we do not touch them. 💜

🐛 REPORTING BUGS 🐛

pgexporter is maintained on GitHub at <https://github.com/pgexporter/pgexporter>

found something cursed? take it there, the maintainers wanna know, and no, don't just suffer in silence bestie 😭

pgexporter is licensed under the 3-clause BSD License. legal queen behavior, we stan proper licensing. ⭐

🔥 SEE ALSO 🔥

go read those too, iykwim, they're the supporting cast and they understood the assignment 🧚

okay that's the whole page, you're all caught up 💖 mwah. this lil beauty lives in the General Commands Manual and signs off as PGEXPORTER(1) — periodt. 🍓

📦 where this page comes from