1PMSEARCH(1) General Commands Manual PMSEARCH(1)
2
6 pmsearch - help text and names search for metrics, instances and in‐
7 stance domains
8
10 pmsearch [-CdinqsStTV?] [-c config] [-h host] [-p port] [-N number]
11 [-O offset] [query | indom]
12
14 pmsearch performs full text search queries to find metrics using names
15 and help text from metrics, instance domains and instances.
16 It makes use of capabilties of the Performance Co-Pilot (PCP) pm‐
18 proxy(1) service, the Redis distributed data store, and the RediSearch
19 module.
20 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 lo‐
26 cally. Refer to pmlogger(1) and pmlogger_daily(1) for further details.
27 By default pmsearch communicates with a local redis-server(1), however
29 the -h and -p options can be used to specify an alternate Redis in‐
30 stance. If this instance is a node of a Redis cluster, all other in‐
31 stances in the cluster will be discovered and used automatically.
32
34 -c config, --config=config
35 Specify the config file to use.
36 -C, --no-colour
38 No highlighting in results text.
39 -d, --docid
41 Report document ID of each search result. Documents are identi‐
42 fied using a unique SHA-1 hash which is always displayed in a
43 40-hexdigit human readable form.
44 -h host, --host=host
46 Connect to the Redis server at host, rather than the one the lo‐
47 calhost.
48 -i, --info
50 Report search engine internal metrics.
51 -n, --indom
53 Perform an instance domain related entities search
54 -N N, --number=N
56 Return N, search results at most.
57 -O N, --offset=N
59 Paginated results from given offset.
60 -p port, --port=port
62 Connect to the Redis server at port, rather than the default 6379.
63 -q, --query
65 Perform a general text search (default).
66 -s, --suggest
68 Peform a name suggestion search
69 -S, --score
71 Report score (rank) of each result.
72 -T, --total
74 Report total number of of search results.
75 -t, --times
77 Report elapsed search execution time.
78 -V, --version
80 Display version number and exit.
81 -?, --help
83 Display usage message and exit.
84
86 $ pmsearch kernel idle
87 Type: metric
88 Name: kernel.all.cpu.idle
89 One line: total idle CPU time from /proc/stat for all CPUs
90 Type: metric
92 Name: kernel.all.idletime
93 One line: time the current kernel has been idle since boot
94 Type: metric
96 Name: kernel.percpu.cpu.idle
97 InDom: 60.0
98 One line: percpu idle CPU time metric from /proc/stat
99
101 Environment variables with the prefix PCP_ are used to parameterize the
102 file and directory names used by PCP. On each installation, the file
103 /etc/pcp.conf contains the local values for these variables. The
104 $PCP_CONF variable may be used to specify an alternative configuration
105 file, as described in pcp.conf(5).
106 For environment variables affecting PCP tools, see pmGetOptions(3).
108
110 PCPIntro(1), pmproxy(1), pmlogger(1), pmlogger_daily(1) and redis-serv‐
111 er(1).
112Performance Co-Pilot PCP PMSEARCH(1)