1PMSEARCH(1)                 General Commands Manual                PMSEARCH(1)
2
3
4

NAME

6       pmsearch  -  help  text  and  names  search  for metrics, instances and
7       instance domains
8

SYNOPSIS

10       pmsearch [-CdinqsStTV?]  [-c config] [-h host] [-p  port]  [-N  number]
11       [-O offset] [query | indom]
12

DESCRIPTION

14       pmsearch  performs full text search queries to find metrics using names
15       and help text from metrics, instance domains and instances.
16
17       It  makes  use  of  capabilties  of  the  Performance  Co-Pilot   (PCP)
18       pmproxy(1)  service,  the  Redis distributed data store, and the RediS‐
19       earch module.
20
21       Note that in order to use these services, it is mandatory that  pmproxy
22       is communicating with a redis-server(1) that has the redisearch.so mod‐
23       ule loaded.  When configured to do so, pmproxy will then  automatically
24       index PCP metric names, instance names, metric and instance domain help
25       text into the RediSearch store, from PCP  archives  that  it  discovers
26       locally.   Refer  to  pmlogger(1)  and  pmlogger_daily(1)  for  further
27       details.
28
29       By default pmsearch communicates with a local redis-server(1),  however
30       the  -h  and  -p  options  can  be  used  to specify an alternate Redis
31       instance.  If this instance is a node of a  Redis  cluster,  all  other
32       instances in the cluster will be discovered and used automatically.
33

OPTIONS

35       -c config, --config=config
36            Specify the config file to use.
37
38       -C, --no-colour
39            No highlighting in results text.
40
41       -d, --docid
42            Report  document  ID of each search result.  Documents are identi‐
43            fied using a unique SHA-1 hash which  is  always  displayed  in  a
44            40-hexdigit human readable form.
45
46       -h host, --host=host
47            Connect  to  the  Redis  server  at  host, rather than the one the
48            localhost.
49
50       -i, --info
51            Report search engine internal metrics.
52
53       -n, --indom
54            Perform an instance domain related entities search
55
56       -N N, --number=N
57            Return N, search results at most.
58
59       -O N, --offset=N
60            Paginated results from given offset.
61
62       -q, --query
63            Perform a general text search (default).
64
65       -s, --suggest
66            Peform a name suggestion search
67
68       -S, --score
69            Report score (rank) of each result.
70
71       -T, --total
72            Report total number of of search results.
73
74       -t, --times
75            Report elapsed search execution time.
76
77       -V, --version
78            Display version number and exit.
79
80       -?, --help
81            Display usage message and exit.
82

EXAMPLES

84         $ pmsearch kernel idle
85         Type: metric
86         Name: kernel.all.cpu.idle
87         One line: total idle CPU time from /proc/stat for all CPUs
88
89         Type: metric
90         Name: kernel.all.idletime
91         One line: time the current kernel has been idle since boot
92
93         Type: metric
94         Name: kernel.percpu.cpu.idle
95         InDom: 60.0
96         One line: percpu idle CPU time metric from /proc/stat
97

PCP ENVIRONMENT

99       Environment variables with the prefix PCP_ are used to parameterize the
100       file  and  directory names used by PCP.  On each installation, the file
101       /etc/pcp.conf contains the  local  values  for  these  variables.   The
102       $PCP_CONF  variable may be used to specify an alternative configuration
103       file, as described in pcp.conf(5).
104
105       For environment variables affecting PCP tools, see pmGetOptions(3).
106

SEE ALSO

108       PCPIntro(1), pmproxy(1), pmlogger(1), pmlogger_daily(1) and redis-serv‐
109       er(1).
110
111
112
113Performance Co-Pilot                  PCP                          PMSEARCH(1)
Impressum