Refining comments

open-telemetry · Oct 31, 2022 · 252be45 · 252be45
1 parent 112a04d
commit 252be45
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/...y/src/main/java/io/opentelemetry/instrumentation/jmx/engine/MetricAttributeExtractor.java b/...y/src/main/java/io/opentelemetry/instrumentation/jmx/engine/MetricAttributeExtractor.java
@@ -14,5 +14,14 @@
  */
 public interface MetricAttributeExtractor {
 
+  /**
+   * Provide a String value to be used as the value of a metric attribute.
+   *
+   * @param server MBeanServer to query, must not be null if the extraction is from an MBean
+   *     attribute
+   * @param objectName the identifier of the MBean to query, must not be null if the extraction is
+   *     from an MBean attribute, or from the ObjectName parameter
+   * @return the value of the attribute, can be null if extraction failed
+   */
   String extractValue(MBeanServer server, ObjectName objectName);
 }