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
|
/*
* 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.core.MetricsConsumers;
import ai.vespa.metricsproxy.core.MetricsManager;
import ai.vespa.metricsproxy.core.MonitoringConfig;
import ai.vespa.metricsproxy.core.VespaMetrics;
import ai.vespa.metricsproxy.http.GenericMetricsHandler;
import ai.vespa.metricsproxy.metric.ExternalMetrics;
import ai.vespa.metricsproxy.metric.dimensions.ApplicationDimensions;
import ai.vespa.metricsproxy.metric.dimensions.ApplicationDimensionsConfig;
import ai.vespa.metricsproxy.rpc.RpcServer;
import ai.vespa.metricsproxy.service.ConfigSentinelClient;
import ai.vespa.metricsproxy.service.SystemPollerProvider;
import com.yahoo.config.model.deploy.DeployState;
import com.yahoo.config.model.producer.AbstractConfigProducer;
import com.yahoo.config.model.producer.AbstractConfigProducerRoot;
import com.yahoo.config.provision.ApplicationId;
import com.yahoo.config.provision.Zone;
import com.yahoo.osgi.provider.model.ComponentModel;
import com.yahoo.search.config.QrStartConfig;
import com.yahoo.vespa.model.VespaModel;
import com.yahoo.vespa.model.admin.Admin;
import com.yahoo.vespa.model.admin.monitoring.MetricSet;
import com.yahoo.vespa.model.admin.monitoring.MetricsConsumer;
import com.yahoo.vespa.model.admin.monitoring.Monitoring;
import com.yahoo.vespa.model.container.ContainerCluster;
import com.yahoo.vespa.model.container.component.Handler;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Optional;
import java.util.logging.Logger;
import static com.yahoo.vespa.model.admin.metricsproxy.ConsumersConfigGenerator.addMetrics;
import static com.yahoo.vespa.model.admin.metricsproxy.ConsumersConfigGenerator.generateConsumers;
import static com.yahoo.vespa.model.admin.metricsproxy.MetricsProxyContainerCluster.AppDimensionNames.APPLICATION;
import static com.yahoo.vespa.model.admin.metricsproxy.MetricsProxyContainerCluster.AppDimensionNames.APPLICATION_ID;
import static com.yahoo.vespa.model.admin.metricsproxy.MetricsProxyContainerCluster.AppDimensionNames.INSTANCE;
import static com.yahoo.vespa.model.admin.metricsproxy.MetricsProxyContainerCluster.AppDimensionNames.LEGACY_APPLICATION;
import static com.yahoo.vespa.model.admin.metricsproxy.MetricsProxyContainerCluster.AppDimensionNames.TENANT;
import static com.yahoo.vespa.model.admin.metricsproxy.MetricsProxyContainerCluster.AppDimensionNames.ZONE;
import static com.yahoo.vespa.model.admin.monitoring.VespaMetricsConsumer.getVespaMetricsConsumer;
import static com.yahoo.vespa.model.admin.monitoring.MetricSet.emptyMetricSet;
import static com.yahoo.vespa.model.container.xml.BundleMapper.JarSuffix.JAR_WITH_DEPS;
import static com.yahoo.vespa.model.container.xml.BundleMapper.absoluteBundlePath;
/**
* Container cluster for metrics proxy containers.
*
* @author gjoranv
*/
public class MetricsProxyContainerCluster extends ContainerCluster<MetricsProxyContainer> implements
ApplicationDimensionsConfig.Producer,
ConsumersConfig.Producer,
MonitoringConfig.Producer,
QrStartConfig.Producer
{
public static final Logger log = Logger.getLogger(MetricsProxyContainerCluster.class.getName());
private static final String METRICS_PROXY_NAME = "metrics-proxy";
static final Path METRICS_PROXY_BUNDLE_FILE = absoluteBundlePath((Paths.get(METRICS_PROXY_NAME + JAR_WITH_DEPS.suffix)));
static final String METRICS_PROXY_BUNDLE_NAME = "com.yahoo.vespa." + METRICS_PROXY_NAME;
private static final String METRICS_HANDLER_BINDING = "/metrics/v1/values";
static final class AppDimensionNames {
static final String ZONE = "zone";
static final String APPLICATION_ID = "applicationId"; // tenant.app.instance
static final String TENANT = "tenantName";
static final String APPLICATION = "applicationName";
static final String INSTANCE = "instanceName";
static final String LEGACY_APPLICATION = "app"; // app.instance
}
private final AbstractConfigProducer<?> parent;
private final ApplicationId applicationId;
public MetricsProxyContainerCluster(AbstractConfigProducer<?> parent, String name, DeployState deployState) {
super(parent, name, name, deployState);
this.parent = parent;
applicationId = deployState.getProperties().applicationId();
setMessageBusEnabled(false);
setRpcServerEnabled(true);
addDefaultHandlersExceptStatus();
addPlatformBundle(METRICS_PROXY_BUNDLE_FILE);
addClusterComponents();
addGenericMetricsHandler();
}
private void addClusterComponents() {
addMetricsProxyComponent(ApplicationDimensions.class);
addMetricsProxyComponent(ConfigSentinelClient.class);
addMetricsProxyComponent(ExternalMetrics.class);
addMetricsProxyComponent(MetricsConsumers.class);
addMetricsProxyComponent(MetricsManager.class);
addMetricsProxyComponent(RpcServer.class);
addMetricsProxyComponent(SystemPollerProvider.class);
addMetricsProxyComponent(VespaMetrics.class);
}
private void addGenericMetricsHandler() {
Handler<AbstractConfigProducer<?>> metricsHandler = new Handler<>(
new ComponentModel(GenericMetricsHandler.class.getName(), null, METRICS_PROXY_BUNDLE_NAME, null));
metricsHandler.addServerBindings("http://*" + METRICS_HANDLER_BINDING,
"http://*" + METRICS_HANDLER_BINDING + "/*");
addComponent(metricsHandler);
}
@Override
protected void doPrepare(DeployState deployState) { }
@Override
public void getConfig(MonitoringConfig.Builder builder) {
getSystemName().ifPresent(builder::systemName);
getIntervalMinutes().ifPresent(builder::intervalMinutes);
}
@Override
public void getConfig(ConsumersConfig.Builder builder) {
var amendedDefaultConsumer = addMetrics(getVespaMetricsConsumer(), getAdditionalDefaultMetrics().getMetrics());
builder.consumer.addAll(generateConsumers(amendedDefaultConsumer, getUserMetricsConsumers()));
}
@Override
public void getConfig(ApplicationDimensionsConfig.Builder builder) {
if (isHostedVespa()) {
builder.dimensions(applicationDimensions());
}
}
// Switch off verbose:gc, because it's very noisy when Xms < Xmx
@Override
public void getConfig(QrStartConfig.Builder builder) {
super.getConfig(builder);
// This takes effect via vespa-start-container-daemon:configure_gcopts
builder.jvm.verbosegc(false);
}
private MetricSet getAdditionalDefaultMetrics() {
return getAdmin()
.map(Admin::getAdditionalDefaultMetrics)
.orElse(emptyMetricSet());
}
// Returns the metrics consumers from services.xml
private Map<String, MetricsConsumer> getUserMetricsConsumers() {
return getAdmin()
.map(admin -> admin.getUserMetrics().getConsumers())
.orElse(Collections.emptyMap());
}
private Optional<Admin> getAdmin() {
if (parent != null) {
AbstractConfigProducerRoot r = parent.getRoot();
if (r instanceof VespaModel) {
VespaModel model = (VespaModel) r;
return Optional.ofNullable(model.getAdmin());
}
}
return Optional.empty();
}
private Optional<String> getSystemName() {
Monitoring monitoring = getMonitoringService();
return monitoring != null && ! monitoring.getClustername().equals("") ?
Optional.of(monitoring.getClustername()) : Optional.empty();
}
private Optional<Integer> getIntervalMinutes() {
Monitoring monitoring = getMonitoringService();
return monitoring != null ?
Optional.of(monitoring.getInterval()) : Optional.empty();
}
private void addMetricsProxyComponent(Class<?> componentClass) {
addSimpleComponent(componentClass.getName(), null, METRICS_PROXY_BUNDLE_NAME);
}
private Map<String, String> applicationDimensions() {
Map<String, String> dimensions = new LinkedHashMap<>();
dimensions.put(ZONE, zoneString(getZone()));
dimensions.put(APPLICATION_ID, serializeWithDots(applicationId));
dimensions.put(TENANT, applicationId.tenant().value());
dimensions.put(APPLICATION, applicationId.application().value());
dimensions.put(INSTANCE, applicationId.instance().value());
dimensions.put(LEGACY_APPLICATION, applicationId.application().value() + "." + applicationId.instance().value());
return dimensions;
}
// ApplicationId uses ':' as separator.
private static String serializeWithDots(ApplicationId applicationId) {
return applicationId.serializedForm().replace(':', '.');
}
static String zoneString(Zone zone) {
return zone.environment().value() + "." + zone.region().value();
}
}
|
