StatsDoc (BookKeeper Java API (version 4.15.0-SNAPSHOT))

@Retention(RUNTIME)
@Documented
public @interface StatsDoc

Documenting the stats.

Required Element Summary

Required Elements
Modifier and Type Required Element Description

java.lang.String help
The help message of this stats.

java.lang.String name
The name of this stats.

Optional Element Summary

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

- Element Detail
  - name
```
java.lang.String name
```
    The name of this stats.
    
    Returns:
    
    name of this stats
- - help
```
java.lang.String help
```
    The help message of this stats.
    
    Returns:
    
    help message of this stats
- - category
```
java.lang.String category
```
    The name of the category to group stats together.
    
    Returns:
    
    name of the stats category.
    
    Default:
    
    ""
- - scope
```
java.lang.String scope
```
    The scope of this stats.
    
    Returns:
    
    scope of this stats
    
    Default:
    
    ""
- - parent
```
java.lang.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
```
java.lang.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:
    
    ""