ORE Studio 0.0.4
Loading...
Searching...
No Matches
skip_telemetry_guard.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_TELEMETRY_LOG_SKIP_TELEMETRY_GUARD_HPP
21#define ORES_TELEMETRY_LOG_SKIP_TELEMETRY_GUARD_HPP
22
23#include <boost/log/attributes/value_extraction.hpp>
24#include "ores.logging/scoped_attribute.hpp"
25
26namespace ores::telemetry::log {
27
36inline constexpr const char* skip_telemetry_attribute = "SkipTelemetry";
37
63
70template<typename RecordView>
71bool should_skip_telemetry(const RecordView& rec) {
72 auto skip_attr = boost::log::extract<bool>(skip_telemetry_attribute, rec);
73 return skip_attr && skip_attr.get();
74}
75
76}
77
78#endif
Implements logging for ORE Studio.
Definition database_sink_backend.hpp:32
bool should_skip_telemetry(const RecordView &rec)
Checks if a log record should be skipped by telemetry sinks.
Definition skip_telemetry_guard.hpp:71
constexpr const char * skip_telemetry_attribute
Well-known attribute name used to signal telemetry sinks to skip processing a log record.
Definition skip_telemetry_guard.hpp:36
RAII guard that adds a thread-local attribute to Boost.Log for the duration of its scope.
Definition scoped_attribute.hpp:57
scoped_attribute(const std::string &attribute_name)
Constructs a scoped attribute guard.
Definition scoped_attribute.hpp:69
RAII guard that marks log records to be skipped by telemetry sinks.
Definition skip_telemetry_guard.hpp:58