com.swirlds.common.metrics.platform.prometheus.DistributionAdapter Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of swirlds-common Show documentation
Show all versions of swirlds-common Show documentation
Swirlds is a software platform designed to build fully-distributed applications that harness the power of the cloud without servers. Now you can develop applications with fairness in decision making, speed, trust and reliability, at a fraction of the cost of traditional server-based platforms.
/*
* Copyright (C) 2022-2024 Hedera Hashgraph, LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.swirlds.common.metrics.platform.prometheus;
import static com.swirlds.common.metrics.platform.prometheus.PrometheusEndpoint.AdapterType.GLOBAL;
import static com.swirlds.common.metrics.platform.prometheus.PrometheusEndpoint.AdapterType.PLATFORM;
import static com.swirlds.common.metrics.platform.prometheus.PrometheusEndpoint.NODE_LABEL;
import static com.swirlds.common.metrics.platform.prometheus.PrometheusEndpoint.TYPE_LABEL;
import com.swirlds.common.metrics.platform.prometheus.PrometheusEndpoint.AdapterType;
import com.swirlds.common.platform.NodeId;
import com.swirlds.metrics.api.Metric;
import com.swirlds.metrics.api.snapshot.Snapshot;
import io.prometheus.client.Collector;
import io.prometheus.client.CollectorRegistry;
import io.prometheus.client.Gauge;
import java.util.Objects;
/**
* Adapter that synchronizes {@link com.swirlds.common.metrics.RunningAverageMetric} and
* {@link com.swirlds.common.metrics.SpeedometerMetric} with the corresponding Prometheus {@link Collector}.
*/
public class DistributionAdapter extends AbstractMetricAdapter {
private final Gauge gauge;
/**
* Constructor of {@code DistributionAdapter}.
*
* @param registry
* The {@link CollectorRegistry} with which the Prometheus {@link Collector} should be registered
* @param metric
* The {@link Metric} which value should be reported to Prometheus
* @param adapterType
* Scope of the {@link Metric}, either {@link AdapterType#GLOBAL} or {@link AdapterType#PLATFORM}
* @throws NullPointerException if any of the following parameters are {@code null}.
*
* - {@code registry}
* - {@code metric}
*
*/
public DistributionAdapter(final CollectorRegistry registry, final Metric metric, final AdapterType adapterType) {
super(adapterType, metric);
Objects.requireNonNull(registry, "registry must not be null");
Objects.requireNonNull(metric, "metric must not be null");
final Gauge.Builder builder = assignCommonValues(new Gauge.Builder());
if (adapterType == PLATFORM) {
builder.labelNames(NODE_LABEL, TYPE_LABEL);
} else {
builder.labelNames(TYPE_LABEL);
}
this.gauge = builder.register(registry);
}
/**
* {@inheritDoc}
*/
@Override
public void update(final Snapshot snapshot, final NodeId nodeId) {
Objects.requireNonNull(snapshot, "snapshot must not be null");
if (adapterType != GLOBAL) {
Objects.requireNonNull(nodeId, "nodeId must not be null");
}
for (final Snapshot.SnapshotEntry entry : snapshot.entries()) {
final String valueType =
switch (entry.valueType()) {
case MIN -> "min";
case MAX -> "max";
case STD_DEV -> "stddev";
default -> "mean";
};
final Gauge.Child child =
adapterType == GLOBAL ? gauge.labels(valueType) : gauge.labels(nodeId.toString(), valueType);
child.set(((Number) entry.value()).doubleValue());
}
}
/**
* {@inheritDoc}
*/
@Override
public void unregister(final CollectorRegistry registry) {
registry.unregister(gauge);
}
}