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
|
// Copyright 2017 The Bazel Authors. All rights reserved.
//
// 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 com.google.devtools.build.lib.buildeventservice;
import com.google.devtools.common.options.Converters;
import com.google.devtools.common.options.Option;
import com.google.devtools.common.options.OptionDocumentationCategory;
import com.google.devtools.common.options.OptionEffectTag;
import com.google.devtools.common.options.OptionsBase;
import java.time.Duration;
import java.util.List;
/** Options used by {@link BuildEventServiceModule}. */
public class BuildEventServiceOptions extends OptionsBase {
@Option(
name = "bes_backend",
defaultValue = "",
documentationCategory = OptionDocumentationCategory.LOGGING,
effectTags = {OptionEffectTag.AFFECTS_OUTPUTS},
help =
"Specifies the build event service (BES) backend endpoint as HOST or HOST:PORT. "
+ "Disabled by default."
)
public String besBackend;
@Option(
name = "bes_timeout",
defaultValue = "0s",
documentationCategory = OptionDocumentationCategory.LOGGING,
effectTags = {OptionEffectTag.AFFECTS_OUTPUTS},
help =
"Specifies how long bazel should wait for the BES/BEP upload to complete after the "
+ "build and tests have finished. A valid timeout is a natural number followed by a "
+ "unit: Days (d), hours (h), minutes (m), seconds (s), and milliseconds (ms). The "
+ "default value is '0' which means that there is no timeout and that the upload will "
+ "continue in the background after a build has finished."
)
public Duration besTimeout;
@Option(
name = "bes_best_effort",
defaultValue = "false",
deprecationWarning =
"BES best effort upload has been removed. The flag has no more "
+ "functionality attached to it and will be removed in a future release.",
documentationCategory = OptionDocumentationCategory.LOGGING,
effectTags = {OptionEffectTag.AFFECTS_OUTPUTS},
help =
"BES best effort upload has been removed. The flag has no more "
+ "functionality attached to it and will be removed in a future release.")
public boolean besBestEffort;
@Option(
name = "bes_lifecycle_events",
defaultValue = "true",
documentationCategory = OptionDocumentationCategory.LOGGING,
effectTags = {OptionEffectTag.AFFECTS_OUTPUTS},
help = "Specifies whether to publish BES lifecycle events. (defaults to 'true')."
)
public boolean besLifecycleEvents;
@Option(
name = "project_id",
defaultValue = "null",
documentationCategory = OptionDocumentationCategory.LOGGING,
effectTags = {OptionEffectTag.AFFECTS_OUTPUTS},
help = "Specifies the BES project identifier. Defaults to null."
)
public String projectId;
@Option(
name = "bes_keywords",
defaultValue = "",
converter = Converters.CommaSeparatedOptionListConverter.class,
documentationCategory = OptionDocumentationCategory.LOGGING,
effectTags = {OptionEffectTag.AFFECTS_OUTPUTS},
allowMultiple = true,
help =
"Specifies a list of notification keywords to be added the default set of keywords "
+ "published to BES (\"command_name=<command_name> \", \"protocol_name=BEP\"). "
+ "Defaults to none."
)
public List<String> besKeywords;
@Option(
name = "bes_outerr_buffer_size",
defaultValue = "10240",
documentationCategory = OptionDocumentationCategory.LOGGING,
effectTags = {OptionEffectTag.AFFECTS_OUTPUTS},
help =
"Specifies the maximal size of stdout or stderr to be buffered in BEP, before it is "
+ "reported as a progress event. Individual writes are still reported in a single "
+ "event, even if larger than the specified value."
)
public long besOuterrBufferSize;
@Option(
name = "bes_results_url",
defaultValue = "",
documentationCategory = OptionDocumentationCategory.LOGGING,
effectTags = {OptionEffectTag.TERMINAL_OUTPUT},
help =
"Specifies the base URL where a user can view the information streamed to the BES"
+ " backend. Bazel will output the URL appended by the invocation id to the"
+ " terminal.")
public String besResultsUrl;
}
|
