Allow to configure the additional profile tasks to be included in the JSON profile
Closes #7217.
PiperOrigin-RevId: 238656293
diff --git a/src/main/java/com/google/devtools/build/lib/runtime/BlazeRuntime.java b/src/main/java/com/google/devtools/build/lib/runtime/BlazeRuntime.java
index fbef84c..9e9d1ae 100644
--- a/src/main/java/com/google/devtools/build/lib/runtime/BlazeRuntime.java
+++ b/src/main/java/com/google/devtools/build/lib/runtime/BlazeRuntime.java
@@ -18,6 +18,7 @@
import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
+import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Lists;
import com.google.common.eventbus.SubscriberExceptionContext;
import com.google.common.eventbus.SubscriberExceptionHandler;
@@ -46,7 +47,6 @@
import com.google.devtools.build.lib.profiler.ProfilePhase;
import com.google.devtools.build.lib.profiler.Profiler;
import com.google.devtools.build.lib.profiler.Profiler.Format;
-import com.google.devtools.build.lib.profiler.Profiler.ProfiledTaskKinds;
import com.google.devtools.build.lib.profiler.ProfilerTask;
import com.google.devtools.build.lib.profiler.SilentCloseable;
import com.google.devtools.build.lib.query2.AbstractBlazeQueryEnvironment;
@@ -279,7 +279,7 @@
long waitTimeInMs) {
OutputStream out = null;
boolean recordFullProfilerData = false;
- ProfiledTaskKinds profiledTasks = ProfiledTaskKinds.NONE;
+ ImmutableSet.Builder<ProfilerTask> profiledTasksBuilder = ImmutableSet.builder();
Profiler.Format format = Profiler.Format.BINARY_BAZEL_FORMAT;
Path profilePath = null;
try {
@@ -300,20 +300,37 @@
recordFullProfilerData = false;
out = profilePath.getOutputStream();
eventHandler.handle(Event.info("Writing tracer profile to '" + profilePath + "'"));
- profiledTasks = ProfiledTaskKinds.ALL_FOR_TRACE;
+ for (ProfilerTask profilerTask : ProfilerTask.values()) {
+ if (!profilerTask.isVfs()
+ // CRITICAL_PATH corresponds to writing the file.
+ && profilerTask != ProfilerTask.CRITICAL_PATH
+ && profilerTask != ProfilerTask.SKYFUNCTION
+ && profilerTask != ProfilerTask.ACTION_COMPLETE
+ && !profilerTask.isStarlark()) {
+ profiledTasksBuilder.add(profilerTask);
+ }
+ }
+ profiledTasksBuilder.addAll(options.additionalProfileTasks);
} else if (options.profilePath != null) {
profilePath = workspace.getWorkspace().getRelative(options.profilePath);
recordFullProfilerData = options.recordFullProfilerData;
out = profilePath.getOutputStream();
eventHandler.handle(Event.info("Writing profile data to '" + profilePath + "'"));
- profiledTasks = ProfiledTaskKinds.ALL;
+ for (ProfilerTask profilerTask : ProfilerTask.values()) {
+ profiledTasksBuilder.add(profilerTask);
+ }
} else if (options.alwaysProfileSlowOperations) {
recordFullProfilerData = false;
out = null;
- profiledTasks = ProfiledTaskKinds.SLOWEST;
+ for (ProfilerTask profilerTask : ProfilerTask.values()) {
+ if (profilerTask.collectsSlowestInstances()) {
+ profiledTasksBuilder.add(profilerTask);
+ }
+ }
}
- if (profiledTasks != ProfiledTaskKinds.NONE) {
+ ImmutableSet<ProfilerTask> profiledTasks = profiledTasksBuilder.build();
+ if (!profiledTasks.isEmpty()) {
Profiler profiler = Profiler.instance();
profiler.start(
profiledTasks,
diff --git a/src/main/java/com/google/devtools/build/lib/runtime/CommonCommandOptions.java b/src/main/java/com/google/devtools/build/lib/runtime/CommonCommandOptions.java
index 0a8fac9..9452400 100644
--- a/src/main/java/com/google/devtools/build/lib/runtime/CommonCommandOptions.java
+++ b/src/main/java/com/google/devtools/build/lib/runtime/CommonCommandOptions.java
@@ -16,11 +16,13 @@
import static com.google.common.base.Strings.isNullOrEmpty;
import com.google.devtools.build.lib.profiler.MemoryProfiler.MemoryProfileStableHeapParameters;
+import com.google.devtools.build.lib.profiler.ProfilerTask;
import com.google.devtools.build.lib.runtime.CommandLineEvent.ToolCommandLineEvent;
import com.google.devtools.build.lib.util.OptionsUtils;
import com.google.devtools.build.lib.vfs.PathFragment;
import com.google.devtools.common.options.Converter;
import com.google.devtools.common.options.Converters;
+import com.google.devtools.common.options.EnumConverter;
import com.google.devtools.common.options.Option;
import com.google.devtools.common.options.OptionDocumentationCategory;
import com.google.devtools.common.options.OptionEffectTag;
@@ -221,6 +223,16 @@
public boolean enableCpuUsageProfiling;
@Option(
+ name = "experimental_profile_additional_tasks",
+ converter = ProfilerTaskConverter.class,
+ defaultValue = "none",
+ allowMultiple = true,
+ documentationCategory = OptionDocumentationCategory.LOGGING,
+ effectTags = {OptionEffectTag.AFFECTS_OUTPUTS, OptionEffectTag.BAZEL_MONITORING},
+ help = "Specifies additional profile tasks to be included in the profile.")
+ public List<ProfilerTask> additionalProfileTasks;
+
+ @Option(
name = "profile",
defaultValue = "null",
documentationCategory = OptionDocumentationCategory.LOGGING,
@@ -416,4 +428,11 @@
+ "one."
)
public boolean keepStateAfterBuild;
+
+ /** The option converter to check that the user can only specify legal profiler tasks. */
+ public static class ProfilerTaskConverter extends EnumConverter<ProfilerTask> {
+ public ProfilerTaskConverter() {
+ super(ProfilerTask.class, "profiler task");
+ }
+ }
}
