Reference

pmSearchInfo(3)

diagnostic metrics of PCP search services

NAME

pmSearchInfo - diagnostic metrics of PCP search services

C SYNOPSIS

#include <pcp/pmwebapi.h>

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

cc ... -lpcp_web

DESCRIPTION

Provides diagnostic information about the Performance Co-Pilot (PCP) full-text search index.

Diagnostic metrics are requestable by passing in key with a value of `text'. The results (such as document count) will be passed to the on_metrics callback provided by settings.

DIAGNOSTICS

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

SEE ALSO

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

History