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
|
/*
* Copyright 2019 Oath Inc. 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.metricsproxy.core.ConsumersConfig;
import ai.vespa.metricsproxy.metric.dimensions.ApplicationDimensionsConfig;
import com.yahoo.config.model.test.MockApplicationPackage;
import com.yahoo.config.provision.Zone;
import com.yahoo.container.BundlesConfig;
import com.yahoo.container.core.ApplicationMetadataConfig;
import com.yahoo.search.config.QrStartConfig;
import com.yahoo.vespa.model.VespaModel;
import com.yahoo.vespa.model.admin.metricsproxy.MetricsProxyContainerCluster.AppDimensionNames;
import com.yahoo.vespa.model.admin.monitoring.Metric;
import com.yahoo.vespa.model.admin.monitoring.MetricSet;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.ExpectedException;
import static com.yahoo.vespa.model.admin.metricsproxy.MetricsProxyContainerCluster.METRICS_PROXY_BUNDLE_FILE;
import static com.yahoo.vespa.model.admin.metricsproxy.MetricsProxyContainerCluster.zoneString;
import static com.yahoo.vespa.model.admin.metricsproxy.MetricsProxyModelTester.CLUSTER_CONFIG_ID;
import static com.yahoo.vespa.model.admin.metricsproxy.MetricsProxyModelTester.MY_APPLICATION;
import static com.yahoo.vespa.model.admin.metricsproxy.MetricsProxyModelTester.MY_INSTANCE;
import static com.yahoo.vespa.model.admin.metricsproxy.MetricsProxyModelTester.MY_TENANT;
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.getApplicationDimensionsConfig;
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.getQrStartConfig;
import static com.yahoo.vespa.model.admin.monitoring.DefaultPublicConsumer.DEFAULT_PUBLIC_CONSUMER_ID;
import static com.yahoo.vespa.model.admin.monitoring.DefaultPublicMetrics.defaultPublicMetricSet;
import static com.yahoo.vespa.model.admin.monitoring.VespaMetricsConsumer.VESPA_CONSUMER_ID;
import static com.yahoo.vespa.model.admin.monitoring.DefaultVespaMetrics.defaultVespaMetricSet;
import static com.yahoo.vespa.model.admin.monitoring.NetworkMetrics.networkMetricSet;
import static com.yahoo.vespa.model.admin.monitoring.SystemMetrics.systemMetricSet;
import static com.yahoo.vespa.model.admin.monitoring.VespaMetricSet.vespaMetricSet;
import static java.util.Collections.singleton;
import static org.hamcrest.CoreMatchers.endsWith;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertThat;
import static org.junit.Assert.assertTrue;
/**
* @author gjoranv
*/
public class MetricsProxyContainerClusterTest {
private static int numDefaultVespaMetrics = defaultVespaMetricSet.getMetrics().size();
private static int numVespaMetrics = vespaMetricSet.getMetrics().size();
private static int numSystemMetrics = systemMetricSet.getMetrics().size();
private static int numNetworkMetrics = networkMetricSet.getMetrics().size();
private static int numMetricsForVespaConsumer = numVespaMetrics + numSystemMetrics + numNetworkMetrics;
@Rule
public ExpectedException thrown = ExpectedException.none();
@Test
public void metrics_proxy_bundle_is_included_in_bundles_config() {
VespaModel model = getModel(servicesWithAdminOnly(), self_hosted);
var builder = new BundlesConfig.Builder();
model.getConfig(builder, CLUSTER_CONFIG_ID);
BundlesConfig config = builder.build();
assertEquals(1, config.bundle().size());
assertThat(config.bundle(0).value(), endsWith(METRICS_PROXY_BUNDLE_FILE.toString()));
}
@Test
public void cluster_is_prepared_so_that_application_metadata_config_is_produced() {
VespaModel model = getModel(servicesWithAdminOnly(), self_hosted);
var builder = new ApplicationMetadataConfig.Builder();
model.getConfig(builder, CLUSTER_CONFIG_ID);
ApplicationMetadataConfig config = builder.build();
assertEquals(MockApplicationPackage.APPLICATION_GENERATION, config.generation());
assertEquals(MockApplicationPackage.APPLICATION_NAME, config.name());
assertEquals(MockApplicationPackage.DEPLOYED_BY_USER, config.user());
}
@Test
public void verbose_gc_logging_is_disabled() {
VespaModel model = getModel(servicesWithAdminOnly(), self_hosted);
QrStartConfig config = getQrStartConfig(model);
assertFalse(config.jvm().verbosegc());
}
@Test
public void default_public_consumer_is_set_up_for_self_hosted() {
ConsumersConfig config = consumersConfigFromXml(servicesWithAdminOnly(), self_hosted);
assertEquals(2, config.consumer().size());
assertEquals(config.consumer(1).name(), DEFAULT_PUBLIC_CONSUMER_ID);
int numMetricsForPublicDefaultConsumer = defaultPublicMetricSet.getMetrics().size() + numDefaultVespaMetrics + numSystemMetrics;
assertEquals(numMetricsForPublicDefaultConsumer, config.consumer(1).metric().size());
}
@Test
public void default_public_consumer_is_not_set_up_for_hosted() {
ConsumersConfig config = consumersConfigFromXml(servicesWithAdminOnly(), hosted);
assertEquals(1, config.consumer().size());
assertEquals(config.consumer(0).name(), VESPA_CONSUMER_ID);
}
@Test
public void vespa_consumer_is_always_present_and_has_all_vespa_metrics_and_all_system_metrics() {
ConsumersConfig config = consumersConfigFromXml(servicesWithAdminOnly(), self_hosted);
assertEquals(config.consumer(0).name(), VESPA_CONSUMER_ID);
assertEquals(numMetricsForVespaConsumer, config.consumer(0).metric().size());
}
@Test
public 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("Did not contain additional metric", checkMetric(vespaConsumer, additionalMetric));
}
@Test
public void vespa_is_a_reserved_consumer_id() {
assertReservedConsumerId("Vespa");
}
@Test
public void public_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>"
);
thrown.expect(IllegalArgumentException.class);
thrown.expectMessage("'" + consumerId + "' is not allowed as metrics consumer id");
consumersConfigFromXml(services, self_hosted);
}
@Test
public 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(1, 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("Did not contain metric: " + customMetric1, checkMetric(vespaConsumer, customMetric1));
}
@Test
public 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>"
);
thrown.expect(IllegalArgumentException.class);
thrown.expectMessage("'a' is used as id for two metrics consumers");
consumersConfigFromXml(services, self_hosted);
}
@Test
public 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("Did not contain metric: " + customMetric1, checkMetric(consumer, customMetric1));
assertTrue("Did not contain metric: " + customMetric2, checkMetric(consumer, customMetric2));
}
@Test
public 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("Did not contain metric: " + customMetric, checkMetric(consumer, customMetric));
}
@Test
public void hosted_application_propagates_application_dimensions() {
VespaModel hostedModel = getModel(servicesWithAdminOnly(), hosted);
ApplicationDimensionsConfig config = getApplicationDimensionsConfig(hostedModel);
assertEquals(zoneString(Zone.defaultZone()), config.dimensions(AppDimensionNames.ZONE));
assertEquals(MY_TENANT, config.dimensions(AppDimensionNames.TENANT));
assertEquals(MY_APPLICATION, config.dimensions(AppDimensionNames.APPLICATION));
assertEquals(MY_INSTANCE, config.dimensions(AppDimensionNames.INSTANCE));
assertEquals(MY_TENANT + "." + MY_APPLICATION + "." + MY_INSTANCE, config.dimensions(AppDimensionNames.APPLICATION_ID));
assertEquals(MY_APPLICATION + "." + MY_INSTANCE, config.dimensions(AppDimensionNames.LEGACY_APPLICATION));
}
private static String servicesWithAdminOnly() {
return String.join("\n", "<services>",
" <admin version='4.0'>",
" <adminserver hostalias='node1'/>",
" </admin>",
"</services>"
);
}
}
|
