Skip to content

Commit 60523c7

Browse files
Googlercopybara-github
authored andcommitted
Collect local actions metrics by default.
Set `experimental_collect_local_sandbox_action_metrics` and `experimental_collect_local_action_metrics` true by default. PiperOrigin-RevId: 472947485 Change-Id: Id1253bc35066e003d5005d6a8abf072759af452d
1 parent 4ce63be commit 60523c7

File tree

6 files changed

+24
-19
lines changed

6 files changed

+24
-19
lines changed

src/main/java/com/google/devtools/build/lib/exec/local/LocalExecutionOptions.java

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -50,14 +50,13 @@ public class LocalExecutionOptions extends OptionsBase {
5050
public RegexPatternOption allowedLocalAction;
5151

5252
@Option(
53-
name = "experimental_collect_local_action_metrics",
54-
defaultValue = "false",
55-
documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
56-
effectTags = {OptionEffectTag.EXECUTION},
57-
help =
58-
"When enabled, execution statistics (such as user and system time) are recorded for "
59-
+ "locally executed actions which don't use sandboxing"
60-
)
53+
name = "experimental_collect_local_action_metrics",
54+
defaultValue = "true",
55+
documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
56+
effectTags = {OptionEffectTag.EXECUTION},
57+
help =
58+
"When enabled, execution statistics (such as user and system time) are recorded for "
59+
+ "locally executed actions which don't use sandboxing")
6160
public boolean collectLocalExecutionStatistics;
6261

6362
@Option(

src/main/java/com/google/devtools/build/lib/sandbox/SandboxOptions.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ public ImmutableSet<Path> getInaccessiblePaths(FileSystem fs) {
247247

248248
@Option(
249249
name = "experimental_collect_local_sandbox_action_metrics",
250-
defaultValue = "false",
250+
defaultValue = "true",
251251
documentationCategory = OptionDocumentationCategory.LOGGING,
252252
effectTags = {OptionEffectTag.EXECUTION},
253253
help =

src/test/java/com/google/devtools/build/lib/exec/local/LocalSpawnRunnerTest.java

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -382,6 +382,7 @@ public void vanillaZeroExit() throws Exception {
382382

383383
LocalExecutionOptions options = Options.getDefaults(LocalExecutionOptions.class);
384384
options.localSigkillGraceSeconds = 456;
385+
options.collectLocalExecutionStatistics = false;
385386
LocalSpawnRunner runner =
386387
new TestedLocalSpawnRunner(
387388
fs.getPath("/execroot"),
@@ -433,6 +434,7 @@ public void testParamFiles() throws Exception {
433434

434435
LocalExecutionOptions options = Options.getDefaults(LocalExecutionOptions.class);
435436
options.localSigkillGraceSeconds = 456;
437+
options.collectLocalExecutionStatistics = false;
436438
Path execRoot = fs.getPath("/execroot");
437439
LocalSpawnRunner runner =
438440
new TestedLocalSpawnRunner(
@@ -478,6 +480,7 @@ public void exec_materializesVirtualInputAsExecutable() throws Exception {
478480
SubprocessBuilder.setDefaultSubprocessFactory(factory);
479481
Path execRoot = fs.getPath("/execroot");
480482
LocalExecutionOptions options = Options.getDefaults(LocalExecutionOptions.class);
483+
options.collectLocalExecutionStatistics = false;
481484
LocalSpawnRunner runner =
482485
new TestedLocalSpawnRunner(
483486
execRoot,
@@ -559,6 +562,7 @@ public void nonZeroExit() throws Exception {
559562
SubprocessBuilder.setDefaultSubprocessFactory(factory);
560563

561564
LocalExecutionOptions options = Options.getDefaults(LocalExecutionOptions.class);
565+
options.collectLocalExecutionStatistics = false;
562566
LocalSpawnRunner runner =
563567
new TestedLocalSpawnRunner(
564568
fs.getPath("/execroot"),
@@ -793,6 +797,7 @@ public void checkPrefetchCalled() throws Exception {
793797
SubprocessBuilder.setDefaultSubprocessFactory(factory);
794798

795799
LocalExecutionOptions options = Options.getDefaults(LocalExecutionOptions.class);
800+
options.collectLocalExecutionStatistics = false;
796801
LocalSpawnRunner runner =
797802
new TestedLocalSpawnRunner(
798803
fs.getPath("/execroot"),
@@ -818,6 +823,7 @@ public void checkNoPrefetchCalled() throws Exception {
818823
SubprocessBuilder.setDefaultSubprocessFactory(factory);
819824

820825
LocalExecutionOptions options = Options.getDefaults(LocalExecutionOptions.class);
826+
options.collectLocalExecutionStatistics = false;
821827
LocalSpawnRunner runner =
822828
new TestedLocalSpawnRunner(
823829
fs.getPath("/execroot"),
@@ -849,6 +855,7 @@ public void checkLocalEnvProviderCalled() throws Exception {
849855
LocalEnvProvider localEnvProvider = mock(LocalEnvProvider.class);
850856

851857
LocalExecutionOptions options = Options.getDefaults(LocalExecutionOptions.class);
858+
options.collectLocalExecutionStatistics = false;
852859
LocalSpawnRunner runner =
853860
new TestedLocalSpawnRunner(
854861
fs.getPath("/execroot"),

src/test/java/com/google/devtools/build/lib/sandbox/LinuxSandboxedSpawnRunnerTest.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -129,8 +129,7 @@ public void execAsync_spawnRunningBinTool_executesSuccessfully() throws Exceptio
129129

130130
@Test
131131
public void execAsync_collectsExecutionStatistics() throws Exception {
132-
CommandEnvironment commandEnvironment =
133-
getCommandEnvironmentWithExecutionStatisticsOptionEnabled("workspace");
132+
CommandEnvironment commandEnvironment = createCommandEnvironment();
134133
LinuxSandboxedSpawnRunner runner = setupSandboxAndCreateRunner(commandEnvironment);
135134
Path cpuTimeSpenderPath =
136135
SpawnRunnerTestUtil.copyCpuTimeSpenderIntoPath(commandEnvironment.getExecRoot());
@@ -170,7 +169,8 @@ public void execAsync_collectsExecutionStatistics() throws Exception {
170169

171170
@Test
172171
public void execAsync_statisticsCollectionDisabled_returnsEmptyStatistics() throws Exception {
173-
CommandEnvironment commandEnvironment = createCommandEnvironment();
172+
CommandEnvironment commandEnvironment =
173+
getCommandEnvironmentWithExecutionStatisticsOptionDisabled("workspace");
174174
LinuxSandboxedSpawnRunner runner = setupSandboxAndCreateRunner(commandEnvironment);
175175
Path cpuTimeSpenderPath =
176176
SpawnRunnerTestUtil.copyCpuTimeSpenderIntoPath(commandEnvironment.getExecRoot());

src/test/java/com/google/devtools/build/lib/sandbox/ProcessWrapperSandboxedSpawnRunnerTest.java

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -99,9 +99,8 @@ public void hasExecutionStatistics_whenOptionIsEnabled() throws Exception {
9999
Duration minimumSystemTimeToSpend = Duration.ZERO;
100100
Duration maximumSystemTimeToSpend = minimumSystemTimeToSpend.plus(Duration.ofSeconds(2));
101101

102-
CommandEnvironment commandEnvironment =
103-
getCommandEnvironmentWithExecutionStatisticsOptionEnabled("workspace");
104-
102+
CommandEnvironment commandEnvironment = runtimeWrapper.newCommand();
103+
commandEnvironment.setWorkspaceName("workspace");
105104
Path execRoot = commandEnvironment.getExecRoot();
106105
execRoot.createDirectory();
107106

@@ -167,8 +166,8 @@ public void hasNoExecutionStatistics_whenOptionIsDisabled() throws Exception {
167166
Duration minimumUserTimeToSpend = minimumWallTimeToSpend;
168167
Duration minimumSystemTimeToSpend = Duration.ZERO;
169168

170-
CommandEnvironment commandEnvironment = runtimeWrapper.newCommand();
171-
commandEnvironment.setWorkspaceName("workspace");
169+
CommandEnvironment commandEnvironment =
170+
getCommandEnvironmentWithExecutionStatisticsOptionDisabled("workspace");
172171
commandEnvironment
173172
.getLocalResourceManager()
174173
.setAvailableResources(LocalHostCapacity.getLocalHostCapacity());

src/test/java/com/google/devtools/build/lib/sandbox/SandboxedSpawnRunnerTestCase.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,9 @@ protected void setupMockTools() throws IOException {
3838
* Returns a command environment with local execution statistics enabled and the given workspace
3939
* name set.
4040
*/
41-
protected CommandEnvironment getCommandEnvironmentWithExecutionStatisticsOptionEnabled(
41+
protected CommandEnvironment getCommandEnvironmentWithExecutionStatisticsOptionDisabled(
4242
String workspaceName) throws Exception {
43-
runtimeWrapper.addOptions("--experimental_collect_local_sandbox_action_metrics");
43+
runtimeWrapper.addOptions("--noexperimental_collect_local_sandbox_action_metrics");
4444
CommandEnvironment env = runtimeWrapper.newCommand();
4545
env.setWorkspaceName(workspaceName);
4646
env.getLocalResourceManager().setAvailableResources(LocalHostCapacity.getLocalHostCapacity());

0 commit comments

Comments
 (0)