Package io.micrometer.core.annotation

Annotation Type Timed

@Target({ANNOTATION_TYPE,TYPE,METHOD})
@Repeatable(TimedSet.class)
@Retention(RUNTIME)
@Inherited
public @interface Timed

  • Optional Element Summary

    Optional Elements
    Modifier and Type Optional Element Description
    java.lang.String description
    Description of the Timer.
    java.lang.String[] extraTags
    List of key-value pair arguments to supply the Timer as extra tags.
    boolean histogram
    Whether to enable recording of a percentile histogram for the Timer.
    boolean longTask
    Flag of whether the Timer should be a LongTaskTimer.
    double[] percentiles
    List of percentiles to calculate client-side for the Timer.
    java.lang.String value
    Name of the Timer metric.

  • Element Details

    • value

      java.lang.String value
      Name of the Timer metric.
      Returns:
      name of the Timer metric
      Default:
      ""

    • extraTags

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

    • longTask

      boolean longTask
      Flag of whether the Timer should be a LongTaskTimer.
      Returns:
      whether the timer is a LongTaskTimer
      Default:
      false

    • percentiles

      double[] percentiles
      List of percentiles to calculate client-side for the Timer. For example, the 95th percentile should be passed as 0.95.
      Returns:
      percentiles to calculate
      See Also:
      Timer.Builder.publishPercentiles(double...)
      Default:
      {}

    • histogram

      boolean histogram
      Whether to enable recording of a percentile histogram for the Timer.
      Returns:
      whether percentile histogram is enabled
      See Also:
      Timer.Builder.publishPercentileHistogram(Boolean)
      Default:
      false

    • description

      java.lang.String description
      Description of the Timer.
      Returns:
      meter description
      See Also:
      Timer.Builder.description(String)
      Default:
      ""