spdlog::sinks::sentry_api_sink< Mutex > Class Template Reference

#include <Sentry.hpp>

Inheritance diagram for spdlog::sinks::sentry_api_sink< Mutex >:

Collaboration diagram for spdlog::sinks::sentry_api_sink< Mutex >:

Public Member Functions
	sentry_api_sink (const std::string &sentryAddress)
	~sentry_api_sink ()

Protected Member Functions
void	sink_it_ (const details::log_msg &msg) override
void	flush_ () override

Private Attributes
bool	_sentryAvailable {false}

Detailed Description

template<typename Mutex>
class spdlog::sinks::sentry_api_sink< Mutex >

A sink for sending log messages to a Sentry server.

This sink is used to send log messages to a Sentry server for error tracking and monitoring. It provides an interface for sending log messages and flushing the sink.

Template Parameters

Mutex

The type of mutex to use for thread safety.

Definition at line 20 of file Sentry.hpp.

Constructor & Destructor Documentation

sentry_api_sink()

template<typename Mutex>

spdlog::sinks::sentry_api_sink< Mutex >::sentry_api_sink ( const std::string & sentryAddress )

explicit

Constructs a Sentry API sink with the specified Sentry server address.

Parameters

sentryAddress

The address of the Sentry server.

Definition at line 121 of file Sentry.cpp.

    {
        if (sentryAddress.empty())
        {
            return;
        }
        _sentryAvailable = true;
 
        // Set options
        sentry_options_t *sentryOptions = sentry_options_new();
        sentry_options_set_release(sentryOptions, PROJECT_FULL_REVISION);
        sentry_options_set_dsn(sentryOptions, sentryAddress.c_str());
 
        // Init
        sentry_init(sentryOptions);
 
        // Tags
        sentry_set_tag("compiler.name", COMPILER_NAME);
        sentry_set_tag("compiler.version", COMPILER_VERSION);
        sentry_set_tag("build", BUILD_TYPE);
 
        /* ################################################################################### */
        /* ############################# MAKE MODIFICATIONS HERE ############################# */
        /* ################################################################################### */
 
        /* ################################################################################### */
        /* ################################ END MODIFICATIONS ################################ */
        /* ################################################################################### */
 
        setVersionContext();
        setHostContext();
        setNetworkContext();
    }

~sentry_api_sink()

template<typename Mutex>

spdlog::sinks::sentry_api_sink< Mutex >::~sentry_api_sink

(

)

Destroys the Sentry API sink.

Definition at line 155 of file Sentry.cpp.

{ sentry_close(); }

Member Function Documentation

flush_()

template<typename Mutex>

void spdlog::sinks::sentry_api_sink< Mutex >::flush_ ( )

overrideprotected

Flushes the sink.

This function is called to flush any buffered log messages to the Sentry server.

Definition at line 188 of file Sentry.cpp.

    {
        // Sentry library handles all operations, so no need to flush
    }

sink_it_()

template<typename Mutex>

void spdlog::sinks::sentry_api_sink< Mutex >::sink_it_ ( const details::log_msg & msg )

overrideprotected

Sends the log message to the Sentry server.

This function is called for each log message that needs to be sent to the Sentry server.

Parameters

msg	The log message to be sent.

Definition at line 157 of file Sentry.cpp.

    {
        if (!_sentryAvailable)
        {
            return;
        }
        switch (msg.level)
        {
        case spdlog::level::warn:
            sentry_capture_event(sentry_value_new_message_event(
                SENTRY_LEVEL_WARNING, "main", std::string(msg.payload.data(), msg.payload.size()).c_str()));
            break;
        case spdlog::level::err:
            sentry_capture_event(sentry_value_new_message_event(
                SENTRY_LEVEL_ERROR, "main", std::string(msg.payload.data(), msg.payload.size()).c_str()));
            break;
        case spdlog::level::critical:
            sentry_capture_event(sentry_value_new_message_event(
                SENTRY_LEVEL_FATAL, "main", std::string(msg.payload.data(), msg.payload.size()).c_str()));
            break;
        case spdlog::level::trace:
        case spdlog::level::debug:
        case spdlog::level::info:
        case spdlog::level::off:
            // For lower levels, do nothing for now. But you can easily handle them here.
            break;
        default:
            break;
        }
    }

Member Data Documentation

_sentryAvailable

template<typename Mutex>

bool spdlog::sinks::sentry_api_sink< Mutex >::_sentryAvailable {false}

private

Flag indicating if the Sentry server is available.

Definition at line 52 of file Sentry.hpp.

{false}; 

---

The documentation for this class was generated from the following files:

• /__w/Repo-Init/Repo-Init/include/logging/Sentry.hpp
• /__w/Repo-Init/Repo-Init/src/logging/Sentry.cpp