blob: b0d9a4700f5895efe4356c79ce1734aff627713d (
plain)
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
|
/*
* 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;
import com.google.auto.value.AutoValue;
import io.opencensus.common.ExperimentalApi;
import java.util.Collection;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
/**
* A class that enables overriding the default values used when ending a {@link Span}. Allows
* overriding the {@link Status status}.
*
* @since 0.5
*/
@Immutable
@AutoValue
public abstract class EndSpanOptions {
/**
* The default {@code EndSpanOptions}.
*
* @since 0.5
*/
public static final EndSpanOptions DEFAULT = builder().build();
/**
* Returns a new {@link Builder} with default options.
*
* @return a new {@code Builder} with default options.
* @since 0.5
*/
public static Builder builder() {
return new AutoValue_EndSpanOptions.Builder().setSampleToLocalSpanStore(false);
}
/**
* If {@code true} this is equivalent with calling the {@link
* io.opencensus.trace.export.SampledSpanStore#registerSpanNamesForCollection(Collection)} in
* advance for this span name.
*
* <p>It is strongly recommended to use the {@link
* io.opencensus.trace.export.SampledSpanStore#registerSpanNamesForCollection(Collection)} API
* instead.
*
* @return {@code true} if the name of the {@code Span} should be registered to the {@code
* io.opencensus.trace.export.SampledSpanStore}.
* @since 0.8
*/
@ExperimentalApi
public abstract boolean getSampleToLocalSpanStore();
/**
* Returns the status.
*
* <p>If {@code null} then the {@link Span} will record the {@link Status} set via {@link
* Span#setStatus(Status)} or the default {@link Status#OK} if no status was set.
*
* @return the status.
* @since 0.5
*/
@Nullable
public abstract Status getStatus();
/**
* Builder class for {@link EndSpanOptions}.
*
* @since 0.5
*/
@AutoValue.Builder
public abstract static class Builder {
/**
* Sets the status for the {@link Span}.
*
* <p>If set, this will override the status set via {@link Span#setStatus(Status)}.
*
* @param status the status.
* @return this.
* @since 0.5
*/
public abstract Builder setStatus(Status status);
/**
* If set to {@code true} this is equivalent with calling the {@link
* io.opencensus.trace.export.SampledSpanStore#registerSpanNamesForCollection(Collection)} in
* advance for the given span name.
*
* <p>WARNING: setting this option to a randomly generated span name can OOM your process
* because the library will save samples for each name.
*
* <p>It is strongly recommended to use the {@link
* io.opencensus.trace.export.SampledSpanStore#registerSpanNamesForCollection(Collection)} API
* instead.
*
* @return this.
* @since 0.8
*/
@ExperimentalApi
public abstract Builder setSampleToLocalSpanStore(boolean sampleToLocalSpanStore);
/**
* Builds and returns a {@code EndSpanOptions} with the desired settings.
*
* @return a {@code EndSpanOptions} with the desired settings.
* @since 0.5
*/
public abstract EndSpanOptions build();
Builder() {}
}
EndSpanOptions() {}
}
|
