FileLogDestination.hpp

/*
 * FileLogDestination.hpp
 * 
 * Copyright (C) 2022 by RStudio, PBC
 *
 * Unless you have received this program directly from RStudio pursuant to the terms of a commercial license agreement
 * with RStudio, then this program is licensed to you under the following terms:
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
 * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 */
 
#ifndef LAUNCHER_PLUGINS_FILE_LOG_DESTINATION_HPP
#define LAUNCHER_PLUGINS_FILE_LOG_DESTINATION_HPP
 
#include <logging/ILogDestination.hpp>
 
#include <string>
 
#include <PImpl.hpp>
#include <system/FilePath.hpp>
 
namespace rstudio {
namespace launcher_plugins {
namespace logging {
 
class FileLogOptions
{
public:
   FileLogOptions(system::FilePath in_directory);
 
   FileLogOptions(system::FilePath in_directory,
                  bool in_warnSyslog);
 
   FileLogOptions(
      system::FilePath in_directory,
      std::string in_fileMode,
      double in_maxSizeMb,
      int in_rotationDays,
      int in_maxRotations,
      int in_deletionDays,
      bool in_doRotation,
      bool in_includePid,
      bool in_warnSyslog,
      bool in_forceLogDirectory);
 
   int getDeletionDays() const;
 
   const system::FilePath& getDirectory() const;
 
   const std::string& getFileMode() const;
 
   bool getForceDirectory() const;
 
   int getMaxRotations() const;
 
   double getMaxSizeMb() const;
 
   int getRotationDays() const;
 
   bool doRotation() const;
 
   bool includePid() const;
 
   bool warnSyslog() const;
 
   void setDeletionDays(int in_deletionDays);
 
   void setDirectory(const system::FilePath& in_directory);
 
   void setFileMode(const std::string& in_fileMode);
 
   void setForceDirectory(bool in_forceDirectory);
 
   void setMaxRotations(int in_maxRotations);
 
   void setMaxSizeMb(double in_maxSizeMb);
 
   void setRotationDays(int in_rotationDays);
 
   void setDoRotation(bool in_doRotation);
 
   void setIncludePid(bool in_includePid);
 
   void setWarnSyslog(bool in_warnSyslog);
 
private:
   // Default values.
   static constexpr const char* s_defaultFileMode = "600";
   static constexpr int s_defaultMaxSizeMb = 2;
   static constexpr int s_defaultRotationDays = 1;
   static constexpr int s_defaultMaxRotations = 100;
   static constexpr int s_defaultDeletionDays = 30;
   static constexpr bool s_defaultDoRotation = true;
   static constexpr bool s_defaultIncludePid = false;
   static constexpr bool s_defaultWarnSyslog = true;
   static constexpr bool s_defaultForceDirectory = false;
 
   // The directory where log files should be written.
   system::FilePath m_directory;
 
   // The permissions to set on log files.
   std::string m_fileMode;
 
   // The maximum size of log files, in MB.
   double m_maxSizeMb;
 
   // The number of days a log file should persist before being rotated.
   int m_rotationDays;
 
   // The maximum number of rotated log files that are allowed to exist.
   int m_maxRotations;
 
   // The number of days a log file should persist before being deleted.
   int m_deletionDays;
 
   // Whether to rotate log files or not.
   bool m_doRotation;
 
   // Whether to include the PID in logs.
   bool m_includePid;
 
   // Whether to also send warn/error logs to syslog for admin visibility.
   bool m_warnSyslog;
 
   // Whether or not to force the directory to prevent user override.
   bool m_forceDirectory;
};
 
class FileLogDestination : public ILogDestination
{
public:
   FileLogDestination(
      const std::string& in_id,
      LogLevel in_logLevel,
      LogMessageFormatType in_formatType,
      const std::string& in_programId,
      FileLogOptions in_logOptions,
      bool in_reloadable = false);
 
   ~FileLogDestination() override;
 
   std::string path();
 
   void refresh(const RefreshParams& in_refreshParams = RefreshParams()) override;
 
   void writeLog(LogLevel in_logLevel, const std::string& in_message) override;
 
private:
   PRIVATE_IMPL_SHARED(m_impl);
};
 
} // namespace logging
} // namespace launcher_plugins
} // namespace rstudio
 
#endif