ORE Studio 0.0.4
Loading...
Searching...
No Matches
logging_options.hpp
1/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
2 *
3 * Copyright (C) 2025 Marco Craveiro <marco.craveiro@gmail.com>
4 *
5 * This program is free software; you can redistribute it and/or modify it under
6 * the terms of the GNU General Public License as published by the Free Software
7 * Foundation; either version 3 of the License, or (at your option) any later
8 * version.
9 *
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
13 * details.
14 *
15 * You should have received a copy of the GNU General Public License along with
16 * this program; if not, write to the Free Software Foundation, Inc., 51
17 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 *
19 */
20#ifndef ORES_LOGGING_LOGGING_OPTIONS_HPP
21#define ORES_LOGGING_LOGGING_OPTIONS_HPP
22
23#include <iosfwd>
24#include <optional>
25#include <string>
26#include <filesystem>
27
28namespace ores::logging {
29
33struct logging_options final {
37 std::string severity;
41 std::string filename;
49 std::filesystem::path output_directory;
56 bool include_pid = false;
63 std::optional<int> replica_index;
68 std::string tag;
69};
70
71std::ostream& operator<<(std::ostream& s, const logging_options& v);
72
73}
74
75#endif
Implements logging infrastructure for ORE Studio.
Definition boost_severity.hpp:28
std::basic_ostream< CharT, TraitsT > & operator<<(std::basic_ostream< CharT, TraitsT > &stream, boost_severity level)
Inserter for boost_severity enum.
Definition boost_severity.hpp:80
Options related to logging.
Definition logging_options.hpp:33
bool output_to_console
If true, dumps the log into the console.
Definition logging_options.hpp:45
bool include_pid
If true, includes the process ID in the log filename.
Definition logging_options.hpp:56
std::filesystem::path output_directory
Directory in which to place the output.
Definition logging_options.hpp:49
std::optional< int > replica_index
If set, embeds the replica index in the log filename before the extension (and before the PID if incl...
Definition logging_options.hpp:63
std::string tag
Tag to filter the logging. If supplied, only messages with this tag will be logged.
Definition logging_options.hpp:68
std::string filename
Name of the file to log into. If empty, file logging is disabled.
Definition logging_options.hpp:41
std::string severity
Level at which to log.
Definition logging_options.hpp:37