| // Copyright 2018 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.metrics; |
| |
| import com.google.common.collect.ImmutableList; |
| import com.google.devtools.build.lib.runtime.BlazeModule; |
| import com.google.devtools.build.lib.runtime.CommandEnvironment; |
| 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.util.concurrent.atomic.AtomicInteger; |
| |
| /** |
| * A blaze module that installs metrics instrumentations and issues a {@link BuildMetricsEvent} at |
| * the end of the build. |
| */ |
| public class MetricsModule extends BlazeModule { |
| |
| /** Metrics options. */ |
| public static final class Options extends OptionsBase { |
| @Option( |
| name = "experimental_record_metrics_for_all_mnemonics", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.LOGGING, |
| effectTags = {OptionEffectTag.UNKNOWN}, |
| help = |
| "Controls the output of BEP ActionSummary and BuildGraphMetrics, limiting the number of" |
| + " mnemonics in ActionData and number of entries reported in" |
| + " BuildGraphMetrics.AspectCount/RuleClassCount. By default the number of types is" |
| + " limited to the top 20, by number of executed actions for ActionData, and" |
| + " instances for RuleClass and Asepcts. Setting this option will write statistics" |
| + " for all mnemonics, rule classes and aspects.") |
| public boolean recordMetricsForAllMnemonics; |
| |
| @Option( |
| name = "experimental_record_skyframe_metrics", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.LOGGING, |
| effectTags = {OptionEffectTag.UNKNOWN}, |
| help = |
| "Controls the output of BEP BuildGraphMetrics, including expensive" |
| + "to compute skyframe metrics about Skykeys, RuleClasses and Aspects." |
| + "With this flag set to false BuildGraphMetrics.rule_count and aspect" |
| + "fields will not be populated in the BEP.") |
| public boolean recordSkyframeMetrics; |
| } |
| |
| private final AtomicInteger numAnalyses = new AtomicInteger(); |
| private final AtomicInteger numBuilds = new AtomicInteger(); |
| |
| @Override |
| public Iterable<Class<? extends OptionsBase>> getCommonCommandOptions() { |
| return ImmutableList.of(Options.class); |
| } |
| |
| /** |
| * Informs the Blaze runtime that this module will post the BuildMetricsEvent and the runtime does |
| * not need to supply its own such module. |
| */ |
| @Override |
| public boolean postsBuildMetricsEvent() { |
| return true; |
| } |
| |
| @Override |
| public void beforeCommand(CommandEnvironment env) { |
| MetricsCollector.installInEnv(env, numAnalyses, numBuilds); |
| } |
| } |