io.opentelemetry.instrumentation.jmx.engine.BeanGroup 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;
import javax.management.ObjectName;
import javax.management.QueryExp;

/**
 * A class describing a set of MBeans which can be used to collect values for a metric. Objects of
 * this class are immutable.
 */
public class BeanGroup {
  // How to specify the MBean(s)
  @Nullable private final QueryExp queryExp;
  private final ObjectName[] namePatterns;

  /**
   * Constructor for BeanGroup.
   *
   * @param queryExp the QueryExp to be used to filter results when looking for MBeans
   * @param namePatterns an array of ObjectNames used to look for MBeans; usually they will be
   *     patterns. If multiple patterns are provided, they work as logical OR.
   */
  public BeanGroup(@Nullable QueryExp queryExp, ObjectName... namePatterns) {
    this.queryExp = queryExp;
    this.namePatterns = namePatterns;
  }

  @Nullable
  QueryExp getQueryExp() {
    return queryExp;
  }

  ObjectName[] getNamePatterns() {
    return namePatterns;
  }
}