pmSearchInfo(3)

diagnostic metrics of PCP search services

Section 3 libpcp3-dev bookworm source

Description

PMSEARCHINFO

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

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

Currently, as all fulltext 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

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

SEE ALSO

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