Package org.eclipse.microprofile.metrics.annotation

Annotation Interface Counted

@Inherited @Documented @InterceptorBinding @Retention(RUNTIME) @Target({TYPE,CONSTRUCTOR,METHOD,ANNOTATION_TYPE}) public @interface Counted
An annotation for marking a method, constructor, or class as counted. The metric will be registered in the application MetricRegistry.

Given a method annotated with @Counted like this: 

 
     @Counted(name = "fancyName")
     public String fancyName(String name) {
         return "Sir Captain " + name;
     }
A counter with the fully qualified class name + fancyName will be created and each time the #fancyName(String) method is invoked, the counter will be marked. Similarly, the same applies for a constructor annotated with counted.

Given a class annotated with @Counted like this: 

 
     @Counted
     public class CounterBean {
         public void countMethod1() {}
         public void countMethod2() {}
     }
A counter for the defining class will be created for each of the constructors/methods. Each time the constructor/method is invoked, the respective counter will be marked. The counter value will only monotonically increase.

Note: the default behaviour has changed in MicroProfile Metrics 2.0. To get the old @Counted(monotonic=false) behavior, see @ConcurrentGauge

This annotation will throw an IllegalStateException if the constructor/method is invoked, but the metric no longer exists in the MetricRegistry.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    absolute
    Denotes whether to use the absolute name or use the default given name relative to the annotated class.
    String
    description
    The description of the counter.
    String
    displayName
    The human readable display name of the counter.
    String
    name
    The name of the counter.
    String[]
    tags
    The tags of the counter.
    String
    unit
    The unit of the counter.

  • Element Details

    • name

      String name
      The name of the counter.
      Returns:
      The name of the counter.
      Default:
      ""

    • tags

      String[] tags
      The tags of the counter.
      Returns:
      The tags of the counter. Each String tag must be in the form of 'key=value'. If the input is empty or does not contain a '=' sign, the entry is ignored.
      See Also:
      Default:
      {}

    • absolute

      boolean absolute
      Denotes whether to use the absolute name or use the default given name relative to the annotated class.
      Returns:
      If true, use the given name as an absolute name. If false (default), use the given name relative to the annotated class. When annotating a class, this must be false.
      Default:
      false

    • displayName

      String displayName
      The human readable display name of the counter.
      Returns:
      The display name of the counter.
      See Also:
      Default:
      ""

    • description

      String description
      The description of the counter.
      Returns:
      The description of the counter.
      See Also:
      Default:
      ""

    • unit

      String unit
      The unit of the counter.
      Returns:
      The unit of the counter. By default, the value is MetricUnits.NONE.
      See Also:
      Default:
      "none"