1Search::Elasticsearch::UCsleireSnCetoa:nr:tc6rh_i:0b::uE:tlDeaidsrtePicectrs:le:aNDroocdcheu:sm:(eC3nl)tiaetnito:n:6_0::Direct::Nodes(3)
2
6 Search::Elasticsearch::Client::6_0::Direct::Nodes - A client for
7 running node-level requests
8
10 version 6.81
11
13 This module provides methods to make node-level requests, such as
14 retrieving node info and stats.
15 It does Search::Elasticsearch::Role::Client::Direct.
17
19 "info()"
20 $response = $e->nodes->info(
21 node_id => $node_id | \@node_ids # optional
22 metric => $metric | \@metrics # optional
23 );
24 The "info()" method returns static information about the nodes in the
26 cluster, such as the configured maximum number of file handles, the
27 maximum configured heap size or the threadpool settings.
28 Allowed metrics are:
30 "http",
31 "jvm",
32 "network",
33 "os",
34 "plugin",
35 "process",
36 "settings",
37 "thread_pool",
38 "timeout",
39 "transport"
40 Query string parameters:
42 "error_trace",
43 "flat_settings",
44 "human"
45 See the node_info docs
47 <http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-
48 nodes-info.html> for more information.
49 "stats()"
51 $response = $e->nodes->stats(
52 node_id => $node_id | \@node_ids # optional
53 metric => $metric | \@metrics # optional
54 index_metric => $ind_metric | \@ind_metrics # optional
55 );
56 The "stats()" method returns statistics about the nodes in the cluster,
58 such as the number of currently open file handles, the current heap
59 memory usage or the current number of threads in use.
60 Stats can be returned for all nodes, or limited to particular nodes
62 with the "node_id" parameter. By default all metrics are returned, but
63 these can be limited to those specified in the "metric" parameter.
64 Allowed metrics are:
66 "_all",
67 "breaker",
68 "fs",
69 "http",
70 "include_segment_file_sizes",
71 "indices",
72 "jvm",
73 "network",
74 "os",
75 "process",
76 "thread_pool",
77 "timeout",
78 "transport"
79 If the "indices" metric (or "_all") is specified, then indices_stats
81 information is returned on a per-node basis. Which indices stats are
82 returned can be controlled with the "index_metric" parameter:
83 $response = $e->nodes->stats(
85 node_id => 'node_1',
86 metric => ['indices','fs']
87 index_metric => ['docs','fielddata']
88 );
89 Allowed index metrics are:
91 "_all",
92 "completion"
93 "docs",
94 "fielddata",
95 "filter_cache",
96 "flush",
97 "get",
98 "id_cache",
99 "indexing",
100 "merge",
101 "percolate",
102 "query_cache",
103 "refresh",
104 "search",
105 "segments",
106 "store",
107 "warmer"
108 Query string parameters:
110 "completion_fields",
111 "error_trace",
112 "fielddata_fields",
113 "fields",
114 "groups",
115 "human",
116 "level",
117 "types"
118 See the stats docs
120 <http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-
121 nodes-stats.html> for more information.
122 "hot_threads()"
124 $response = $e->nodes->hot_threads(
125 node_id => $node_id | \@node_ids # optional
126 )
127 The "hot_threads()" method is a useful tool for diagnosing busy nodes.
129 It takes a snapshot of which threads are consuming the most CPU.
130 Query string parameters:
132 "error_trace",
133 "human",
134 "ignore_idle_threads",
135 "interval",
136 "snapshots",
137 "threads",
138 "timeout",
139 "type"
140 See the hot_threads docs
142 <http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-
143 nodes-hot-threads.html> for more information.
144 "reload_secure_settings()"
146 $response = $e->nodes->reload_secure_settings(
147 node_id => $node_id | \@node_ids # optional
148 );
149 The "reload_secure_settings()" API will reload the reloadable settings
151 stored in the keystore on each node.
152 Query string parameters:
154 "error_trace",
155 "filter_path",
156 "human",
157 "timeout"
158 See the reload-secure-settings docs
160 <https://www.elastic.co/guide/en/elasticsearch/reference/current/secure-
161 settings.html> for more information.
162 "usage()"
164 $response = $e->nodes->usage(
165 node_id => $node_id | \@node_ids # optional
166 metric => $metric | \@metrics # optional
167 )
168 The "usage()" API retrieve sinformation on the usage of features for
170 each node.
171 Query string parameters:
173 "error_trace",
174 "human",
175 "timeout"
176 See the nodes_usage docs
178 <https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-
179 nodes-usage.html> for more information.
180
182 Enrico Zimuel <enrico.zimuel@elastic.co>
183
185 This software is Copyright (c) 2020 by Elasticsearch BV.
186 This is free software, licensed under:
188 The Apache License, Version 2.0, January 2004
190perl v5.32.0 Search::2E0l2a0s-t0i7c-s2e8arch::Client::6_0::Direct::Nodes(3)