LogConfigParser.h

Go to the documentation of this file.

/*
 * Copyright 2017-present Facebook, Inc.
 *
 * 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.
 */
#pragma once

#include <stdexcept>

#include <folly/CPortability.h>
#include <folly/Range.h>
#include <folly/logging/LogConfig.h>

/*
 * This file contains utility functions for parsing and serializing
 * LogConfig strings.
 *
 * This is separate from the LogConfig class itself, to reduce the dependencies
 * of the core logging library.  Other code that wants to use the logging
 * library to log messages but does not need to parse log config strings
 * therefore does not need to depend on the folly JSON library.
 */

namespace folly {

struct dynamic;

class FOLLY_EXPORT LogConfigParseError : public std::invalid_argument {
 public:
  using std::invalid_argument::invalid_argument;
};

LogConfig parseLogConfig(StringPiece value);

LogConfig parseLogConfigJson(StringPiece value);

LogConfig parseLogConfigDynamic(const dynamic& value);

dynamic logConfigToDynamic(const LogConfig& config);
dynamic logConfigToDynamic(const LogHandlerConfig& config);
dynamic logConfigToDynamic(const LogCategoryConfig& config);

} // namespace folly