forked from open-telemetry/opentelemetry-java
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Instrument.java
71 lines (65 loc) · 1.99 KB
/
Instrument.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
/*
* Copyright 2019, OpenTelemetry Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.opentelemetry.metrics;
import io.opentelemetry.common.Labels;
import java.util.Collections;
import javax.annotation.concurrent.ThreadSafe;
/**
* Base interface for all metrics defined in this package.
*
* @since 0.1.0
*/
@ThreadSafe
@SuppressWarnings("InterfaceWithOnlyStatics")
public interface Instrument {
/** The {@code Builder} class for the {@code Instrument}. */
interface Builder {
/**
* Sets the description of the {@code Instrument}.
*
* <p>Default value is {@code ""}.
*
* @param description the description of the Instrument.
* @return this.
*/
Builder setDescription(String description);
/**
* Sets the unit of the {@code Instrument}.
*
* <p>Default value is {@code "1"}.
*
* @param unit the unit of the Instrument.
* @return this.
*/
Builder setUnit(String unit);
/**
* Sets the map of constant labels (they will be added to all the Bound Instruments) for the
* Instrument.
*
* <p>Default value is {@link Collections#emptyMap()}.
*
* @param constantLabels the map of constant labels for the Instrument.
* @return this.
*/
Builder setConstantLabels(Labels constantLabels);
/**
* Builds and returns a {@code Instrument} with the desired options.
*
* @return a {@code Instrument} with the desired options.
*/
Instrument build();
}
}