@Value.Immutable public abstract class MetricDescriptor extends Object
MetricProvider
Constructor and Description |
---|
MetricDescriptor() |
Modifier and Type | Method and Description |
---|---|
abstract Object |
anchor()
Instance of the class "containing" this Metric.
|
static ImmutableMetricDescriptor.AnchorBuildStage |
builder() |
protected void |
check() |
String |
description()
Human readable description of the Metric.
|
abstract String |
id()
|
abstract String |
module()
Name of OpenDaylight module the Metric is for, unique within given
project() . |
abstract String |
project()
Name of OpenDaylight project the Metric is for, unique at opendaylight.org.
|
public static ImmutableMetricDescriptor.AnchorBuildStage builder()
public abstract Object anchor()
public abstract String project()
[a-z0-9]+
(lower case and no dots nor underscores).public abstract String module()
project()
.
E.g. "vpnmanager" or "lockmanager" or "jobcoordinator" etc.
The project/module/id together must be unique within ODL.
Valid values match [a-z0-9]+
(lower case and no dots nor underscores).public abstract String id()
project()
+ module()
.
E.g. "jobsPending" or "dropped_packets" or "traffic" etc. The
project/module/id together must be unique within ODL. Valid values match
[a-zA-Z0-9_]+
(lower and upper case and underscore allowed, but
not starting with). The dot character is not allowed here because at least
one of the implementations (Prometheus.io) does not accept dots in its IDs.@Value.Default public String description()
@Value.Check protected void check()
Copyright © 2019 OpenDaylight. All rights reserved.