scoped_context_guard.h

Go to the documentation of this file.

// BSD 3-Clause License
// Copyright (c) 2025, 🍀☀🌕🌥 🌊
// See the LICENSE file in the project root for full license information.
 
#pragma once
 
#include "unified_log_context.h"
 
#include <kcenon/logger/logger_export.h>
 
#include <optional>
#include <string>
#include <string_view>
#include <vector>
 
namespace kcenon::logger {
 
// Forward declaration
class logger;
 
class LOGGER_SYSTEM_API scoped_context_guard {
public:
    explicit scoped_context_guard(logger& log);
 
    scoped_context_guard(logger& log,
                        std::string_view key,
                        context_value value,
                        context_category category = context_category::custom);
 
    ~scoped_context_guard();
 
    // Non-copyable
    scoped_context_guard(const scoped_context_guard&) = delete;
    scoped_context_guard& operator=(const scoped_context_guard&) = delete;
 
    // Movable
    scoped_context_guard(scoped_context_guard&& other) noexcept;
    scoped_context_guard& operator=(scoped_context_guard&& other) noexcept;
 
    // =========================================================================
    // Setters (chainable)
    // =========================================================================
 
    scoped_context_guard& set(std::string_view key,
                              context_value value,
                              context_category category = context_category::custom);
 
    scoped_context_guard& set_trace(std::string_view trace_id,
                                    std::string_view span_id,
                                    std::optional<std::string_view> parent_span_id = std::nullopt);
 
    scoped_context_guard& set_request(std::string_view request_id,
                                      std::optional<std::string_view> correlation_id = std::nullopt);
 
    scoped_context_guard& set_otel(const otlp::otel_context& ctx);
 
private:
    void track_key(std::string_view key);
 
    logger* logger_;                          // Logger whose context we're managing
    unified_log_context saved_context_;       // Saved context state
    std::vector<std::string> tracked_keys_;   // Keys added/modified by this guard
};
 
} // namespace kcenon::logger