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
|
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.model.admin.metricsproxy;
import ai.vespa.metrics.set.Metric;
import ai.vespa.metrics.set.MetricSet;
import ai.vespa.metricsproxy.core.ConsumersConfig;
import com.yahoo.vespa.model.VespaModel;
import com.yahoo.vespa.model.admin.monitoring.MetricsConsumer;
import org.junit.jupiter.api.Test;
import static ai.vespa.metrics.set.DefaultMetrics.defaultMetricSet;
import static ai.vespa.metrics.set.DefaultVespaMetrics.defaultVespaMetricSet;
import static ai.vespa.metrics.set.NetworkMetrics.networkMetricSet;
import static ai.vespa.metrics.set.SystemMetrics.systemMetricSet;
import static ai.vespa.metrics.set.VespaMetricSet.vespaMetricSet;
import static com.yahoo.vespa.model.admin.metricsproxy.MetricsProxyModelTester.TestMode.hosted;
import static com.yahoo.vespa.model.admin.metricsproxy.MetricsProxyModelTester.TestMode.self_hosted;
import static com.yahoo.vespa.model.admin.metricsproxy.MetricsProxyModelTester.checkMetric;
import static com.yahoo.vespa.model.admin.metricsproxy.MetricsProxyModelTester.consumersConfigFromModel;
import static com.yahoo.vespa.model.admin.metricsproxy.MetricsProxyModelTester.consumersConfigFromXml;
import static com.yahoo.vespa.model.admin.metricsproxy.MetricsProxyModelTester.getCustomConsumer;
import static com.yahoo.vespa.model.admin.metricsproxy.MetricsProxyModelTester.getModel;
import static com.yahoo.vespa.model.admin.metricsproxy.MetricsProxyModelTester.servicesWithAdminOnly;
import static java.util.Collections.singleton;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.junit.jupiter.api.Assertions.fail;
/**
* Tests for {@link MetricsProxyContainerCluster} related to metrics consumers.
*
* @author gjoranv
*/
public class MetricsConsumersTest {
private static final int numPublicDefaultMetrics = defaultMetricSet.getMetrics().size();
private static final int numDefaultVespaMetrics = defaultVespaMetricSet.getMetrics().size();
private static final int numVespaMetrics = vespaMetricSet.getMetrics().size();
private static final int numSystemMetrics = systemMetricSet.getMetrics().size();
private static final int numNetworkMetrics = networkMetricSet.getMetrics().size();
private static final int numMetricsForVespaConsumer = numVespaMetrics + numSystemMetrics + numNetworkMetrics;
@Test
void default_public_consumers_is_set_up_for_self_hosted() {
ConsumersConfig config = consumersConfigFromXml(servicesWithAdminOnly(), self_hosted);
assertEquals(4, config.consumer().size());
assertEquals(MetricsConsumer.defaultConsumer.id(), config.consumer(2).name());
int numMetricsForPublicDefaultConsumer = defaultMetricSet.getMetrics().size() + numSystemMetrics;
assertEquals(numMetricsForPublicDefaultConsumer, config.consumer(2).metric().size());
}
@Test
void consumers_are_set_up_for_hosted() {
ConsumersConfig config = consumersConfigFromXml(servicesWithAdminOnly(), hosted);
assertEquals(5, config.consumer().size());
assertEquals(MetricsConsumer.vespa.id(), config.consumer(0).name());
assertEquals(MetricsConsumer.autoscaling.id(), config.consumer(1).name());
assertEquals(MetricsConsumer.defaultConsumer.id(), config.consumer(2).name());
assertEquals(MetricsProxyContainerCluster.NEW_DEFAULT_CONSUMER_ID, config.consumer(3).name());
assertEquals(MetricsConsumer.vespa9.id(), config.consumer(4).name());
}
@Test
void vespa_consumer_is_always_present_and_has_all_vespa_metrics_and_all_system_metrics() {
ConsumersConfig config = consumersConfigFromXml(servicesWithAdminOnly(), self_hosted);
assertEquals(MetricsConsumer.vespa.id(), config.consumer(0).name());
assertEquals(numMetricsForVespaConsumer, config.consumer(0).metric().size());
}
@Test
void vespa_consumer_can_be_amended_via_admin_object() {
VespaModel model = getModel(servicesWithAdminOnly(), self_hosted);
var additionalMetric = new Metric("additional-metric");
model.getAdmin().setAdditionalDefaultMetrics(new MetricSet("amender-metrics", singleton(additionalMetric)));
ConsumersConfig config = consumersConfigFromModel(model);
assertEquals(numMetricsForVespaConsumer + 1, config.consumer(0).metric().size());
ConsumersConfig.Consumer vespaConsumer = config.consumer(0);
assertTrue(checkMetric(vespaConsumer, additionalMetric), "Did not contain additional metric");
}
@Test
void vespa_is_a_reserved_consumer_id() {
assertReservedConsumerId("Vespa");
}
@Test
void default_is_a_reserved_consumer_id() {
assertReservedConsumerId("default");
}
private void assertReservedConsumerId(String consumerId) {
String services = String.join("\n",
"<services>",
" <admin version='2.0'>",
" <adminserver hostalias='node1'/>",
" <metrics>",
" <consumer id='" + consumerId + "'/>",
" </metrics>",
" </admin>",
"</services>"
);
try {
consumersConfigFromXml(services, self_hosted);
fail();
} catch (IllegalArgumentException e) {
assertEquals("'" + consumerId + "' is not allowed as metrics consumer id (case is ignored.)", e.getMessage());
}
}
@Test
void vespa_consumer_id_is_allowed_for_hosted_infrastructure_applications() {
String services = String.join("\n",
"<services application-type='hosted-infrastructure'>",
" <admin version='4.0'>",
" <adminserver hostalias='node1'/>",
" <metrics>",
" <consumer id='Vespa'>",
" <metric id='custom.metric1'/>",
" </consumer>",
" </metrics>",
" </admin>",
"</services>"
);
VespaModel hostedModel = getModel(services, hosted);
ConsumersConfig config = consumersConfigFromModel(hostedModel);
assertEquals(5, config.consumer().size());
// All default metrics are retained
ConsumersConfig.Consumer vespaConsumer = config.consumer(0);
assertEquals(numMetricsForVespaConsumer + 1, vespaConsumer.metric().size());
Metric customMetric1 = new Metric("custom.metric1");
assertTrue(checkMetric(vespaConsumer, customMetric1), "Did not contain metric: " + customMetric1);
}
@Test
void consumer_id_is_case_insensitive() {
String services = String.join("\n",
"<services>",
" <admin version='2.0'>",
" <adminserver hostalias='node1'/>",
" <metrics>",
" <consumer id='A'/>",
" <consumer id='a'/>",
" </metrics>",
" </admin>",
"</services>"
);
try {
consumersConfigFromXml(services, self_hosted);
fail();
} catch (IllegalArgumentException e) {
assertEquals("'a' is used as id for two metrics consumers (case is ignored.)", e.getMessage());
}
}
@Test
void non_existent_metric_set_causes_exception() {
String services = String.join("\n",
"<services>",
" <admin version='2.0'>",
" <adminserver hostalias='node1'/>",
" <metrics>",
" <consumer id='consumer-with-non-existent-default-set'>",
" <metric-set id='non-existent'/>",
" </consumer>",
" </metrics>",
" </admin>",
"</services>"
);
try {
consumersConfigFromXml(services, self_hosted);
fail();
} catch (IllegalArgumentException e) {
assertEquals("No such metric-set: non-existent", e.getMessage());
}
}
@Test
void consumer_with_no_metric_set_has_its_own_metrics_plus_system_metrics_plus_default_vespa_metrics() {
String services = String.join("\n",
"<services>",
" <admin version='2.0'>",
" <adminserver hostalias='node1'/>",
" <metrics>",
" <consumer id='consumer-with-metrics-only'>",
" <metric id='custom.metric1'/>",
" <metric id='custom.metric2'/>",
" </consumer>",
" </metrics>",
" </admin>",
"</services>"
);
ConsumersConfig.Consumer consumer = getCustomConsumer(services);
assertEquals(numSystemMetrics + numDefaultVespaMetrics + 2, consumer.metric().size());
Metric customMetric1 = new Metric("custom.metric1");
Metric customMetric2 = new Metric("custom.metric2");
assertTrue(checkMetric(consumer, customMetric1), "Did not contain metric: " + customMetric1);
assertTrue(checkMetric(consumer, customMetric2), "Did not contain metric: " + customMetric2);
}
@Test
void consumer_with_default_metric_set_has_all_its_metrics_plus_all_system_metrics_plus_its_own() {
String services = String.join("\n",
"<services>",
" <admin version='2.0'>",
" <adminserver hostalias='node1'/>",
" <metrics>",
" <consumer id='consumer-with-public-default-set'>",
" <metric-set id='default'/>",
" <metric id='custom.metric'/>",
" </consumer>",
" </metrics>",
" </admin>",
"</services>"
);
ConsumersConfig.Consumer consumer = getCustomConsumer(services);
assertEquals(numPublicDefaultMetrics + numSystemMetrics + 1, consumer.metric().size());
Metric customMetric = new Metric("custom.metric");
assertTrue(checkMetric(consumer, customMetric), "Did not contain metric: " + customMetric);
}
@Test
void consumer_with_vespa_metric_set_has_all_vespa_metrics_plus_all_system_metrics_plus_its_own() {
String services = String.join("\n",
"<services>",
" <admin version='2.0'>",
" <adminserver hostalias='node1'/>",
" <metrics>",
" <consumer id='consumer-with-vespa-set'>",
" <metric-set id='vespa'/>",
" <metric id='my.extra.metric'/>",
" </consumer>",
" </metrics>",
" </admin>",
"</services>"
);
ConsumersConfig.Consumer consumer = getCustomConsumer(services);
assertEquals(numVespaMetrics + numSystemMetrics + 1, consumer.metric().size());
Metric customMetric = new Metric("my.extra.metric");
assertTrue(checkMetric(consumer, customMetric), "Did not contain metric: " + customMetric);
}
}
|
