Package org.apache.bookkeeper.stats.annotations

Annotation Interface StatsDoc

@Retention(RUNTIME) @Documented public @interface StatsDoc
Documenting the stats.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    help
    The help message of this stats.
    String
    name
    The name of this stats.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    category
    The name of the category to group stats together.
    String
    happensAfter
    The metric name of an operation that happens after the operation of this metric.
    String
    parent
    The parent metric name.
    String
    scope
    The scope of this stats.

  • Element Details

    • name

      String name
      The name of this stats.
      Returns:
      name of this stats

    • help

      String help
      The help message of this stats.
      Returns:
      help message of this stats

    • category

      String category
      The name of the category to group stats together.
      Returns:
      name of the stats category.
      Default:
      ""

    • scope

      String scope
      The scope of this stats.
      Returns:
      scope of this stats
      Default:
      ""

    • parent

      String parent
      The parent metric name.

      It can used for analyzing the relationships between the metrics, especially for the latency metrics.

      Returns:
      the parent metric name
      Default:
      ""

    • happensAfter

      String happensAfter
      The metric name of an operation that happens after the operation of this metric.

      similar as parent(), it can be used for analyzing the dependencies between metrics.

      Returns:
      the metric name of an operation that happens after the operation of this metric.
      Default:
      ""