folly/experimental/logging/LogCategoryConfig.h

   1 /*
   2  * Copyright 2004-present Facebook, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *   http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 #pragma once
  17
  18 #include <string>
  19 #include <vector>
  20
  21 #include <folly/Optional.h>
  22 #include <folly/experimental/logging/LogLevel.h>
  23
  24 namespace folly {
  25
  26 /**
  27  * Configuration for a LogCategory
  28  */
  29 class LogCategoryConfig {
  30  public:
  31   explicit LogCategoryConfig(
  32       LogLevel level = LogLevel::WARNING,
  33       bool inheritParentLevel = true);
  34   LogCategoryConfig(
  35       LogLevel level,
  36       bool inheritParentLevel,
  37       std::vector<std::string> handlers);
  38
  39   bool operator==(const LogCategoryConfig& other) const;
  40   bool operator!=(const LogCategoryConfig& other) const;
  41
  42   /**
  43    * The LogLevel for this category.
  44    */
  45   LogLevel level{LogLevel::WARNING};
  46
  47   /**
  48    * Whether this category should inherit its effective log level from its
  49    * parent category, if the parent category has a more verbose log level.
  50    */
  51   bool inheritParentLevel{true};
  52
  53   /**
  54    * An optional list of LogHandler names to use for this category.
  55    *
  56    * When applying config changes to an existing LogCategory, the existing
  57    * LogHandler list will be left unchanged if this field is unset.
  58    */
  59   Optional<std::vector<std::string>> handlers;
  60 };
  61
  62 } // namespace folly