Merge pull request ClickHouse#79838 from ClickHouse/send-crash-reports-by-default

Send crash reports by default

Author: alexey-milovidov

programs/server/config.xml

@@ -1690,17 +1690,14 @@
     -->
 
     <send_crash_reports>
-        <!-- Changing <enabled> to true allows sending crash reports to -->
+        <!-- Setting <enabled> to true allows sending crash reports to -->
         <!-- the ClickHouse core developers team via Sentry https://sentry.io -->
         <!-- Doing so at least in pre-production environments is highly appreciated -->
-        <enabled>false</enabled>
-        <!-- Change <anonymize> to true if you don't feel comfortable attaching the server hostname to the crash report -->
-        <anonymize>false</anonymize>
-        <!-- Default endpoint should be changed to different Sentry DSN only if you have -->
-        <!-- some in-house engineers or hired consultants who're going to debug ClickHouse issues for you -->
+        <enabled>true</enabled>
+        <send_logical_errors>true</send_logical_errors>
+        <!-- The reports are anonymized by default -->
+        <anonymize>true</anonymize>
         <endpoint>https://[email protected]/5226277</endpoint>
-        <!-- Send LOGICAL_ERRORs as well (default: false) -->
-        <send_logical_errors>false</send_logical_errors>
     </send_crash_reports>
 
     <!-- Uncomment to disable ClickHouse internal DNS caching. -->

src/Daemon/BaseDaemon.cpp

@@ -414,12 +414,13 @@ extern const char * GIT_HASH;
 void BaseDaemon::initializeTerminationAndSignalProcessing()
 {
     SentryWriter::initializeInstance(config());
-    if (config().getBool("send_crash_reports.send_logical_errors", false))
+    if (config().getBool("send_crash_reports.enabled", false)
+        && config().getBool("send_crash_reports.send_logical_errors", false))
     {
         /// In release builds send it to sentry (if it is configured)
         if (auto * sentry = SentryWriter::getInstance())
         {
-            LOG_DEBUG(&logger(), "Enable sending LOGICAL_ERRORs to sentry");
+            LOG_DEBUG(&logger(), "Sending logical errors to sentry is enabled");
             Exception::callback = [sentry](const std::string & msg, int code, bool remote, const Exception::FramePointers & trace)
             {
                 if (!remote && code == ErrorCodes::LOGICAL_ERROR)

src/Daemon/SentryWriter.cpp

@@ -79,17 +79,9 @@ void SentryWriter::resetInstance()
 
 SentryWriter::SentryWriter(Poco::Util::LayeredConfiguration & config)
 {
-    bool enabled = false;
-    bool debug = config.getBool("send_crash_reports.debug", false);
     auto logger = getLogger("SentryWriter");
 
     if (config.getBool("send_crash_reports.enabled", false))
-    {
-        if (debug || (strlen(VERSION_OFFICIAL) > 0))
-            enabled = true;
-    }
-
-    if (enabled)
     {
         server_data_path = config.getString("path", DB::DBMS_DEFAULT_PATH);
         const std::filesystem::path & default_tmp_path = fs::path(config.getString("tmp_path", fs::temp_directory_path())) / "sentry";
@@ -101,10 +93,6 @@ SentryWriter::SentryWriter(Poco::Util::LayeredConfiguration & config)
 
         sentry_options_t * options = sentry_options_new();  /// will be freed by sentry_init or sentry_shutdown
         sentry_options_set_release(options, VERSION_STRING_SHORT);
-        if (debug)
-        {
-            sentry_options_set_debug(options, 1);
-        }
         sentry_options_set_dsn(options, endpoint.c_str());
         sentry_options_set_database_path(options, temp_folder_path.c_str());
 

tests/integration/test_temporary_data/test.py

@@ -55,6 +55,6 @@ def test_tmp_data_no_leftovers(start_cluster):
     node.restart_clickhouse(kill=True)
     path_to_data = "/var/lib/clickhouse/"
 
-    # Check that there are no temporary files left
-    result = node.exec_in_container(["ls", path_to_data + "tmp/"])
+    # Check that there are no temporary files left. Other than from the Sentry library.
+    result = node.exec_in_container(["bash", "-c", f"ls -1 {path_to_data}tmp/ | grep -v 'sentry' ||:"])
     assert result == ""