folly/experimental/logging/FileHandlerFactory.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  * FileHandlerFactory is a LogHandlerFactory that constructs log handlers
  24  * that write to a file.
  25  *
  26  * Note that FileHandlerFactory allows opening and appending to arbitrary files
  27  * based on the handler options.  This may make it unsafe to use
  28  * FileHandlerFactory in some contexts: for instance, a setuid binary should
  29  * generally avoid registering the FileHandlerFactory if they allow log
  30  * handlers to be configured via command line parameters, since otherwise this
  31  * may allow non-root users to append to files that they otherwise would not
  32  * have write permissions for.
  33  */
  34 class FileHandlerFactory : public LogHandlerFactory {
  35  public:
  36   StringPiece getType() const override {
  37     return "file";
  38   }
  39
  40   std::shared_ptr<LogHandler> createHandler(const Options& options) override;
  41
  42  private:
  43   class WriterFactory;
  44 };
  45
  46 } // namespace folly