-
Notifications
You must be signed in to change notification settings - Fork 4.9k
/
MicrometerRoutePolicy.java
359 lines (321 loc) · 14.7 KB
/
MicrometerRoutePolicy.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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF 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 org.apache.camel.component.micrometer.routepolicy;
import java.util.HashMap;
import java.util.Map;
import java.util.Optional;
import java.util.concurrent.TimeUnit;
import io.micrometer.core.instrument.Counter;
import io.micrometer.core.instrument.LongTaskTimer;
import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.Tags;
import io.micrometer.core.instrument.Timer;
import org.apache.camel.CamelContext;
import org.apache.camel.Exchange;
import org.apache.camel.NonManagedService;
import org.apache.camel.Route;
import org.apache.camel.RuntimeCamelException;
import org.apache.camel.component.micrometer.MicrometerUtils;
import org.apache.camel.spi.ManagementStrategy;
import org.apache.camel.support.ExchangeHelper;
import org.apache.camel.support.RoutePolicySupport;
import org.apache.camel.support.service.ServiceHelper;
import org.apache.camel.util.ObjectHelper;
import static org.apache.camel.component.micrometer.MicrometerConstants.DEFAULT_CAMEL_ROUTE_POLICY_METER_NAME;
import static org.apache.camel.component.micrometer.MicrometerConstants.KIND;
import static org.apache.camel.component.micrometer.MicrometerConstants.KIND_ROUTE;
import static org.apache.camel.component.micrometer.MicrometerConstants.METRICS_REGISTRY_NAME;
/**
* A {@link org.apache.camel.spi.RoutePolicy} which gathers statistics and reports them using {@link MeterRegistry}.
* <p/>
* The metrics is reported in JMX by default, but this can be configured.
*/
public class MicrometerRoutePolicy extends RoutePolicySupport implements NonManagedService {
private final MicrometerRoutePolicyFactory factory;
private MeterRegistry meterRegistry;
private boolean prettyPrint;
private TimeUnit durationUnit = TimeUnit.MILLISECONDS;
private MicrometerRoutePolicyNamingStrategy namingStrategy = MicrometerRoutePolicyNamingStrategy.DEFAULT;
private MicrometerRoutePolicyConfiguration configuration = MicrometerRoutePolicyConfiguration.DEFAULT;
private final Map<Route, MetricsStatistics> statisticsMap = new HashMap<>();
private RouteMetric contextStatistic;
boolean registerKamelets;
boolean registerTemplates = true;
static class MetricsStatistics implements RouteMetric {
private final MeterRegistry meterRegistry;
private final CamelContext camelContext;
private final Route route;
private final MicrometerRoutePolicyNamingStrategy namingStrategy;
private final MicrometerRoutePolicyConfiguration configuration;
private Counter exchangesSucceeded;
private Counter exchangesFailed;
private Counter exchangesTotal;
private Counter externalRedeliveries;
private Counter failuresHandled;
private Timer timer;
private LongTaskTimer longTaskTimer;
MetricsStatistics(MeterRegistry meterRegistry, CamelContext camelContext, Route route,
MicrometerRoutePolicyNamingStrategy namingStrategy,
MicrometerRoutePolicyConfiguration configuration) {
this.configuration = ObjectHelper.notNull(configuration, "MicrometerRoutePolicyConfiguration", this);
this.meterRegistry = ObjectHelper.notNull(meterRegistry, "MeterRegistry", this);
this.namingStrategy = ObjectHelper.notNull(namingStrategy, "MicrometerRoutePolicyNamingStrategy", this);
this.camelContext = camelContext;
this.route = route;
if (configuration.isAdditionalCounters()) {
initAdditionalCounters();
}
}
private void initAdditionalCounters() {
if (configuration.isExchangesSucceeded()) {
this.exchangesSucceeded = createCounter(namingStrategy.getExchangesSucceededName(route),
"Number of successfully completed exchanges");
}
if (configuration.isExchangesFailed()) {
this.exchangesFailed
= createCounter(namingStrategy.getExchangesFailedName(route), "Number of failed exchanges");
}
if (configuration.isExchangesTotal()) {
this.exchangesTotal
= createCounter(namingStrategy.getExchangesTotalName(route), "Total number of processed exchanges");
}
if (configuration.isExternalRedeliveries()) {
this.externalRedeliveries = createCounter(namingStrategy.getExternalRedeliveriesName(route),
"Number of external initiated redeliveries (such as from JMS broker)");
}
if (configuration.isFailuresHandled()) {
this.failuresHandled
= createCounter(namingStrategy.getFailuresHandledName(route), "Number of failures handled");
}
if (configuration.isLongTask()) {
LongTaskTimer.Builder builder = LongTaskTimer.builder(namingStrategy.getLongTaskName(route))
.tags(route != null ? namingStrategy.getTags(route) : namingStrategy.getTags(camelContext))
.description(route != null ? "Route long task metric" : "CamelContext long task metric");
if (configuration.getLongTaskInitiator() != null) {
configuration.getLongTaskInitiator().accept(builder);
}
longTaskTimer = builder.register(meterRegistry);
}
}
public void onExchangeBegin(Exchange exchange) {
Timer.Sample sample = Timer.start(meterRegistry);
exchange.setProperty(propertyName(exchange), sample);
if (longTaskTimer != null) {
exchange.setProperty(propertyName(exchange) + "_long_task", longTaskTimer.start());
}
}
public void onExchangeDone(Exchange exchange) {
Timer.Sample sample = (Timer.Sample) exchange.removeProperty(propertyName(exchange));
if (sample != null) {
if (timer == null) {
Timer.Builder builder = Timer.builder(namingStrategy.getName(route))
.tags(route != null ? namingStrategy.getTags(route) : namingStrategy.getTags(camelContext))
.description(route != null ? "Route performance metrics" : "CamelContext performance metrics");
if (configuration.getTimerInitiator() != null) {
configuration.getTimerInitiator().accept(builder);
}
timer = builder.register(meterRegistry);
}
sample.stop(timer);
}
LongTaskTimer.Sample ltSampler
= (LongTaskTimer.Sample) exchange.removeProperty(propertyName(exchange) + "_long_task");
if (ltSampler != null) {
ltSampler.stop();
}
if (configuration.isAdditionalCounters()) {
updateAdditionalCounters(exchange);
}
}
public void remove() {
if (exchangesSucceeded != null) {
meterRegistry.remove(exchangesSucceeded);
}
if (exchangesFailed != null) {
meterRegistry.remove(exchangesFailed);
}
if (exchangesTotal != null) {
meterRegistry.remove(exchangesTotal);
}
if (externalRedeliveries != null) {
meterRegistry.remove(externalRedeliveries);
}
if (failuresHandled != null) {
meterRegistry.remove(failuresHandled);
}
if (timer != null) {
meterRegistry.remove(timer);
}
if (longTaskTimer != null) {
meterRegistry.remove(longTaskTimer);
}
}
private void updateAdditionalCounters(Exchange exchange) {
if (exchangesTotal != null) {
exchangesTotal.increment();
}
if (exchange.isFailed()) {
if (exchangesFailed != null) {
exchangesFailed.increment();
}
} else {
if (exchangesSucceeded != null) {
exchangesSucceeded.increment();
}
if (failuresHandled != null && ExchangeHelper.isFailureHandled(exchange)) {
failuresHandled.increment();
}
if (externalRedeliveries != null && exchange.isExternalRedelivered()) {
externalRedeliveries.increment();
}
}
}
private String propertyName(Exchange exchange) {
String id;
if (route != null) {
id = route.getId();
} else {
id = "context:" + camelContext.getName();
}
return String.format("%s-%s-%s", DEFAULT_CAMEL_ROUTE_POLICY_METER_NAME, id, exchange.getExchangeId());
}
private Counter createCounter(String meterName, String description) {
return Counter.builder(meterName)
.tags(route != null
? namingStrategy.getExchangeStatusTags(route) : namingStrategy.getExchangeStatusTags(camelContext))
.description(description)
.register(meterRegistry);
}
}
public MicrometerRoutePolicy() {
this.factory = null;
}
public MicrometerRoutePolicy(MicrometerRoutePolicyFactory factory) {
this.factory = factory;
}
public MeterRegistry getMeterRegistry() {
return meterRegistry;
}
public void setMeterRegistry(MeterRegistry meterRegistry) {
this.meterRegistry = meterRegistry;
}
public boolean isPrettyPrint() {
return prettyPrint;
}
public void setPrettyPrint(boolean prettyPrint) {
this.prettyPrint = prettyPrint;
}
public TimeUnit getDurationUnit() {
return durationUnit;
}
public void setDurationUnit(TimeUnit durationUnit) {
this.durationUnit = durationUnit;
}
public MicrometerRoutePolicyNamingStrategy getNamingStrategy() {
return namingStrategy;
}
public void setNamingStrategy(MicrometerRoutePolicyNamingStrategy namingStrategy) {
this.namingStrategy = namingStrategy;
}
public MicrometerRoutePolicyConfiguration getConfiguration() {
return configuration;
}
public void setConfiguration(MicrometerRoutePolicyConfiguration configuration) {
this.configuration = configuration;
}
@Override
public void onInit(Route route) {
super.onInit(route);
ManagementStrategy ms = route.getCamelContext().getManagementStrategy();
if (ms != null && ms.getManagementAgent() != null) {
registerKamelets = ms.getManagementAgent().getRegisterRoutesCreateByKamelet();
registerTemplates = ms.getManagementAgent().getRegisterRoutesCreateByTemplate();
}
if (getMeterRegistry() == null) {
setMeterRegistry(MicrometerUtils.getOrCreateMeterRegistry(
route.getCamelContext().getRegistry(), METRICS_REGISTRY_NAME));
}
try {
MicrometerRoutePolicyService registryService
= route.getCamelContext().hasService(MicrometerRoutePolicyService.class);
if (registryService == null) {
registryService = new MicrometerRoutePolicyService();
registryService.setMeterRegistry(getMeterRegistry());
registryService.setPrettyPrint(isPrettyPrint());
registryService.setDurationUnit(getDurationUnit());
registryService.setMatchingTags(Tags.of(KIND, KIND_ROUTE));
route.getCamelContext().addService(registryService);
ServiceHelper.startService(registryService);
}
} catch (Exception e) {
throw RuntimeCamelException.wrapRuntimeCamelException(e);
}
if (factory != null && configuration.isContextEnabled() && contextStatistic == null) {
contextStatistic = factory.createOrGetContextMetric(this);
}
}
boolean isRegisterKamelets() {
return registerKamelets;
}
boolean isRegisterTemplates() {
return registerTemplates;
}
@Override
public void onStart(Route route) {
// create statistics holder
// for now we record only all the timings of a complete exchange (responses)
// we have in-flight / total statistics already from camel-core
statisticsMap.computeIfAbsent(route,
it -> {
boolean skip = !configuration.isRouteEnabled();
// skip routes that should not be included
if (!skip) {
skip = (it.isCreatedByKamelet() && !registerKamelets)
|| (it.isCreatedByRouteTemplate() && !registerTemplates);
}
if (skip) {
return null;
}
return new MetricsStatistics(
getMeterRegistry(), it.getCamelContext(), it, getNamingStrategy(), configuration);
});
}
@Override
public void onRemove(Route route) {
// route is removed, so remove metrics from micrometer
MetricsStatistics stats = statisticsMap.remove(route);
if (stats != null) {
stats.remove();
}
}
@Override
public void onExchangeBegin(Route route, Exchange exchange) {
if (contextStatistic != null) {
contextStatistic.onExchangeBegin(exchange);
}
Optional.ofNullable(statisticsMap.get(route))
.ifPresent(statistics -> statistics.onExchangeBegin(exchange));
}
@Override
public void onExchangeDone(Route route, Exchange exchange) {
if (contextStatistic != null) {
contextStatistic.onExchangeDone(exchange);
}
Optional.ofNullable(statisticsMap.get(route))
.ifPresent(statistics -> statistics.onExchangeDone(exchange));
}
}