io.opentelemetry.instrumentation.jmx.yaml.JmxRule Maven / Gradle / Ivy

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

package io.opentelemetry.instrumentation.jmx.yaml;

import com.google.errorprone.annotations.CanIgnoreReturnValue;
import io.opentelemetry.instrumentation.jmx.engine.BeanAttributeExtractor;
import io.opentelemetry.instrumentation.jmx.engine.BeanGroup;
import io.opentelemetry.instrumentation.jmx.engine.MetricAttribute;
import io.opentelemetry.instrumentation.jmx.engine.MetricDef;
import io.opentelemetry.instrumentation.jmx.engine.MetricExtractor;
import io.opentelemetry.instrumentation.jmx.engine.MetricInfo;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import javax.annotation.Nullable;
import javax.management.MalformedObjectNameException;
import javax.management.ObjectName;

/**
 * This class represents a complete JMX metrics rule as defined by a YAML file. Objects of this
 * class are created and populated by the YAML parser.
 */
public class JmxRule extends MetricStructure {

  // Used by the YAML parser
  //   bean: OBJECT_NAME
  //   beans:
  //     - OBJECTNAME1
  //     - OBJECTNAME2
  //   prefix: METRIC_NAME_PREFIX
  //   mapping:
  //     ATTRIBUTE1:
  //       METRIC_FIELDS1
  //     ATTRIBUTE2:
  //     ATTRIBUTE3:
  //       METRIC_FIELDS3
  // The parser never calls setters for these fields with null arguments
  @Nullable private String bean;
  private List beans;
  @Nullable private String prefix;
  private Map mapping;

  public String getBean() {
    return bean;
  }

  public void setBean(String bean) {
    this.bean = validateBean(bean);
  }

  public List getBeans() {
    return beans;
  }

  private static String validateBean(String name) {
    try {
      String trimmed = name.trim();
      // Check the syntax of the provided name by attempting to create an ObjectName from it.
      new ObjectName(trimmed);
      return trimmed;
    } catch (MalformedObjectNameException e) {
      throw new IllegalArgumentException("'" + name + "' is not a valid JMX object name", e);
    }
  }

  public void setBeans(List beans) {
    List list = new ArrayList<>();
    for (String name : beans) {
      list.add(validateBean(name));
    }
    this.beans = list;
  }

  public void setPrefix(String prefix) {
    this.prefix = validatePrefix(prefix.trim());
  }

  @CanIgnoreReturnValue
  private String validatePrefix(String prefix) {
    // Do not accept empty string.
    // While it is theoretically acceptable, it probably indicates a user error.
    requireNonEmpty(prefix, "The metric name prefix is empty");
    return prefix;
  }

  public String getPrefix() {
    return prefix;
  }

  public Map getMapping() {
    return mapping;
  }

  public void setMapping(Map mapping) {
    this.mapping = validateAttributeMapping(mapping);
  }

  @CanIgnoreReturnValue
  private static Map validateAttributeMapping(Map mapping) {
    if (mapping.isEmpty()) {
      throw new IllegalStateException("No MBean attributes specified");
    }

    // Make sure that all attribute names are well-formed by creating the corresponding
    // BeanAttributeExtractors
    Set attrNames = mapping.keySet();
    for (String attributeName : attrNames) {
      // check if BeanAttributeExtractors can be built without exceptions
      BeanAttributeExtractor.fromName(attributeName);
    }
    return mapping;
  }

  /**
   * Convert this rule to a complete MetricDefinition object. If the rule is incomplete or has
   * consistency or semantic issues, an exception will be thrown.
   *
   * @return a valid MetricDefinition object
   * @throws Exception an exception if any issues within the rule are detected
   */
  public MetricDef buildMetricDef() throws Exception {
    BeanGroup group;
    if (bean != null) {
      group = new BeanGroup(null, new ObjectName(bean));
    } else if (beans != null && !beans.isEmpty()) {
      ObjectName[] objectNames = new ObjectName[beans.size()];
      int k = 0;
      for (String oneBean : beans) {
        objectNames[k++] = new ObjectName(oneBean);
      }
      group = new BeanGroup(null, objectNames);
    } else {
      throw new IllegalStateException("No ObjectName specified");
    }

    if (mapping == null || mapping.isEmpty()) {
      throw new IllegalStateException("No MBean attributes specified");
    }

    Set attrNames = mapping.keySet();
    MetricExtractor[] metricExtractors = new MetricExtractor[attrNames.size()];
    int n = 0;
    for (String attributeName : attrNames) {
      BeanAttributeExtractor attrExtractor = BeanAttributeExtractor.fromName(attributeName);
      // This is essentially the same as 'attributeName' but with escape characters removed
      String niceAttributeName = attrExtractor.getAttributeName();
      MetricInfo metricInfo;
      Metric m = mapping.get(attributeName);
      if (m == null) {
        metricInfo =
            new MetricInfo(
                prefix == null ? niceAttributeName : (prefix + niceAttributeName),
                null,
                getUnit(),
                getMetricType());
      } else {
        metricInfo = m.buildMetricInfo(prefix, niceAttributeName, getUnit(), getMetricType());
      }

      List attributeList;
      List ownAttributes = getAttributeList();
      if (ownAttributes != null && m != null && m.getAttributeList() != null) {
        // MetricAttributes have been specified at two levels, need to combine them
        attributeList = combineMetricAttributes(ownAttributes, m.getAttributeList());
      } else if (ownAttributes != null) {
        attributeList = ownAttributes;
      } else if (m != null && m.getAttributeList() != null) {
        // Get the attributes from the metric
        attributeList = m.getAttributeList();
      } else {
        // There are no attributes at all
        attributeList = new ArrayList();
      }

      MetricExtractor metricExtractor =
          new MetricExtractor(
              attrExtractor,
              metricInfo,
              attributeList.toArray(new MetricAttribute[attributeList.size()]));
      metricExtractors[n++] = metricExtractor;
    }

    return new MetricDef(group, metricExtractors);
  }

  private static List combineMetricAttributes(
      List ownAttributes, List metricAttributes) {
    Map set = new HashMap<>();
    for (MetricAttribute ownAttribute : ownAttributes) {
      set.put(ownAttribute.getAttributeName(), ownAttribute);
    }

    // Let the metric level defined attributes override own attributes
    for (MetricAttribute metricAttribute : metricAttributes) {
      set.put(metricAttribute.getAttributeName(), metricAttribute);
    }

    return new ArrayList(set.values());
  }
}