Annotation Interface ExceptionMetered


@Retention(RUNTIME) @Target(METHOD) public @interface ExceptionMetered
An annotation for marking a method of an annotated object as metered.

Given a method like this:


     @ExceptionMetered(name = "fancyName", cause=IllegalArgumentException.class)
     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) throws an exception of type cause (or a subclass), the meter will be marked.

A name for the metric can be specified as an annotation parameter, otherwise, the metric will be named based on the method name.

For instance, given a declaration of


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

A meter named fancyName.exceptions will be created and marked every time an exception is thrown.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    If true, use the given name as an absolute name.
    Class<? extends Throwable>
    The type of exceptions that the meter will catch and count.
    The name of the meter.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    The default suffix for meter names.
  • Field Details

  • Element Details

    • name

      String name
      The name of the meter. If not specified, the meter will be given a name based on the method it decorates and the suffix "Exceptions".
      Default:
      ""
    • absolute

      boolean absolute
      If true, use the given name as an absolute name. If false, use the given name relative to the annotated class.
      Default:
      false
    • cause

      Class<? extends Throwable> cause
      The type of exceptions that the meter will catch and count.
      Default:
      java.lang.Exception.class