pmsearchinfo(3) — Linux manual page

PMSEARCHINFO(3)          Library Functions Manual         PMSEARCHINFO(3)

NAME         top

       pmSearchInfo - diagnostic metrics of PCP search services

C SYNOPSIS         top

       #include <pcp/pmwebapi.h>

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

       cc ... -lpcp_web

DESCRIPTION         top

       Diagnostic metrics related to the Performance Co-Pilot (PCP) fast,
       scalable and full-text capable search services.

       Currently,  as  all  full-text  related  services are using single
       ValkeySearch index, diagnostic metrics are requestable by  passing
       in key with a value of `text'.  The results will passed to on_met‐
       rics callback provided by settings.

DIAGNOSTICS         top

       This  function always returns zero on success.  On failure a nega‐
       tive PMAPI error code is returned.

SEE ALSO         top

       pmproxy(1), pmlogger(1), pmsearch(1),  pmSearchSetup(3),  PMAPI(3)
       and PMWEBAPI(3).

COLOPHON         top

       This  page is part of the PCP (Performance Co-Pilot) project.  In‐
       formation about the project can be found at  ⟨http://www.pcp.io/⟩.
       If  you  have  a  bug  report  for  this  manual  page, send it to
       pcp@groups.io.  This page was obtained from the project's upstream
       Git repository ⟨https://github.com/performancecopilot/pcp.git⟩  on
       2025-08-11.   (At  that  time,  the date of the most recent commit
       that was found in the repository was 2025-08-11.)  If you discover
       any rendering problems in this HTML version of the  page,  or  you
       believe  there is a better or more up-to-date source for the page,
       or you have corrections or improvements to the information in this
       COLOPHON (which is not part of the original manual page),  send  a
       mail to man-pages@man7.org

Performance Co-Pilot               PCP                    PMSEARCHINFO(3)

Pages that refer to this page: pmsearchsetup(3),  pmwebapi(3)

HTML rendering created 2025-09-06 by Michael Kerrisk, author of The Linux Programming Interface. For details of in-depth Linux/UNIX system programming training courses that I teach, look here. Hosting by jambit GmbH.