swift-recon(1)

💖 swift-recon — the manual, but make it make sense 💖

okay bestie, sit down, hydrate, and let me tell you about swift-recon, aka the OpenStack Swift recon middleware cli tool. yes it's a mouthful. yes it's iconic. this is the page for section 1 of the manual, so buckle up 🎀

✨ NAME ✨

swift-recon — OpenStack Swift recon middleware cli tool 🦋

🌸 SYNOPSIS 🌸

like, here's the whole vibe in one block:

swift-recon  <server_type> [-v] [--suppress] [-a] [-r] [-u] [-d] [-l]
[-T] [--md5] [--auditor] [--updater] [--expirer] [--sockstat]

copy it exactly, no cap, every bracket matters 💅

👑 DESCRIPTION 👑

so the swift-recon cli tool is literally the girl who goes and retrieves various metrics and telemetry information about a cluster that has been collected by the swift-recon middleware. she's the messenger. she's the main character. she does not generate the data, she just shows up with receipts ✨

and here's the tea: if you actually wanna use the swift-recon middleware, you gotta update the object-server.conf file and enable the recon middleware by adding a pipeline entry and setting its option(s). the example section below has the details, so don't skip it, i'm watching 🫶

💅 OPTIONS 💅

every single one, in order, no skipping. this is a full send.

• <server_type> — your options are account | container | object. if you don't say anything it just Defaults to object server. she picks for you, she's confident like that 💁
• -h, --help — shows this help message and then dips. exit. gone. 😌
• -v, --verbose — print verbose information, aka she tells you everything. oversharing as a service 🗣️
• --suppress — suppress most connection related errors. we're keeping it chill, we're not gonna spiral over every little hiccup 🙈
• -a, --async — get async stats 📊
• --auditor — get auditor stats 🔍
• --updater — get updater stats 🔄
• --expirer — get expirer stats ⏳
• -r, --replication — get replication stats 🪞
• -R, --reconstruction — get reconstruction stats 🧩
• -u, --unmounted — check the cluster for unmounted devices 🚨
• -d, --diskusage — get disk usage stats 💾
• --top=COUNT — also show the top COUNT entries in rank order. leaderboard behavior, we love a ranking 🏆
• --lowest=COUNT — also show the lowest COUNT entries in rank order. someone's gotta be at the bottom, and we're gonna name names 📉
• --human-readable — use human readable suffix for disk usage stats. numbers that actually fit in your brain, thank god 🧠
• -l, --loadstats — get cluster load average stats ⚖️
• -q, --quarantined — get cluster quarantine stats 🦠
• --validate-servers — validate servers on the ring ✅
• --md5 — get md5sum of servers ring and compare to local copy. checksum girlies rise 🔐
• --sockstat — get cluster socket usage stats 🧦
• --driveaudit — get drive audit error stats 🔎
• -T, --time — check time synchronization ⏰
• --swift-versions — check swift version 🏷️
• --all — perform all checks. and it's equivalent to -arudlqT --md5 --sockstat --auditor --updater --expirer --driveaudit --validate-servers --swift-versions. that's the whole menu, the whole platter, the entire vibe ✨
• --region=REGION — only query servers in specified region 🗺️
• -z ZONE, --zone=ZONE — only query servers in specified zone 🎯
• -t SECONDS, --timeout=SECONDS — time to wait for a response from a server. patience is a virtue but it is also a finite resource ⏱️
• --swiftdir=PATH — Default = /etc/swift 📁

🌈 EXAMPLE 🌈

here's her in her natural habitat, serving looks:

ubuntu:~$ swift-recon -q --zone 3
=================================================================
[2011-10-18 19:36:00] Checking quarantine dirs on 1 hosts...
[Quarantined objects] low: 4, high: 4, avg: 4, total: 4
[Quarantined accounts] low: 0, high: 0, avg: 0, total: 0
[Quarantined containers] low: 0, high: 0, avg: 0, total: 0
=================================================================

and then, finally — the way that you'd also wanna track asynchronous pending's — you will need to setup a cronjob to run the swift-recon-cron script periodically:

*/5 * * * * swift /usr/bin/swift-recon-cron /etc/swift/object-server.conf

that's the cron line. every 5 minutes. she's punctual. she has a schedule. she's booked and busy 💅

📚 DOCUMENTATION 📚

more documentation about OpenStack Swift can be found at https://docs.openstack.org/swift/latest/

also, more specific documentation about swift-recon can be found at https://docs.openstack.org/swift/latest/admin_guide.html

go read. i'll wait. bestie homework 📖✨

🫶 SEE ALSO 🫶

object-server.conf(5), — yes she's the one you gotta edit, we already said it, but the cross-reference is right there 🌸

okay that's the whole page!! this one was Linux, 8/26/2011, and it's filed under swift-recon(1) if you ever need to find her again. go forth, run your checks, and remember: rank order is a love language 🎀💖 bye bestie!!