PMSEARCHINFO(3)

💖 NAME 💖

pmSearchInfo — the diagnostic metrics plug for PCP's search services, bestie 🔍✨

---

🌸 C SYNOPSIS 🌸

#include <pcp/pmwebapi.h>

int pmSearchInfo(pmSearchSettings *settings, sds key, void *arg);

cc ... -lpcp_web

---

🦋 DESCRIPTION 🦋

okay so this one is literally just the gossip channel for the Performance Co-Pilot (PCP) full-text search index — it hands you the diagnostic info about what's going on in there. 🫶

the way that you get those diagnostic metrics is by passing in key with a value of text. yes queen, that exact string. 👑

and then the results — think stuff like the document count, the receipts basically 📊 — get passed straight to the on_metrics callback that was provided by settings. so make sure settings is cute and set up, because that's where the tea gets delivered. ☕💅

---

😭 DIAGNOSTICS 😭

bestie listen: on success this function always returns zero. zero. every time. slay. ✨

but on failure? it hits you with a negative PMAPI error code. so if you see a negative number, that's the vibe check failing, and you should go read up on PMAPI errors. 💀

---

👑 SEE ALSO 👑

• pmproxy(1)
• pmlogger(1)
• pmsearch(1)
• pmSearchSetup(3)
• PMAPI(3)
• PMWEBAPI(3)

---

Performance Co-Pilot 🎀 PCP 🎀 PMSEARCHINFO(3)

that's the whole page babes, mwah 💖 go read those other man pages, iykyk 🧚🌈⭐