-
-
Notifications
You must be signed in to change notification settings - Fork 468
Expand file tree
/
Copy pathISpan.java
More file actions
279 lines (240 loc) · 6.44 KB
/
ISpan.java
File metadata and controls
279 lines (240 loc) · 6.44 KB
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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
package io.sentry;
import io.sentry.protocol.Contexts;
import java.util.List;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
/** Represents performance monitoring Span. */
public interface ISpan {
/**
* Starts a child Span.
*
* @param operation - new span operation name
* @return a new transaction span
*/
@NotNull
ISpan startChild(@NotNull String operation);
@ApiStatus.Internal
@NotNull
ISpan startChild(
@NotNull String operation, @Nullable String description, @NotNull SpanOptions spanOptions);
@ApiStatus.Internal
@NotNull
ISpan startChild(@NotNull SpanContext spanContext, @NotNull SpanOptions spanOptions);
@ApiStatus.Internal
@NotNull
ISpan startChild(
@NotNull String operation,
@Nullable String description,
@Nullable SentryDate timestamp,
@NotNull Instrumenter instrumenter);
@ApiStatus.Internal
@NotNull
ISpan startChild(
@NotNull String operation,
@Nullable String description,
@Nullable SentryDate timestamp,
@NotNull Instrumenter instrumenter,
@NotNull SpanOptions spanOptions);
/**
* Starts a child Span.
*
* @param operation - new span operation name
* @param description - new span description name
* @return a new transaction span
*/
@NotNull
ISpan startChild(@NotNull String operation, @Nullable String description);
/**
* Returns the trace information that could be sent as a sentry-trace header.
*
* @return SentryTraceHeader.
*/
@NotNull
SentryTraceHeader toSentryTrace();
/**
* Returns the trace context.
*
* @return a trace context or {@code null} if {@link SentryOptions#isTraceSampling()} is disabled.
*/
@Nullable
@ApiStatus.Experimental
TraceContext traceContext();
/**
* Returns the baggage that can be sent as "baggage" header.
*
* @return BaggageHeader or {@code null} if {@link SentryOptions#isTraceSampling()} is disabled.
*/
@Nullable
@ApiStatus.Experimental
BaggageHeader toBaggageHeader(@Nullable List<String> thirdPartyBaggageHeaders);
/** Sets span timestamp marking this span as finished. */
void finish();
/**
* Sets span timestamp marking this span as finished.
*
* @param status - the status
*/
void finish(@Nullable SpanStatus status);
/**
* Sets span timestamp marking this span as finished.
*
* @param status - the status
* @param timestamp - the end timestamp
*/
void finish(@Nullable SpanStatus status, @Nullable SentryDate timestamp);
/**
* Sets span operation.
*
* @param operation - the operation
*/
void setOperation(@NotNull String operation);
/**
* Returns the span operation.
*
* @return the operation
*/
@NotNull
String getOperation();
/**
* Sets span description.
*
* @param description - the description.
*/
void setDescription(@Nullable String description);
/**
* Returns the span description.
*
* @return the description
*/
@Nullable
String getDescription();
/**
* Sets span status.
*
* @param status - the status.
*/
void setStatus(@Nullable SpanStatus status);
/**
* Returns the span status
*
* @return the status
*/
@Nullable
SpanStatus getStatus();
/**
* Sets the throwable that was thrown during the execution of the span.
*
* @param throwable - the throwable.
*/
void setThrowable(@Nullable Throwable throwable);
/**
* Gets the throwable that was thrown during the execution of the span.
*
* @return throwable or {@code null} if none
*/
@Nullable
Throwable getThrowable();
/**
* Gets the span context.
*
* @return the span context
*/
@NotNull
SpanContext getSpanContext();
/**
* Sets the tag on span or transaction.
*
* @param key the tag key
* @param value the tag value
*/
void setTag(@Nullable String key, @Nullable String value);
@Nullable
String getTag(@Nullable String key);
/**
* Returns if span has finished.
*
* @return if span has finished.
*/
boolean isFinished();
/**
* Sets extra data on span or transaction.
*
* @param key the data key
* @param value the data value
*/
void setData(@Nullable String key, @Nullable Object value);
/**
* Returns extra data from span or transaction.
*
* @return the data
*/
@Nullable
Object getData(@Nullable String key);
/**
* Set a measurement without unit. When setting the measurement without the unit, no formatting
* will be applied to the measurement value in the Sentry product, and the value will be shown as
* is.
*
* <p>NOTE: Setting a measurement with the same name on the same transaction multiple times only
* keeps the last value.
*
* @param name the name of the measurement
* @param value the value of the measurement
*/
void setMeasurement(@NotNull String name, @NotNull Number value);
/**
* Set a measurement with specific unit.
*
* <p>NOTE: Setting a measurement with the same name on the same transaction multiple times only
* keeps the last value.
*
* @param name the name of the measurement
* @param value the value of the measurement
* @param unit the unit the value is measured in
*/
void setMeasurement(@NotNull String name, @NotNull Number value, @NotNull MeasurementUnit unit);
/**
* Updates the end date of the span. Note: This will only update the end date if the span is
* already finished.
*
* @param date the end date to set
* @return true if the end date was updated, false otherwise
*/
@ApiStatus.Internal
boolean updateEndDate(@NotNull SentryDate date);
/**
* Returns the start date of this span or transaction.
*
* @return the start date
*/
@ApiStatus.Internal
@NotNull
SentryDate getStartDate();
/**
* Returns the end date of this span or transaction.
*
* @return the end date
*/
@ApiStatus.Internal
@Nullable
SentryDate getFinishDate();
/**
* Whether this span instance is a NOOP that doesn't collect information
*
* @return true if NOOP
*/
@ApiStatus.Internal
boolean isNoOp();
void setContext(@Nullable String key, @Nullable Object context);
@NotNull
Contexts getContexts();
@Nullable
Boolean isSampled();
@Nullable
TracesSamplingDecision getSamplingDecision();
@ApiStatus.Internal
@NotNull
ISentryLifecycleToken makeCurrent();
void addFeatureFlag(@Nullable String flag, @Nullable Boolean result);
}