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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
/*
* 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.trace.export;
import com.google.auto.value.AutoValue;
import io.opencensus.internal.Utils;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import javax.annotation.concurrent.Immutable;
import javax.annotation.concurrent.ThreadSafe;
/**
* This class allows users to access in-process information about all running spans.
*
* <p>The running spans tracking is available for all the spans with the option {@link
* io.opencensus.trace.Span.Options#RECORD_EVENTS}. This functionality allows users to debug stuck
* operations or long living operations.
*
* @since 0.5
*/
@ThreadSafe
public abstract class RunningSpanStore {
private static final RunningSpanStore NOOP_RUNNING_SPAN_STORE = new NoopRunningSpanStore();
protected RunningSpanStore() {}
/**
* Returns the no-op implementation of the {@code RunningSpanStore}.
*
* @return the no-op implementation of the {@code RunningSpanStore}.
*/
static RunningSpanStore getNoopRunningSpanStore() {
return NOOP_RUNNING_SPAN_STORE;
}
/**
* Returns the summary of all available data such, as number of running spans.
*
* @return the summary of all available data.
* @since 0.5
*/
public abstract Summary getSummary();
/**
* Returns a list of running spans that match the {@code Filter}.
*
* @param filter used to filter the returned spans.
* @return a list of running spans that match the {@code Filter}.
* @since 0.5
*/
public abstract Collection<SpanData> getRunningSpans(Filter filter);
/**
* The summary of all available data.
*
* @since 0.5
*/
@AutoValue
@Immutable
public abstract static class Summary {
Summary() {}
/**
* Returns a new instance of {@code Summary}.
*
* @param perSpanNameSummary a map with summary for each span name.
* @return a new instance of {@code Summary}.
* @throws NullPointerException if {@code perSpanNameSummary} is {@code null}.
* @since 0.5
*/
public static Summary create(Map<String, PerSpanNameSummary> perSpanNameSummary) {
return new AutoValue_RunningSpanStore_Summary(
Collections.unmodifiableMap(
new HashMap<String, PerSpanNameSummary>(
Utils.checkNotNull(perSpanNameSummary, "perSpanNameSummary"))));
}
/**
* Returns a map with summary of available data for each span name.
*
* @return a map with all the span names and the summary.
* @since 0.5
*/
public abstract Map<String, PerSpanNameSummary> getPerSpanNameSummary();
}
/**
* Summary of all available data for a span name.
*
* @since 0.5
*/
@AutoValue
@Immutable
public abstract static class PerSpanNameSummary {
PerSpanNameSummary() {}
/**
* Returns a new instance of {@code PerSpanNameSummary}.
*
* @param numRunningSpans the number of running spans.
* @return a new instance of {@code PerSpanNameSummary}.
* @throws IllegalArgumentException if {@code numRunningSpans} is negative.
* @since 0.5
*/
public static PerSpanNameSummary create(int numRunningSpans) {
Utils.checkArgument(numRunningSpans >= 0, "Negative numRunningSpans.");
return new AutoValue_RunningSpanStore_PerSpanNameSummary(numRunningSpans);
}
/**
* Returns the number of running spans.
*
* @return the number of running spans.
* @since 0.5
*/
public abstract int getNumRunningSpans();
}
/**
* Filter for running spans. Used to filter results returned by the {@link
* #getRunningSpans(Filter)} request.
*
* @since 0.5
*/
@AutoValue
@Immutable
public abstract static class Filter {
Filter() {}
/**
* Returns a new instance of {@code Filter}.
*
* <p>Filters all the spans based on {@code spanName} and returns a maximum of {@code
* maxSpansToReturn}.
*
* @param spanName the name of the span.
* @param maxSpansToReturn the maximum number of results to be returned. {@code 0} means all.
* @return a new instance of {@code Filter}.
* @throws NullPointerException if {@code spanName} is {@code null}.
* @throws IllegalArgumentException if {@code maxSpansToReturn} is negative.
* @since 0.5
*/
public static Filter create(String spanName, int maxSpansToReturn) {
Utils.checkArgument(maxSpansToReturn >= 0, "Negative maxSpansToReturn.");
return new AutoValue_RunningSpanStore_Filter(spanName, maxSpansToReturn);
}
/**
* Returns the span name.
*
* @return the span name.
* @since 0.5
*/
public abstract String getSpanName();
/**
* Returns the maximum number of spans to be returned. {@code 0} means all.
*
* @return the maximum number of spans to be returned.
* @since 0.5
*/
public abstract int getMaxSpansToReturn();
}
private static final class NoopRunningSpanStore extends RunningSpanStore {
private static final Summary EMPTY_SUMMARY =
Summary.create(Collections.<String, PerSpanNameSummary>emptyMap());
@Override
public Summary getSummary() {
return EMPTY_SUMMARY;
}
@Override
public Collection<SpanData> getRunningSpans(Filter filter) {
Utils.checkNotNull(filter, "filter");
return Collections.<SpanData>emptyList();
}
}
}
|
