-
Notifications
You must be signed in to change notification settings - Fork 214
/
RetrieveConnectionStatusAggregatorActor.java
292 lines (261 loc) · 13.2 KB
/
RetrieveConnectionStatusAggregatorActor.java
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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
/*
* Copyright (c) 2017 Contributors to the Eclipse Foundation
*
* See the NOTICE file(s) distributed with this work for additional
* information regarding copyright ownership.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.eclipse.ditto.connectivity.service.messaging.monitoring.metrics;
import java.time.Duration;
import java.time.Instant;
import java.util.Arrays;
import java.util.Collections;
import java.util.EnumMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.stream.Collectors;
import org.eclipse.ditto.base.model.headers.DittoHeaders;
import org.eclipse.ditto.connectivity.model.Connection;
import org.eclipse.ditto.connectivity.model.ConnectionType;
import org.eclipse.ditto.connectivity.model.ConnectivityStatus;
import org.eclipse.ditto.connectivity.model.RecoveryStatus;
import org.eclipse.ditto.connectivity.model.ResourceStatus;
import org.eclipse.ditto.connectivity.model.SshTunnel;
import org.eclipse.ditto.connectivity.model.signals.commands.query.RetrieveConnectionStatusResponse;
import org.eclipse.ditto.internal.utils.pekko.logging.DittoLoggerFactory;
import org.apache.pekko.actor.AbstractActor;
import org.apache.pekko.actor.ActorRef;
import org.apache.pekko.actor.Props;
import org.apache.pekko.actor.ReceiveTimeout;
import org.apache.pekko.event.DiagnosticLoggingAdapter;
/**
* An aggregation actor which receives {@link ResourceStatus} messages from all {@code clients, targets and sources}
* and aggregates them into a single {@link RetrieveConnectionStatusResponse} message it sends back to a passed in
* {@code sender}.
*/
public final class RetrieveConnectionStatusAggregatorActor extends AbstractActor {
private final DiagnosticLoggingAdapter log = DittoLoggerFactory.getDiagnosticLoggingAdapter(this);
private final Duration timeout;
private final long availableConnectivityInstances;
private final Map<ResourceStatus.ResourceType, Integer> expectedResponses;
private final ActorRef sender;
private final int configuredClientCount;
private final RetrieveConnectionStatusResponse.Builder responseBuilder;
@SuppressWarnings("unused")
private RetrieveConnectionStatusAggregatorActor(final Connection connection,
final ActorRef sender,
final DittoHeaders originalHeaders,
final Duration timeout,
final long availableConnectivityInstances) {
this.timeout = timeout;
this.availableConnectivityInstances = availableConnectivityInstances;
this.sender = sender;
responseBuilder = RetrieveConnectionStatusResponse.getBuilder(connection.getId(), originalHeaders)
.connectionStatus(connection.getConnectionStatus())
.liveStatus(ConnectivityStatus.UNKNOWN)
.recoveryStatus(RecoveryStatus.UNKNOWN)
.connectedSince(Instant.EPOCH)
.clientStatus(Collections.emptyList())
.sourceStatus(Collections.emptyList())
.targetStatus(Collections.emptyList())
.sshTunnelStatus(Collections.emptyList());
expectedResponses = new EnumMap<>(ResourceStatus.ResourceType.class);
configuredClientCount = connection.getClientCount();
// one response per client actor
expectedResponses.put(ResourceStatus.ResourceType.CLIENT, configuredClientCount);
if (ConnectivityStatus.OPEN.equals(connection.getConnectionStatus())) {
// one response per source/target
expectedResponses.put(ResourceStatus.ResourceType.TARGET,
connection.getTargets()
.stream()
.mapToInt(target -> configuredClientCount)
.sum());
expectedResponses.put(ResourceStatus.ResourceType.SOURCE, determineSourceCount(connection));
if (connection.getSshTunnel().map(SshTunnel::isEnabled).orElse(false)) {
expectedResponses.put(ResourceStatus.ResourceType.SSH_TUNNEL, configuredClientCount);
}
}
}
/**
* Creates Akka configuration object for this actor.
*
* @param connection the {@code Connection} for which to aggregate the status for.
* @param sender the ActorRef of the sender to which to answer the response to.
* @param originalHeaders the DittoHeaders to use for the response message.
* @param timeout the timeout to apply in order to receive the response.
* @param availableConnectivityInstances the currently available connectivity service instances in the cluster.
* @return the Akka configuration Props object
*/
public static Props props(final Connection connection, final ActorRef sender, final DittoHeaders originalHeaders,
final Duration timeout, final long availableConnectivityInstances) {
return Props.create(RetrieveConnectionStatusAggregatorActor.class, connection, sender, originalHeaders,
timeout, availableConnectivityInstances);
}
@Override
public Receive createReceive() {
return receiveBuilder()
.match(ResourceStatus.class, this::handleResourceStatus)
.match(ReceiveTimeout.class, receiveTimeout -> this.handleReceiveTimeout())
.matchAny(any -> log.info("Cannot handle {}", any.getClass())).build();
}
private void handleReceiveTimeout() {
final Map<ResourceStatus.ResourceType, Integer> missingResources = expectedResponses.entrySet().stream()
.filter(entry -> entry.getValue() > 0)
.collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));
log.warning("RetrieveConnectionStatus timed out, sending (partial) response with missing resources: <{}>",
missingResources);
responseBuilder.withMissingResources(missingResources, configuredClientCount,
availableConnectivityInstances >= configuredClientCount);
sendResponse();
stopSelf();
}
@Override
public void preStart() {
getContext().setReceiveTimeout(timeout);
}
private void handleResourceStatus(final ResourceStatus resourceStatus) {
expectedResponses.compute(resourceStatus.getResourceType(), (type, count) -> count == null ? 0 : count - 1);
log.debug("Received resource status from {}: {}", getSender(), resourceStatus);
// aggregate status...
responseBuilder.withAddressStatus(resourceStatus);
// if response is complete, send back to caller
if (getRemainingResponses() == 0) {
sendResponse();
}
}
private int getRemainingResponses() {
return expectedResponses.values().stream()
.mapToInt(i -> i)
.sum();
}
private void sendResponse() {
final RetrieveConnectionStatusResponse tmpResponse = responseBuilder.build();
final List<ResourceStatus> clientStatus = tmpResponse.getClientStatus();
final ConnectivityStatus liveClientStatus = determineLiveStatus(clientStatus);
final RecoveryStatus recoveryStatus = determineRecoveryStatus(clientStatus);
final ConnectivityStatus liveSourceStatus = determineLiveStatus(tmpResponse.getSourceStatus());
final ConnectivityStatus liveTargetStatus = determineLiveStatus(tmpResponse.getTargetStatus());
final ConnectivityStatus liveSshTunnelStatus = determineLiveStatus(tmpResponse.getSshTunnelStatus());
final Optional<Instant> earliestConnectedSince = clientStatus.stream()
.filter(rs -> ConnectivityStatus.OPEN.equals(rs.getStatus()))
.map(ResourceStatus::getInStateSince)
.filter(Optional::isPresent)
.map(Optional::get)
.min(Instant::compareTo);
final ConnectivityStatus liveStatus = calculateOverallLiveStatus(liveClientStatus, liveSourceStatus,
liveTargetStatus, liveSshTunnelStatus);
responseBuilder
.connectedSince(earliestConnectedSince.orElse(null))
.liveStatus(liveStatus)
.recoveryStatus(recoveryStatus);
sender.tell(responseBuilder.build(), getSelf());
stopSelf();
}
private static RecoveryStatus determineRecoveryStatus(final List<ResourceStatus> resourceStatus) {
final boolean allSucceeded = resourceStatus.stream()
.map(ResourceStatus::getRecoveryStatus)
.flatMap(Optional::stream)
.allMatch(RecoveryStatus.SUCCEEDED::equals);
final boolean anyBackoff = resourceStatus.stream()
.map(ResourceStatus::getRecoveryStatus)
.flatMap(Optional::stream)
.anyMatch(RecoveryStatus.BACK_OFF_LIMIT_REACHED::equals);
final boolean anyOngoing = resourceStatus.stream()
.map(ResourceStatus::getRecoveryStatus)
.flatMap(Optional::stream)
.anyMatch(RecoveryStatus.ONGOING::equals);
final RecoveryStatus recoveryStatus;
if (allSucceeded) {
recoveryStatus = RecoveryStatus.SUCCEEDED;
} else if (anyBackoff) {
recoveryStatus = RecoveryStatus.BACK_OFF_LIMIT_REACHED;
} else if (anyOngoing) {
recoveryStatus = RecoveryStatus.ONGOING;
} else {
recoveryStatus = RecoveryStatus.UNKNOWN;
}
return recoveryStatus;
}
private static ConnectivityStatus determineLiveStatus(final List<ResourceStatus> resourceStatus) {
final boolean allOpen = resourceStatus.stream()
.map(ResourceStatus::getStatus)
.allMatch(ConnectivityStatus.OPEN::equals);
final boolean anyFailed = resourceStatus.stream()
.map(ResourceStatus::getStatus)
.anyMatch(ConnectivityStatus.FAILED::equals);
final boolean anyMisconfigured = resourceStatus.stream()
.map(ResourceStatus::getStatus)
.anyMatch(ConnectivityStatus.MISCONFIGURED::equals);
final boolean anyUnknown = resourceStatus.stream()
.map(ResourceStatus::getStatus)
.anyMatch(ConnectivityStatus.UNKNOWN::equals);
final boolean allClosed = resourceStatus.stream()
.map(ResourceStatus::getStatus)
.allMatch(ConnectivityStatus.CLOSED::equals);
final ConnectivityStatus liveStatus;
if (allOpen) {
liveStatus = ConnectivityStatus.OPEN;
} else if (anyFailed) {
// hypothesis: even if any status is "misconfigured", the "failed" is stronger as the internal error
// outweighs the misconfiguration
liveStatus = ConnectivityStatus.FAILED;
} else if (anyMisconfigured) {
liveStatus = ConnectivityStatus.MISCONFIGURED;
} else if (allClosed) {
liveStatus = ConnectivityStatus.CLOSED;
} else if (anyUnknown) {
final boolean allClientsOpen = resourceStatus.stream()
.filter(p -> p.getResourceType() == ResourceStatus.ResourceType.CLIENT)
.map(ResourceStatus::getStatus)
.allMatch(ConnectivityStatus.OPEN::equals);
liveStatus = allClientsOpen ? ConnectivityStatus.OPEN : ConnectivityStatus.UNKNOWN;
} else {
liveStatus = ConnectivityStatus.UNKNOWN;
}
return liveStatus;
}
private static ConnectivityStatus calculateOverallLiveStatus(final ConnectivityStatus... liveStatuses) {
final List<ConnectivityStatus> allStatuses = Arrays.asList(liveStatuses);
if (allStatuses.stream().allMatch(ConnectivityStatus.OPEN::equals)) {
return ConnectivityStatus.OPEN;
}
if (allStatuses.contains(ConnectivityStatus.FAILED)) {
// hypothesis: even if other statuses are "misconfigured", the "failed" is stronger as the internal error
// outweighs the misconfiguration
return ConnectivityStatus.FAILED;
}
if (allStatuses.contains(ConnectivityStatus.MISCONFIGURED)) {
return ConnectivityStatus.MISCONFIGURED;
}
if (allStatuses.stream().allMatch(ConnectivityStatus.CLOSED::equals)) {
return ConnectivityStatus.CLOSED;
}
return ConnectivityStatus.UNKNOWN;
}
private void stopSelf() {
getContext().cancelReceiveTimeout();
getContext().stop(getSelf());
}
private int determineSourceCount(final Connection connection) {
final int sourceCount;
if(connection.getConnectionType().equals(ConnectionType.MQTT)) {
// for mqtt only one consumer actor for all addresses of a source is started.
sourceCount = connection.getSources()
.stream()
.mapToInt(source -> configuredClientCount * source.getConsumerCount())
.sum();
} else {
sourceCount = connection.getSources()
.stream()
.mapToInt(source -> configuredClientCount * source.getConsumerCount() * source.getAddresses().size())
.sum();
}
return sourceCount;
}
}