1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
|
package Search::Elasticsearch::Client::2_0::Direct::Nodes;
$Search::Elasticsearch::Client::2_0::Direct::Nodes::VERSION = '6.81';
use Moo;
with 'Search::Elasticsearch::Client::2_0::Role::API';
with 'Search::Elasticsearch::Role::Client::Direct';
__PACKAGE__->_install_api('nodes');
1;
=pod
=encoding UTF-8
=head1 NAME
Search::Elasticsearch::Client::2_0::Direct::Nodes - A client for running node-level requests
=head1 VERSION
version 6.81
=head1 DESCRIPTION
This module provides methods to make node-level requests, such as
retrieving node info and stats.
It does L<Search::Elasticsearch::Role::Client::Direct>.
=head1 METHODS
=head2 C<info()>
$response = $e->nodes->info(
node_id => $node_id | \@node_ids # optional
metric => $metric | \@metrics # optional
);
The C<info()> method returns static information about the nodes in the
cluster, such as the configured maximum number of file handles, the maximum
configured heap size or the threadpool settings.
Allowed metrics are:
C<http>,
C<jvm>,
C<network>,
C<os>,
C<plugin>,
C<process>,
C<settings>,
C<thread_pool>,
C<timeout>,
C<transport>
Query string parameters:
C<flat_settings>,
C<human>
See the L<node_info docs|http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-info.html>
for more information.
=head2 C<stats()>
$response = $e->nodes->stats(
node_id => $node_id | \@node_ids # optional
metric => $metric | \@metrics # optional
index_metric => $ind_metric | \@ind_metrics # optional
);
The C<stats()> method returns statistics about the nodes in the
cluster, such as the number of currently open file handles, the current
heap memory usage or the current number of threads in use.
Stats can be returned for all nodes, or limited to particular nodes
with the C<node_id> parameter. By default all metrics are returned, but
these can be limited to those specified in the C<metric> parameter.
Allowed metrics are:
C<_all>,
C<breaker>,
C<fs>,
C<http>,
C<indices>,
C<jvm>,
C<network>,
C<os>,
C<process>,
C<thread_pool>,
C<timeout>,
C<transport>
If the C<indices> metric (or C<_all>) is specified, then
L<indices_stats|Search::Elasticsearch::Client::2_0::Direct::Indices/indices_stats()>
information is returned on a per-node basis. Which indices stats are
returned can be controlled with the C<index_metric> parameter:
$response = $e->cluster->node_stats(
node_id => 'node_1',
metric => ['indices','fs']
index_metric => ['docs','fielddata']
);
Allowed index metrics are:
C<_all>,
C<completion>
C<docs>,
C<fielddata>,
C<filter_cache>,
C<flush>,
C<get>,
C<id_cache>,
C<indexing>,
C<merge>,
C<percolate>,
C<query_cache>,
C<refresh>,
C<search>,
C<segments>,
C<store>,
C<warmer>
Query string parameters:
C<completion_fields>,
C<fielddata_fields>,
C<fields>,
C<groups>,
C<human>,
C<level>,
C<types>
See the L<node_stats docs|http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-stats.html>
for more information.
=head2 C<hot_threads()>
$response = $e->nodes->hot_threads(
node_id => $node_id | \@node_ids # optional
)
The C<hot_threads()> method is a useful tool for diagnosing busy nodes. It
takes a snapshot of which threads are consuming the most CPU.
Query string parameters:
C<ignore_idle_threads>,
C<interval>,
C<snapshots>,
C<threads>,
C<timeout>,
C<type>
See the L<hot_threads docs|http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-hot-threads.html>
for more information.
=head1 AUTHOR
Enrico Zimuel <enrico.zimuel@elastic.co>
=head1 COPYRIGHT AND LICENSE
This software is Copyright (c) 2020 by Elasticsearch BV.
This is free software, licensed under:
The Apache License, Version 2.0, January 2004
=cut
__END__
# ABSTRACT: A client for running node-level requests
|
