Package com.tangosol.net.management.annotation

Annotation Interface MetricsTag

@Target(METHOD) @Retention(RUNTIME) public @interface MetricsTag
The MetricsTag descriptor annotation adds a metrics.tag field and its value to the descriptor for a method on an MBean. The existence of this annotation on an MBean attribute indicates that the MBean attribute is mapped to a metrics tag with the metrics tag name being value(). By default, an MBean attribute is not mapped to a metrics value or metrics tag.

This annotation is intended to be put on MBean attribute type's containing metainfo about all the metrics.values associated with an MBean.

Since:
12.2.1.4.0
Author:
jf 9.27.2018

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    value
    Returns the metrics name, expected to be in snake case, for the MBean attribute.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    DEFAULT
     
    static final String
    DESCRIPTOR_KEY
     

  • Field Details

  • Element Details

    • value

      @DescriptorKey("metrics.tag") String value
      Returns the metrics name, expected to be in snake case, for the MBean attribute. If value is _default, a snake case metric name is generated from the MBean attribute name.

      To allow short form assignments of single member annotations, "value" must be used (Java convention).

      Returns:
      a snake case metrics name for MBean attribute or "_default"
      Default:
      "_default"