|
1 | 1 | package org.mockserver.metrics; |
2 | 2 |
|
| 3 | +import io.prometheus.client.Gauge; |
3 | 4 | import org.mockserver.configuration.Configuration; |
| 5 | +import org.mockserver.log.model.LogEntry; |
| 6 | +import org.mockserver.logging.MockServerLogger; |
4 | 7 | import org.mockserver.model.Action; |
5 | 8 |
|
| 9 | +import java.util.Arrays; |
6 | 10 | import java.util.Map; |
7 | 11 | import java.util.concurrent.ConcurrentHashMap; |
| 12 | +import java.util.concurrent.atomic.AtomicReference; |
| 13 | + |
| 14 | +import static org.mockserver.log.model.LogEntry.LogMessageType.EXCEPTION; |
8 | 15 |
|
9 | 16 | /** |
10 | 17 | * @author jamesdbloom |
11 | 18 | */ |
12 | 19 | @SuppressWarnings({"SynchronizationOnLocalVariableOrMethodParameter", "FieldMayBeFinal"}) |
13 | 20 | public class Metrics { |
14 | 21 |
|
15 | | - private static Map<Name, Integer> metrics = new ConcurrentHashMap<>(); |
16 | | - private final Configuration configuration; |
| 22 | + private static final AtomicReference<Boolean> additionalMetricsRegistered = new AtomicReference<>(false); |
| 23 | + private static final Map<Name, Gauge> metrics = new ConcurrentHashMap<>(); |
| 24 | + |
| 25 | + private final Boolean metricsEnabled; |
17 | 26 |
|
18 | 27 | public Metrics(Configuration configuration) { |
19 | | - this.configuration = configuration; |
| 28 | + metricsEnabled = configuration.metricsEnabled(); |
| 29 | + if (metricsEnabled && additionalMetricsRegistered.compareAndSet(false, true)) { |
| 30 | + new BuildInfoCollector().register(); |
| 31 | + Arrays.stream(Name.values()).forEach(Metrics::getOrCreate); |
| 32 | + } |
| 33 | + } |
| 34 | + |
| 35 | + private static Gauge getOrCreate(Name name) { |
| 36 | + synchronized (name) { |
| 37 | + Gauge gauge = metrics.get(name); |
| 38 | + if (gauge == null) { |
| 39 | + try { |
| 40 | + gauge = Gauge.build() |
| 41 | + .name(name.name().toLowerCase()) |
| 42 | + .help(name.description) |
| 43 | + .register(); |
| 44 | + metrics.put(name, gauge); |
| 45 | + } catch (Throwable throwable) { |
| 46 | + new MockServerLogger().logEvent( |
| 47 | + new LogEntry() |
| 48 | + .setType(EXCEPTION) |
| 49 | + .setMessageFormat("exception:{} creating metric:{}") |
| 50 | + .setArguments(throwable.getMessage(), name.name()) |
| 51 | + .setThrowable(throwable) |
| 52 | + ); |
| 53 | + } |
| 54 | + } |
| 55 | + return gauge; |
| 56 | + } |
20 | 57 | } |
21 | 58 |
|
22 | 59 | public static void clear() { |
23 | | - metrics.clear(); |
| 60 | + metrics.forEach((name, gauge) -> gauge.set(0)); |
| 61 | + } |
| 62 | + |
| 63 | + public static void clear(Name name) { |
| 64 | + getOrCreate(name).set(0); |
24 | 65 | } |
25 | 66 |
|
26 | 67 | public void set(Name name, Integer value) { |
27 | | - metrics.put(name, value); |
| 68 | + if (metricsEnabled) { |
| 69 | + getOrCreate(name).set(value); |
| 70 | + } |
28 | 71 | } |
29 | 72 |
|
30 | 73 | public static Integer get(Name name) { |
31 | | - Integer value = metrics.get(name); |
32 | | - return value != null ? value : 0; |
| 74 | + return (int) getOrCreate(name).get(); |
33 | 75 | } |
34 | 76 |
|
35 | 77 | public void increment(Name name) { |
36 | | - if (configuration.metricsEnabled()) { |
37 | | - synchronized (name) { |
38 | | - metrics.merge(name, 1, Integer::sum); |
39 | | - } |
| 78 | + if (metricsEnabled) { |
| 79 | + getOrCreate(name).inc(); |
40 | 80 | } |
41 | 81 | } |
42 | 82 |
|
43 | | - public void decrement(Name name) { |
44 | | - if (configuration.metricsEnabled()) { |
45 | | - synchronized (name) { |
46 | | - final Integer currentValue = metrics.get(name); |
47 | | - if (currentValue != null) { |
48 | | - metrics.put(name, currentValue - 1); |
49 | | - } else { |
50 | | - throw new IllegalArgumentException("Can not decrement metric \"" + name + "\" because it not exist"); |
51 | | - } |
52 | | - } |
| 83 | + public void increment(Action.Type type) { |
| 84 | + if (metricsEnabled) { |
| 85 | + increment(Name.valueOf(type.name() + "_ACTIONS_COUNT")); |
53 | 86 | } |
54 | 87 | } |
55 | 88 |
|
56 | | - public void increment(Action.Type type) { |
57 | | - if (configuration.metricsEnabled()) { |
58 | | - Name name = Name.valueOf("ACTION_" + type.name() + "_COUNT"); |
59 | | - synchronized (name) { |
60 | | - metrics.merge(name, 1, Integer::sum); |
61 | | - } |
| 89 | + public void decrement(Name name) { |
| 90 | + if (metricsEnabled) { |
| 91 | + getOrCreate(name).dec(); |
62 | 92 | } |
63 | 93 | } |
64 | 94 |
|
65 | 95 | public void decrement(Action.Type type) { |
66 | | - if (configuration.metricsEnabled()) { |
67 | | - Name name = Name.valueOf("ACTION_" + type.name() + "_COUNT"); |
68 | | - synchronized (name) { |
69 | | - final Integer currentValue = metrics.get(name); |
70 | | - if (currentValue != null) { |
71 | | - metrics.put(name, currentValue - 1); |
72 | | - } else { |
73 | | - throw new IllegalArgumentException("Can not decrement metric \"" + name + "\" because it not exist"); |
74 | | - } |
75 | | - } |
| 96 | + if (metricsEnabled) { |
| 97 | + decrement(Name.valueOf(type.name() + "_ACTIONS_COUNT")); |
76 | 98 | } |
77 | 99 | } |
78 | 100 |
|
| 101 | + public static void clearRequestAndExpectationMetrics() { |
| 102 | + clear(Name.REQUESTS_RECEIVED_COUNT); |
| 103 | + clear(Name.EXPECTATIONS_NOT_MATCHED_COUNT); |
| 104 | + clear(Name.RESPONSE_EXPECTATIONS_MATCHED_COUNT); |
| 105 | + } |
| 106 | + |
79 | 107 | public static void clearActionMetrics() { |
80 | | - metrics.remove(Name.ACTION_FORWARD_COUNT); |
81 | | - metrics.remove(Name.ACTION_FORWARD_TEMPLATE_COUNT); |
82 | | - metrics.remove(Name.ACTION_FORWARD_CLASS_CALLBACK_COUNT); |
83 | | - metrics.remove(Name.ACTION_FORWARD_OBJECT_CALLBACK_COUNT); |
84 | | - metrics.remove(Name.ACTION_FORWARD_REPLACE_COUNT); |
85 | | - metrics.remove(Name.ACTION_RESPONSE_COUNT); |
86 | | - metrics.remove(Name.ACTION_RESPONSE_TEMPLATE_COUNT); |
87 | | - metrics.remove(Name.ACTION_RESPONSE_CLASS_CALLBACK_COUNT); |
88 | | - metrics.remove(Name.ACTION_RESPONSE_OBJECT_CALLBACK_COUNT); |
89 | | - metrics.remove(Name.ACTION_ERROR_COUNT); |
| 108 | + clear(Name.FORWARD_ACTIONS_COUNT); |
| 109 | + clear(Name.FORWARD_TEMPLATE_ACTIONS_COUNT); |
| 110 | + clear(Name.FORWARD_CLASS_CALLBACK_ACTIONS_COUNT); |
| 111 | + clear(Name.FORWARD_OBJECT_CALLBACK_ACTIONS_COUNT); |
| 112 | + clear(Name.FORWARD_REPLACE_ACTIONS_COUNT); |
| 113 | + clear(Name.RESPONSE_ACTIONS_COUNT); |
| 114 | + clear(Name.RESPONSE_TEMPLATE_ACTIONS_COUNT); |
| 115 | + clear(Name.RESPONSE_CLASS_CALLBACK_ACTIONS_COUNT); |
| 116 | + clear(Name.RESPONSE_OBJECT_CALLBACK_ACTIONS_COUNT); |
| 117 | + clear(Name.ERROR_ACTIONS_COUNT); |
90 | 118 | } |
91 | 119 |
|
92 | 120 | public static void clearWebSocketMetrics() { |
93 | | - metrics.remove(Name.WEBSOCKET_CALLBACK_CLIENT_COUNT); |
94 | | - metrics.remove(Name.WEBSOCKET_CALLBACK_RESPONSE_HANDLER_COUNT); |
95 | | - metrics.remove(Name.WEBSOCKET_CALLBACK_FORWARD_HANDLER_COUNT); |
| 121 | + clear(Name.WEBSOCKET_CALLBACK_CLIENTS_COUNT); |
| 122 | + clear(Name.WEBSOCKET_CALLBACK_RESPONSE_HANDLERS_COUNT); |
| 123 | + clear(Name.WEBSOCKET_CALLBACK_FORWARD_HANDLERS_COUNT); |
96 | 124 | } |
97 | 125 |
|
98 | 126 | public enum Name { |
99 | | - EXPECTATION_NOT_MATCHED_COUNT, |
100 | | - RESPONSE_EXPECTATION_MATCHED_COUNT, |
101 | | - FORWARD_EXPECTATION_MATCHED_COUNT, |
102 | | - ACTION_FORWARD_COUNT, |
103 | | - ACTION_FORWARD_TEMPLATE_COUNT, |
104 | | - ACTION_FORWARD_CLASS_CALLBACK_COUNT, |
105 | | - ACTION_FORWARD_OBJECT_CALLBACK_COUNT, |
106 | | - ACTION_FORWARD_REPLACE_COUNT, |
107 | | - ACTION_RESPONSE_COUNT, |
108 | | - ACTION_RESPONSE_TEMPLATE_COUNT, |
109 | | - ACTION_RESPONSE_CLASS_CALLBACK_COUNT, |
110 | | - ACTION_RESPONSE_OBJECT_CALLBACK_COUNT, |
111 | | - ACTION_ERROR_COUNT, |
112 | | - WEBSOCKET_CALLBACK_CLIENT_COUNT, |
113 | | - WEBSOCKET_CALLBACK_RESPONSE_HANDLER_COUNT, |
114 | | - WEBSOCKET_CALLBACK_FORWARD_HANDLER_COUNT |
| 127 | + REQUESTS_RECEIVED_COUNT("Expectation not matched count"), |
| 128 | + EXPECTATIONS_NOT_MATCHED_COUNT("Expectation not matched count"), |
| 129 | + RESPONSE_EXPECTATIONS_MATCHED_COUNT("Response expectation matched count"), |
| 130 | + FORWARD_EXPECTATIONS_MATCHED_COUNT("Forward expectation matched count"), |
| 131 | + FORWARD_ACTIONS_COUNT("Action forward count"), |
| 132 | + FORWARD_TEMPLATE_ACTIONS_COUNT("Action forward template count"), |
| 133 | + FORWARD_CLASS_CALLBACK_ACTIONS_COUNT("Action forward class callback count"), |
| 134 | + FORWARD_OBJECT_CALLBACK_ACTIONS_COUNT("Action forward object callback count"), |
| 135 | + FORWARD_REPLACE_ACTIONS_COUNT("Action forward replace count"), |
| 136 | + RESPONSE_ACTIONS_COUNT("Action response count"), |
| 137 | + RESPONSE_TEMPLATE_ACTIONS_COUNT("Action response template count"), |
| 138 | + RESPONSE_CLASS_CALLBACK_ACTIONS_COUNT("Action response class callback count"), |
| 139 | + RESPONSE_OBJECT_CALLBACK_ACTIONS_COUNT("Action response object callback count"), |
| 140 | + ERROR_ACTIONS_COUNT("Action error count"), |
| 141 | + WEBSOCKET_CALLBACK_CLIENTS_COUNT("Websocket callback client count"), |
| 142 | + WEBSOCKET_CALLBACK_RESPONSE_HANDLERS_COUNT("Websocket callback response handler count"), |
| 143 | + WEBSOCKET_CALLBACK_FORWARD_HANDLERS_COUNT("Websocket callback forward handler count"); |
| 144 | + |
| 145 | + public final String description; |
| 146 | + |
| 147 | + Name(String description) { |
| 148 | + this.description = description; |
| 149 | + } |
115 | 150 | } |
116 | 151 | } |
0 commit comments