com.yahoo.vespa.model.admin.monitoring.MetricsConsumer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of config-model Show documentation
There is a newer version: 8.441.21
// 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.monitoring;

import ai.vespa.metrics.set.Metric;
import ai.vespa.metrics.set.MetricSet;
import ai.vespa.metrics.set.Vespa9VespaMetricSet;
import ai.vespa.metricsproxy.core.VespaMetrics;
import ai.vespa.metricsproxy.http.ValuesFetcher;

import java.util.List;
import java.util.Map;
import java.util.Objects;

import static ai.vespa.metrics.set.AutoscalingMetrics.autoscalingMetricSet;
import static ai.vespa.metrics.set.DefaultMetrics.defaultMetricSet;
import static ai.vespa.metrics.set.NetworkMetrics.networkMetricSet;
import static ai.vespa.metrics.set.SystemMetrics.systemMetricSet;
import static ai.vespa.metrics.set.VespaMetricSet.vespaMetricSet;

/**
 * A metric consumer is a set of metrics given an id that can be requested at runtime.
 *
 * @author Trygve Berdal
 * @author gjoranv
 */
// TODO: This construct seems redundant when we have metrics sets
public class MetricsConsumer {

    // Pre-defined consumers
    // See also ConsumersConfigGenerator and MetricsBuilder where these must be enumerated
    public static final MetricsConsumer vespa =
            consumer(VespaMetrics.vespaMetricsConsumerId.id, vespaMetricSet, systemMetricSet, networkMetricSet);

    public static final MetricsConsumer defaultConsumer =
            consumer(ValuesFetcher.defaultMetricsConsumerId.id, defaultMetricSet, systemMetricSet);

    // Referenced from com.yahoo.vespa.hosted.provision.autoscale.NodeMetricsFetcher
    public static final MetricsConsumer autoscaling =
            consumer("autoscaling", autoscalingMetricSet);

    public static final MetricsConsumer vespaCloud =
            consumer("vespa-cloud", vespaMetricSet, systemMetricSet, networkMetricSet);

    public static final MetricsConsumer vespa9 =
            consumer("Vespa9", Vespa9VespaMetricSet.vespa9vespaMetricSet, systemMetricSet, networkMetricSet);

    private final String id;
    private final MetricSet metricSet;

    /**
     * @param id the consumer
     * @param metricSet the metrics for this consumer
     */
    public MetricsConsumer(String id, MetricSet metricSet) {
        this.id = Objects.requireNonNull(id, "A consumer must have a non-null id.");;
        this.metricSet = Objects.requireNonNull(metricSet, "A consumer must have a non-null metric set.");
    }

    public String id() {
        return id;
    }

    public MetricSet metricSet() { return metricSet; }

    /**
     * @return map of metric with metric name as key
     */
    public Map metrics() {
        return metricSet.getMetrics();
    }

    public static MetricsConsumer consumer(String id, MetricSet ... metricSets) {
        return new MetricsConsumer(id, new MetricSet(id + "-consumer-metrics", List.of(), List.of(metricSets)));
    }

}