ClickHouse/base/daemon/SentryWriter.h

#pragma once

#include <common/types.h>
#include <Common/StackTrace.h>

#include <Poco/Util/LayeredConfiguration.h>

#include <string>

/// \brief Sends crash reports to ClickHouse core developer team via https://sentry.io
///
/// This feature can enabled with "send_crash_reports.enabled" server setting,
/// in this case reports are sent only for official ClickHouse builds.
///
/// It is possible to send those reports to your own sentry account or account of consulting company you hired
/// by overriding "send_crash_reports.endpoint" setting. "send_crash_reports.debug" setting will allow to do that for
class SentryWriter
{
public:
    SentryWriter() = delete;

    static void initialize(Poco::Util::LayeredConfiguration & config);
    static void shutdown();

    /// Not signal safe and can't be called from a signal handler
    static void onFault(
        int sig,
        const siginfo_t & info,
        const ucontext_t & context,
        const StackTrace & stack_trace,
        const String & build_id_hex
    );
};