log/internal/flags.h

0001 // Copyright 2022 The Abseil Authors.
0002 //
0003 // Licensed under the Apache License, Version 2.0 (the "License");
0004 // you may not use this file except in compliance with the License.
0005 // You may obtain a copy of the License at
0006 //
0007 //      https://www.apache.org/licenses/LICENSE-2.0
0008 //
0009 // Unless required by applicable law or agreed to in writing, software
0010 // distributed under the License is distributed on an "AS IS" BASIS,
0011 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
0012 // See the License for the specific language governing permissions and
0013 // limitations under the License.
0014 //
0015 // -----------------------------------------------------------------------------
0016 // File: log/log_flags.h
0017 // -----------------------------------------------------------------------------
0018 //
0019 // This header declares set of flags which can be used to configure Abseil
0020 // Logging library behaviour at runtime.
0021
0022 #ifndef ABSL_LOG_INTERNAL_FLAGS_H_
0023 #define ABSL_LOG_INTERNAL_FLAGS_H_
0024
0025 #include <string>
0026
0027 #include "absl/flags/declare.h"
0028
0029 // !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
0030 // These flags should not be used in C++ code to access logging library
0031 // configuration knobs. Use interfaces defined in absl/log/globals.h
0032 // instead. It is still ok to use these flags on a command line.
0033 // !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
0034
0035 // Log messages at this severity or above are sent to stderr in *addition* to
0036 // `LogSink`s.  Defaults to `ERROR`.  See log_severity.h for numeric values of
0037 // severity levels.
0038 ABSL_DECLARE_FLAG(int, stderrthreshold);
0039
0040 // Log messages at this severity or above are logged; others are discarded.
0041 // Defaults to `INFO`, i.e. log all severities.  See log_severity.h for numeric
0042 // values of severity levels.
0043 ABSL_DECLARE_FLAG(int, minloglevel);
0044
0045 // If specified in the form file:linenum, any messages logged from a matching
0046 // location will also include a backtrace.
0047 ABSL_DECLARE_FLAG(std::string, log_backtrace_at);
0048
0049 // If true, the log prefix (severity, date, time, PID, etc.) is prepended to
0050 // each message logged. Defaults to true.
0051 ABSL_DECLARE_FLAG(bool, log_prefix);
0052
0053 // Global log verbosity level. Default is 0.
0054 ABSL_DECLARE_FLAG(int, v);
0055
0056 // Per-module log verbosity level. By default is empty and is unused.
0057 ABSL_DECLARE_FLAG(std::string, vmodule);
0058
0059 #endif  // ABSL_LOG_INTERNAL_FLAGS_H_