mirror of https://github.com/grpc/grpc.git
[experiments] Single experiments flag (#30822)
* single experiments flag * add missing files * fix * empty-string-fix * fix * Automated change: Fix sanity tests * ensure cold path is out of line * add log for enabled/disabled experiments * remove bad sentence * Automated change: Fix sanity tests Co-authored-by: ctiller <ctiller@users.noreply.github.com>pull/30837/head
Craig Tiller
3 years ago
committed by
GitHub
parent
c3c4159d24
commit
ca8b437613
22 changed files with 210 additions and 68 deletions
@ -0,0 +1,115 @@ |
||||
// Copyright 2022 gRPC 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.
|
||||
|
||||
#include <grpc/support/port_platform.h> |
||||
|
||||
#include "src/core/lib/experiments/config.h" |
||||
|
||||
#include <string.h> |
||||
|
||||
#include <algorithm> |
||||
#include <memory> |
||||
#include <string> |
||||
|
||||
#include "absl/strings/ascii.h" |
||||
#include "absl/strings/str_cat.h" |
||||
#include "absl/strings/str_split.h" |
||||
#include "absl/strings/string_view.h" |
||||
|
||||
#include <grpc/support/log.h> |
||||
|
||||
#include "src/core/lib/experiments/experiments.h" |
||||
#include "src/core/lib/gprpp/global_config.h" |
||||
#include "src/core/lib/gprpp/no_destruct.h" |
||||
|
||||
GPR_GLOBAL_CONFIG_DEFINE_STRING( |
||||
grpc_experiments, "", |
||||
"List of grpc experiments to enable (or with a '-' prefix to disable)."); |
||||
|
||||
namespace grpc_core { |
||||
|
||||
namespace { |
||||
struct Experiments { |
||||
bool enabled[kNumExperiments]; |
||||
}; |
||||
|
||||
GPR_ATTRIBUTE_NOINLINE Experiments LoadExperimentsFromConfigVariable() { |
||||
// Set defaults from metadata.
|
||||
Experiments experiments; |
||||
for (size_t i = 0; i < kNumExperiments; i++) { |
||||
experiments.enabled[i] = g_experiment_metadata[i].default_value; |
||||
} |
||||
// Get the global config.
|
||||
auto experiments_str = GPR_GLOBAL_CONFIG_GET(grpc_experiments); |
||||
// For each comma-separated experiment in the global config:
|
||||
for (auto experiment : |
||||
absl::StrSplit(absl::string_view(experiments_str.get()), ',')) { |
||||
// Strip whitespace.
|
||||
experiment = absl::StripAsciiWhitespace(experiment); |
||||
// Handle ",," without crashing.
|
||||
if (experiment.empty()) continue; |
||||
// Enable unless prefixed with '-' (=> disable).
|
||||
bool enable = true; |
||||
if (experiment[0] == '-') { |
||||
enable = false; |
||||
experiment.remove_prefix(1); |
||||
} |
||||
// See if we can find the experiment in the list in this binary.
|
||||
bool found = false; |
||||
for (size_t i = 0; i < kNumExperiments; i++) { |
||||
if (experiment == g_experiment_metadata[i].name) { |
||||
experiments.enabled[i] = enable; |
||||
found = true; |
||||
break; |
||||
} |
||||
} |
||||
// If not found log an error, but don't take any other action.
|
||||
// Allows us an easy path to disabling experiments.
|
||||
if (!found) { |
||||
gpr_log(GPR_ERROR, "Unknown experiment: %s", |
||||
std::string(experiment).c_str()); |
||||
} |
||||
} |
||||
return experiments; |
||||
} |
||||
} // namespace
|
||||
|
||||
bool IsExperimentEnabled(size_t experiment_id) { |
||||
// One time initialization:
|
||||
static const NoDestruct<Experiments> experiments{ |
||||
LoadExperimentsFromConfigVariable()}; |
||||
// Normal path: just return the value;
|
||||
return experiments->enabled[experiment_id]; |
||||
} |
||||
|
||||
void PrintExperimentsList() { |
||||
size_t max_experiment_length = 0; |
||||
for (size_t i = 0; i < kNumExperiments; i++) { |
||||
max_experiment_length = |
||||
std::max(max_experiment_length, strlen(g_experiment_metadata[i].name)); |
||||
} |
||||
for (size_t i = 0; i < kNumExperiments; i++) { |
||||
gpr_log( |
||||
GPR_DEBUG, "%s", |
||||
absl::StrCat("gRPC EXPERIMENT ", g_experiment_metadata[i].name, |
||||
std::string(max_experiment_length - |
||||
strlen(g_experiment_metadata[i].name) + 1, |
||||
' '), |
||||
IsExperimentEnabled(i) ? "ON " : "OFF", " (default:", |
||||
g_experiment_metadata->default_value ? "ON" : "OFF", ")") |
||||
.c_str()); |
||||
} |
||||
} |
||||
|
||||
} // namespace grpc_core
|
||||
@ -0,0 +1,34 @@ |
||||
// Copyright 2022 gRPC 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.
|
||||
|
||||
#ifndef GRPC_CORE_LIB_EXPERIMENTS_CONFIG_H |
||||
#define GRPC_CORE_LIB_EXPERIMENTS_CONFIG_H |
||||
|
||||
#include <grpc/support/port_platform.h> |
||||
|
||||
#include <stddef.h> |
||||
|
||||
namespace grpc_core { |
||||
|
||||
// Return true if experiment \a experiment_id is enabled.
|
||||
// Experiments are numbered by their order in the g_experiment_metadata array
|
||||
// declared in experiments.h.
|
||||
bool IsExperimentEnabled(size_t experiment_id); |
||||
|
||||
// Print out a list of all experiments that are built into this binary.
|
||||
void PrintExperimentsList(); |
||||
|
||||
} // namespace grpc_core
|
||||
|
||||
#endif // GRPC_CORE_LIB_EXPERIMENTS_CONFIG_H
|
||||
Loading…
Reference in new issue