---
name: "pmSearchInfo"
section: "3"
platform: "linux"
package: "pcp"
version: "7.2.2-2"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/pmSearchInfo"
---

# 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)](/pmproxy/1.md), [**pmlogger**(1)](/pmlogger/1.md), [**pmsearch**(1)](/pmsearch/1.md), [**pmSearchSetup**(3)](/pmSearchSetup/3.md), [**PMAPI**(3)](/PMAPI/3.md) and [**PMWEBAPI**(3)](/PMWEBAPI/3.md).