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
|
/*
* Copyright 2018, 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.metrics;
import com.google.auto.value.AutoValue;
import io.opencensus.common.ExperimentalApi;
import io.opencensus.common.Timestamp;
import io.opencensus.internal.Utils;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
/**
* A collection of data points that describes the time-varying values of a {@code Metric}.
*
* @since 0.16
*/
@ExperimentalApi
@Immutable
@AutoValue
public abstract class TimeSeries {
TimeSeries() {}
/**
* Creates a {@link TimeSeries}.
*
* @param labelValues the {@code LabelValue}s that uniquely identify this {@code TimeSeries}.
* @param points the data {@code Point}s of this {@code TimeSeries}.
* @param startTimestamp the start {@code Timestamp} of this {@code TimeSeries}. Must be non-null
* for cumulative {@code Point}s.
* @return a {@code TimeSeries}.
* @since 0.16
*/
public static TimeSeries create(
List<LabelValue> labelValues, List<Point> points, @Nullable Timestamp startTimestamp) {
// Fail fast on null lists to prevent NullPointerException when copying the lists.
Utils.checkNotNull(labelValues, "labelValues");
Utils.checkNotNull(points, "points");
Utils.checkListElementNotNull(labelValues, "labelValue");
Utils.checkListElementNotNull(points, "point");
return new AutoValue_TimeSeries(
Collections.unmodifiableList(new ArrayList<LabelValue>(labelValues)),
Collections.unmodifiableList(new ArrayList<Point>(points)),
startTimestamp);
}
/**
* Returns the set of {@link LabelValue}s that uniquely identify this {@link TimeSeries}.
*
* <p>Apply to all {@link Point}s.
*
* <p>The order of {@link LabelValue}s must match that of {@link LabelKey}s in the {@code
* MetricDescriptor}.
*
* @return the {@code LabelValue}s.
* @since 0.16
*/
public abstract List<LabelValue> getLabelValues();
/**
* Returns the data {@link Point}s of this {@link TimeSeries}.
*
* @return the data {@code Point}s.
* @since 0.16
*/
public abstract List<Point> getPoints();
/**
* Returns the start {@link Timestamp} of this {@link TimeSeries} if the {@link Point}s are
* cumulative, or {@code null} if the {@link Point}s are gauge.
*
* @return the start {@code Timestamp} or {@code null}.
* @since 0.16
*/
@Nullable
public abstract Timestamp getStartTimestamp();
}
|
