io.opentelemetry.instrumentation.jmx.engine.MetricExtractor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opentelemetry-jmx-metrics Show documentation

Instrumentation of Java libraries using OpenTelemetry.

There is a newer version: 2.11.0-alpha

Show newest version

/*
 * Copyright The OpenTelemetry Authors
 * SPDX-License-Identifier: Apache-2.0
 */

package io.opentelemetry.instrumentation.jmx.engine;

import javax.annotation.Nullable;

/**
 * A class holding the info needed to support a single metric: how to define it in OpenTelemetry and
 * how to provide the metric values.
 *
 * Objects of this class are stateful, the DetectionStatus may change over time to keep track of
 * all ObjectNames that should be used to deliver the metric values.
 */
public class MetricExtractor {

  private final MetricInfo metricInfo;

  // Defines the way to access the metric value (a number)
  private final BeanAttributeExtractor attributeExtractor;

  // Defines the Measurement attributes to be used when reporting the metric value.
  private final MetricAttribute[] attributes;

  @Nullable private volatile DetectionStatus status;

  public MetricExtractor(
      BeanAttributeExtractor attributeExtractor,
      MetricInfo metricInfo,
      MetricAttribute... attributes) {
    this.attributeExtractor = attributeExtractor;
    this.metricInfo = metricInfo;
    this.attributes = attributes;
  }

  MetricInfo getInfo() {
    return metricInfo;
  }

  BeanAttributeExtractor getMetricValueExtractor() {
    return attributeExtractor;
  }

  MetricAttribute[] getAttributes() {
    return attributes;
  }

  void setStatus(DetectionStatus status) {
    this.status = status;
  }

  @Nullable
  DetectionStatus getStatus() {
    return status;
  }
}