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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
|
# Licensed to Elasticsearch B.V. under one or more contributor
# license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright
# ownership. Elasticsearch B.V. licenses this file to you under
# the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
package Search::Elasticsearch::CxnPool::Static;
$Search::Elasticsearch::CxnPool::Static::VERSION = '8.12';
use Moo;
with 'Search::Elasticsearch::Role::CxnPool::Static',
'Search::Elasticsearch::Role::Is_Sync';
use Search::Elasticsearch::Util qw(throw);
use namespace::clean;
#===================================
sub next_cxn {
#===================================
my ($self) = @_;
my $cxns = $self->cxns;
my $total = @$cxns;
my $now = time();
my @skipped;
while ( $total-- ) {
my $cxn = $cxns->[ $self->next_cxn_num ];
return $cxn if $cxn->is_live;
if ( $cxn->next_ping < $now ) {
return $cxn if $cxn->pings_ok;
}
else {
push @skipped, $cxn;
}
}
for my $cxn (@skipped) {
return $cxn if $cxn->pings_ok;
}
$_->force_ping for @$cxns;
throw( "NoNodes", "No nodes are available: [" . $self->cxns_str . ']' );
}
1;
=pod
=encoding UTF-8
=head1 NAME
Search::Elasticsearch::CxnPool::Static - A CxnPool for connecting to a remote cluster with a static list of nodes.
=head1 VERSION
version 8.12
=head1 SYNOPSIS
$e = Search::Elasticsearch->new(
cxn_pool => 'Static' # default
nodes => [
'search1:9200',
'search2:9200'
],
);
=head1 DESCRIPTION
The L<Static|Search::Elasticsearch::CxnPool::Static> connection pool, which is the
default, should be used when you don't have direct access to the Elasticsearch
cluster, eg when you are accessing the cluster through a proxy. It
round-robins through the nodes that you specified, and pings each node
before it is used for the first time, to ensure that it is responding.
If any node fails, then all nodes are pinged before the next request to
ensure that they are still alive and responding. Failed nodes will be
pinged regularly to check if they have recovered.
This class does L<Search::Elasticsearch::Role::CxnPool::Static> and
L<Search::Elasticsearch::Role::Is_Sync>.
=head1 CONFIGURATION
=head2 C<nodes>
The list of nodes to use to serve requests. Can accept a single node,
multiple nodes, and defaults to C<localhost:9200> if no C<nodes> are
specified. See L<Search::Elasticsearch::Role::Cxn/node> for details of the node
specification.
=head2 See also
=over
=item *
L<Search::Elasticsearch::Role::Cxn/request_timeout>
=item *
L<Search::Elasticsearch::Role::Cxn/ping_timeout>
=item *
L<Search::Elasticsearch::Role::Cxn/dead_timeout>
=item *
L<Search::Elasticsearch::Role::Cxn/max_dead_timeout>
=back
=head2 Inherited configuration
From L<Search::Elasticsearch::Role::CxnPool>
=over
=item * L<randomize_cxns|Search::Elasticsearch::Role::CxnPool/"randomize_cxns">
=back
=head1 METHODS
=head2 C<next_cxn()>
$cxn = $cxn_pool->next_cxn
Returns the next available live node (in round robin fashion), or
throws a C<NoNodes> error if no nodes respond to ping requests.
=head2 Inherited methods
From L<Search::Elasticsearch::Role::CxnPool::Static>
=over
=item * L<schedule_check()|Search::Elasticsearch::Role::CxnPool::Static/"schedule_check()">
=back
From L<Search::Elasticsearch::Role::CxnPool>
=over
=item * L<cxn_factory()|Search::Elasticsearch::Role::CxnPool/"cxn_factory()">
=item * L<logger()|Search::Elasticsearch::Role::CxnPool/"logger()">
=item * L<serializer()|Search::Elasticsearch::Role::CxnPool/"serializer()">
=item * L<current_cxn_num()|Search::Elasticsearch::Role::CxnPool/"current_cxn_num()">
=item * L<cxns()|Search::Elasticsearch::Role::CxnPool/"cxns()">
=item * L<seed_nodes()|Search::Elasticsearch::Role::CxnPool/"seed_nodes()">
=item * L<next_cxn_num()|Search::Elasticsearch::Role::CxnPool/"next_cxn_num()">
=item * L<set_cxns()|Search::Elasticsearch::Role::CxnPool/"set_cxns()">
=item * L<request_ok()|Search::Elasticsearch::Role::CxnPool/"request_ok()">
=item * L<request_failed()|Search::Elasticsearch::Role::CxnPool/"request_failed()">
=item * L<should_retry()|Search::Elasticsearch::Role::CxnPool/"should_retry()">
=item * L<should_mark_dead()|Search::Elasticsearch::Role::CxnPool/"should_mark_dead()">
=item * L<cxns_str()|Search::Elasticsearch::Role::CxnPool/"cxns_str()">
=item * L<cxns_seeds_str()|Search::Elasticsearch::Role::CxnPool/"cxns_seeds_str()">
=item * L<retries()|Search::Elasticsearch::Role::CxnPool/"retries()">
=item * L<reset_retries()|Search::Elasticsearch::Role::CxnPool/"reset_retries()">
=back
=head1 AUTHOR
Enrico Zimuel <enrico.zimuel@elastic.co>
=head1 COPYRIGHT AND LICENSE
This software is Copyright (c) 2024 by Elasticsearch BV.
This is free software, licensed under:
The Apache License, Version 2.0, January 2004
=cut
__END__
# ABSTRACT: A CxnPool for connecting to a remote cluster with a static list of nodes.
|
