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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
/*
* Copyright 2017, OpenCensus 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.opencensus.stats;
import static com.google.common.base.Preconditions.checkArgument;
import com.google.auto.value.AutoValue;
import com.google.common.annotations.VisibleForTesting;
import io.opencensus.common.Function;
import io.opencensus.internal.CheckerFrameworkUtils;
import io.opencensus.internal.StringUtil;
import javax.annotation.concurrent.Immutable;
/** The definition of the {@link Measurement} that is taken by OpenCensus library. */
@Immutable
public abstract class Measure {
@VisibleForTesting static final int NAME_MAX_LENGTH = 255;
/** Applies the given match function to the underlying data type. */
public abstract <T> T match(
Function<? super MeasureDouble, T> p0,
Function<? super MeasureLong, T> p1,
Function<? super Measure, T> defaultFunction);
/**
* Name of measure, as a {@code String}. Should be a ASCII string with a length no greater than
* 255 characters.
*
* <p>Suggested format for name: {@code <web_host>/<path>}.
*/
public abstract String getName();
/** Detailed description of the measure, used in documentation. */
public abstract String getDescription();
/**
* The units in which {@link Measure} values are measured.
*
* <p>The suggested grammar for a unit is as follows:
*
* <ul>
* <li>Expression = Component { "." Component } {"/" Component };
* <li>Component = [ PREFIX ] UNIT [ Annotation ] | Annotation | "1";
* <li>Annotation = "{" NAME "}" ;
* </ul>
*
* <p>For example, string “MBy{transmitted}/ms” stands for megabytes per milliseconds, and the
* annotation transmitted inside {} is just a comment of the unit.
*/
// TODO(songya): determine whether we want to check the grammar on string unit.
public abstract String getUnit();
// Prevents this class from being subclassed anywhere else.
private Measure() {}
/** {@link Measure} with {@code Double} typed values. */
@Immutable
@AutoValue
// Suppress Checker Framework warning about missing @Nullable in generated equals method.
@AutoValue.CopyAnnotations
@SuppressWarnings("nullness")
public abstract static class MeasureDouble extends Measure {
MeasureDouble() {}
/**
* Constructs a new {@link MeasureDouble}.
*
* @param name name of {@code Measure}. Suggested format: {@code <web_host>/<path>}.
* @param description description of {@code Measure}.
* @param unit unit of {@code Measure}.
* @return a {@code MeasureDouble}.
*/
public static MeasureDouble create(String name, String description, String unit) {
checkArgument(
StringUtil.isPrintableString(name) && name.length() <= NAME_MAX_LENGTH,
"Name should be a ASCII string with a length no greater than "
+ NAME_MAX_LENGTH
+ " characters.");
return new AutoValue_Measure_MeasureDouble(name, description, unit);
}
@Override
public <T> T match(
Function<? super MeasureDouble, T> p0,
Function<? super MeasureLong, T> p1,
Function<? super Measure, T> defaultFunction) {
return CheckerFrameworkUtils.<MeasureDouble, T>removeSuperFromFunctionParameterType(p0)
.apply(this);
}
@Override
public abstract String getName();
@Override
public abstract String getDescription();
@Override
public abstract String getUnit();
}
/** {@link Measure} with {@code Long} typed values. */
@Immutable
@AutoValue
// Suppress Checker Framework warning about missing @Nullable in generated equals method.
@AutoValue.CopyAnnotations
@SuppressWarnings("nullness")
public abstract static class MeasureLong extends Measure {
MeasureLong() {}
/**
* Constructs a new {@link MeasureLong}.
*
* @param name name of {@code Measure}. Suggested format: {@code <web_host>/<path>}.
* @param description description of {@code Measure}.
* @param unit unit of {@code Measure}.
* @return a {@code MeasureLong}.
*/
public static MeasureLong create(String name, String description, String unit) {
checkArgument(
StringUtil.isPrintableString(name) && name.length() <= NAME_MAX_LENGTH,
"Name should be a ASCII string with a length no greater than "
+ NAME_MAX_LENGTH
+ " characters.");
return new AutoValue_Measure_MeasureLong(name, description, unit);
}
@Override
public <T> T match(
Function<? super MeasureDouble, T> p0,
Function<? super MeasureLong, T> p1,
Function<? super Measure, T> defaultFunction) {
return CheckerFrameworkUtils.<MeasureLong, T>removeSuperFromFunctionParameterType(p1)
.apply(this);
}
@Override
public abstract String getName();
@Override
public abstract String getDescription();
@Override
public abstract String getUnit();
}
}
|
