Package io.dropwizard.metrics5.annotation

Annotation Type Metered

  • @Inherited
@Documented
@Retention(RUNTIME)
@Target({TYPE,CONSTRUCTOR,METHOD,ANNOTATION_TYPE})
public @interface Metered
    An annotation for marking a method of an annotated object as metered.

    Given a method like this: 

    
     @Metered(name = "fancyName")
     public String fancyName(String name) {
         return "Sir Captain " + name;
     }

    A meter for the defining class with the name fancyName will be created and each time the #fancyName(String) method is invoked, the meter will be marked.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      boolean absolute  
      String name  

    • Element Detail

      • name

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

      • absolute

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