pulp::runtime::FileLogSinkOptions Struct Reference

#include <log_sink.hpp>

Public Attributes
std::filesystem::path	directory
	Directory that holds the log.
std::string	app_name = "pulp"
	Names the subdirectory under the platform log directory when directory is empty.
std::string	file_name = "pulp.log"
	Log file name inside the directory. A single path component.
std::uint64_t	max_file_bytes = 1024 * 1024
	A record that would grow the file past this rotates it first.
int	max_files = 5
	Live file plus rotated copies kept (pulp.log, pulp.log.1, ..., newest rotation first).
LogLevel	min_level = LogLevel::Info
	Records below this level are not written.

Member Data Documentation

app_name

std::string pulp::runtime::FileLogSinkOptions::app_name = "pulp"

Names the subdirectory under the platform log directory when directory is empty.

A single path component.

directory

std::filesystem::path pulp::runtime::FileLogSinkOptions::directory

Directory that holds the log.

Empty means platform::special_dir(SpecialDir::logs) / app_name. A missing final directory is created owner-only.

file_name

std::string pulp::runtime::FileLogSinkOptions::file_name = "pulp.log"

Log file name inside the directory. A single path component.

max_file_bytes

std::uint64_t pulp::runtime::FileLogSinkOptions::max_file_bytes = 1024 * 1024

A record that would grow the file past this rotates it first.

max_files

int pulp::runtime::FileLogSinkOptions::max_files = 5

Live file plus rotated copies kept (pulp.log, pulp.log.1, ..., newest rotation first).

1 keeps only the live file and discards it on rotation. Values below 1 are treated as 1.

min_level

LogLevel pulp::runtime::FileLogSinkOptions::min_level = LogLevel::Info

Records below this level are not written.

---

The documentation for this struct was generated from the following file:

• /home/runner/work/pulp/pulp/core/runtime/include/pulp/runtime/log_sink.hpp