OpenTelemetryGauge.java

/*
 * Copyright ConsenSys AG.
 *
 * 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.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
package org.hyperledger.besu.metrics.opentelemetry;

import org.hyperledger.besu.plugin.services.metrics.LabelledGauge;

import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.function.DoubleSupplier;

import com.google.common.base.Preconditions;
import io.opentelemetry.api.common.Attributes;
import io.opentelemetry.api.common.AttributesBuilder;
import io.opentelemetry.api.metrics.Meter;
import io.opentelemetry.api.metrics.ObservableDoubleMeasurement;

/** The Open telemetry gauge. */
public class OpenTelemetryGauge implements LabelledGauge {
  private final List<String> labelNames;
  private final Map<Attributes, DoubleSupplier> observationsMap = new ConcurrentHashMap<>();

  /**
   * Instantiates a new Open telemetry gauge.
   *
   * @param metricName the metric name
   * @param help the help
   * @param meter the meter
   * @param labelNames the label names
   */
  public OpenTelemetryGauge(
      final String metricName,
      final String help,
      final Meter meter,
      final List<String> labelNames) {
    this.labelNames = labelNames;

    meter.gaugeBuilder(metricName).setDescription(help).buildWithCallback(this::updater);
  }

  @Override
  public void labels(final DoubleSupplier valueSupplier, final String... labelValues) {
    Preconditions.checkArgument(
        labelValues.length == labelNames.size(),
        "label values and label names need the same number of elements");
    final Attributes labels = getLabels(labelValues);
    if (observationsMap.putIfAbsent(labels, valueSupplier) != null) {
      throw new IllegalStateException(
          "Already registered a gauge with labels " + Arrays.toString(labelValues));
    }
  }

  private Attributes getLabels(final String... labelValues) {
    final AttributesBuilder labelsBuilder = Attributes.builder();
    for (int i = 0; i < labelNames.size(); i++) {
      labelsBuilder.put(labelNames.get(i), labelValues[i]);
    }
    return labelsBuilder.build();
  }

  private void updater(final ObservableDoubleMeasurement measurement) {
    observationsMap.forEach(
        (labels, valueSupplier) -> measurement.record(valueSupplier.getAsDouble(), labels));
  }
}