config-model/src/main/java/com/yahoo/vespa/model/builder/xml/dom/DomMetricBuilderHelper.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

// Copyright 2017 Yahoo Holdings. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.model.builder.xml.dom;

import com.yahoo.text.XML;
import com.yahoo.vespa.model.admin.monitoring.Metric;
import com.yahoo.vespa.model.admin.monitoring.MetricSet;
import com.yahoo.vespa.model.admin.monitoring.MetricsConsumer;
import org.w3c.dom.Element;

import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;

import static com.yahoo.vespa.model.admin.monitoring.DefaultMetricsConsumer.VESPA_CONSUMER_ID;

/**
 * Helper class for parsing metric config.
 *
 * TODO: Remove when 'metric-consumers' under 'admin' is disallowed
 *
 * @author Trygve Berdal
 */
public class DomMetricBuilderHelper {

    private static final String LEGACY_DEFAULT_CONSUMER_ID = "yamas";

    /**
     * Build metricConsumer config
     *
     * @param spec xml element
     * @return  a map from metric name to a {@link MetricsConsumer}
     */
    protected static Map<String, MetricsConsumer> buildMetricsConsumers(Element spec) {
        Map<String, MetricsConsumer> metricsConsumers = new LinkedHashMap<>();
        List<Element> consumersElem = XML.getChildren(spec, "consumer");
        for (Element consumer : consumersElem) {
            String consumerName = getConsumerName(consumer);
            Set<Metric> metrics = new LinkedHashSet<>();
            List<Element> metricsEl = XML.getChildren(consumer, "metric");
            if (metricsEl != null) {
                for (Element metric : metricsEl) {
                    String metricName = metric.getAttribute("name");
                    String outputName = metric.getAttribute("output-name");
                    metrics.add(new Metric(metricName, outputName));
                }
            }
            MetricsConsumer metricsConsumer = new MetricsConsumer(consumerName,
                                                                  new MetricSet(metricSetId(consumerName), metrics));
            metricsConsumers.put(consumerName, metricsConsumer);
        }
        return metricsConsumers;
    }

    // Converts the old default consumer id to the new default id.
    private static String getConsumerName(Element consumerElement) {
        String givenName = consumerElement.getAttribute("name");
        if (givenName.equals(LEGACY_DEFAULT_CONSUMER_ID))
            return VESPA_CONSUMER_ID;
        else
            return givenName;
    }

    private static String metricSetId(String consumerName) {
        return "legacy-user-metrics-" + consumerName;
    }
}