Package io.micrometer.core.annotation

Annotation Type Counted

@Inherited
@Target(METHOD)
@Retention(RUNTIME)
public @interface Counted
Annotated methods would expose a few counter metrics about their execution status. By default, both failed and successful attempts would be reported. Switching the recordFailuresOnly() to true would instruct the corresponding aspect to only record the failed attempts.

When the annotated method returns a CompletionStage or any of its subclasses, the counters will be incremented only when the CompletionStage is completed. If completed exceptionally a failure is recorded, otherwise if recordFailuresOnly() is set to false, a success is recorded.

Since:
1.2.0
See Also:
CountedAspect

  • Optional Element Summary

    Optional Elements
    Modifier and Type Optional Element Description
    java.lang.String description
    An optional description for what the underlying counter is going to record.
    java.lang.String[] extraTags
    List of key-value pair arguments to supply the Counter as extra tags.
    boolean recordFailuresOnly
    By default, both failed and successful attempts are recorded.
    java.lang.String value
    Represents the metric name for the to-be-recorded counters.

  • Element Details

    • value

      java.lang.String value
      Represents the metric name for the to-be-recorded counters.
      Returns:
      The metric name.
      Default:
      "method.counted"

    • recordFailuresOnly

      boolean recordFailuresOnly
      By default, both failed and successful attempts are recorded. Switch it to true in order to only record failed attempts.
      Returns:
      Whether to only report failures.
      Default:
      false

    • extraTags

      java.lang.String[] extraTags
      List of key-value pair arguments to supply the Counter as extra tags.
      Returns:
      key-value pair of tags
      Since:
      1.4.0
      See Also:
      Counter.Builder.tags(String...)
      Default:
      {}

    • description

      java.lang.String description
      An optional description for what the underlying counter is going to record.
      Returns:
      The counter description.
      Default:
      ""