forked from open-telemetry/opentelemetry-java
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathEndSpanOptions.java
92 lines (82 loc) · 2.3 KB
/
EndSpanOptions.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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
/*
* 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.trace;
import com.google.auto.value.AutoValue;
import javax.annotation.concurrent.Immutable;
/**
* A class that enables overriding the default values used when ending a {@link Span}. Allows
* overriding the endTimestamp.
*
* @since 0.1
*/
@Immutable
@AutoValue
public abstract class EndSpanOptions {
private static final EndSpanOptions DEFAULT = builder().build();
/**
* The default {@code EndSpanOptions}.
*
* @since 0.1
*/
static EndSpanOptions getDefault() {
return DEFAULT;
}
/**
* Returns a new {@link Builder} with default options.
*
* @return a new {@code Builder} with default options.
* @since 0.1
*/
public static Builder builder() {
return new AutoValue_EndSpanOptions.Builder().setEndTimestamp(0);
}
/**
* Returns the end timestamp.
*
* <p>Important this is NOT equivalent with System.nanoTime().
*
* @return the end timestamp.
* @since 0.1
*/
public abstract long getEndTimestamp();
/**
* Builder class for {@link EndSpanOptions}.
*
* @since 0.1
*/
@AutoValue.Builder
public abstract static class Builder {
/**
* Sets the end timestamp for the {@link Span}.
*
* <p>Important this is NOT equivalent with System.nanoTime().
*
* @param endTimestamp the end timestamp in nanos since epoch.
* @return this.
* @since 0.1
*/
public abstract Builder setEndTimestamp(long endTimestamp);
/**
* Builds and returns a {@code EndSpanOptions} with the desired settings.
*
* @return a {@code EndSpanOptions} with the desired settings.
* @since 0.1
*/
public abstract EndSpanOptions build();
Builder() {}
}
EndSpanOptions() {}
}