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
       RediSearch index, diagnostic metrics are requestable by passing
       in key with a value of `text'.  The results will passed to
       on_metrics callback provided by settings.

DIAGNOSTICS         top

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

SEE ALSO         top

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

COLOPHON         top

       This page is part of the PCP (Performance Co-Pilot) project.
       Information about the project can be found at 
       ⟨⟩.  If you have a bug report for this manual
       page, send it to  This page was obtained from the
       project's upstream Git repository
       ⟨⟩ on 2024-06-14.
       (At that time, the date of the most recent commit that was found
       in the repository was 2024-06-14.)  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

Performance Co-Pilot               PCP                   PMSEARCHINFO(3)

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