folly/experimental/logging/StreamHandlerFactory.h

   1 /*
   2  * Copyright 2017-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 <folly/experimental/logging/LogHandlerFactory.h>
  19
  20 namespace folly {
  21
  22 /**
  23  * StreamHandlerFactory is a LogHandlerFactory that constructs log handlers
  24  * that write to stdout or stderr.
  25  *
  26  * This is quite similar to FileHandlerFactory, but it always writes to an
  27  * existing open file descriptor rather than opening a new file.  This handler
  28  * factory is separate from FileHandlerFactory primarily for safety reasons:
  29  * FileHandlerFactory supports appending to arbitrary files via config
  30  * parameters, while StreamHandlerFactory does not.
  31  */
  32 class StreamHandlerFactory : public LogHandlerFactory {
  33  public:
  34   StringPiece getType() const override {
  35     return "stream";
  36   }
  37
  38   std::shared_ptr<LogHandler> createHandler(const Options& options) override;
  39
  40  private:
  41   class WriterFactory;
  42 };
  43
  44 } // namespace folly