Switch on internal breakpad and in ydbd, write capability about it (#17292)

iddqdex · web-flow · commit bc00dd453cf9 · 2025-06-16T17:11:55.000+03:00
diff --git a/ydb/apps/ydbd/ya.make b/ydb/apps/ydbd/ya.make
@@ -69,7 +69,7 @@ PEERDIR(
     yql/essentials/udfs/common/url_base
     yql/essentials/udfs/common/yson2
     yql/essentials/udfs/logs/dsv
-#    ydb/library/breakpad 
+    ydb/library/breakpad 
     ydb/public/sdk/cpp/client/ydb_persqueue_public/codecs
 )
 
diff --git a/ydb/core/driver_lib/cli_utils/cli_cmds_server.cpp b/ydb/core/driver_lib/cli_utils/cli_cmds_server.cpp
@@ -24,36 +24,35 @@ TClientCommandServer::TClientCommandServer(std::shared_ptr<TModuleFactories> fac
         *Logger
     }))
     , InitCfg(DepsRecorder->GetDeps())
+    , RunConfig(AppConfig)
 {}
 
 int TClientCommandServer::Run(TConfig& config) {
-    NKikimrConfig::TAppConfig appConfig;
-
-    TKikimrRunConfig runConfig(appConfig);
-
     InitCfg.Apply(
-        appConfig,
-        runConfig.NodeId,
-        runConfig.ScopeId,
-        runConfig.TenantName,
-        runConfig.ServicesMask,
-        runConfig.ClusterName,
-        runConfig.ConfigsDispatcherInitInfo);
+        AppConfig,
+        RunConfig.NodeId,
+        RunConfig.ScopeId,
+        RunConfig.TenantName,
+        RunConfig.ServicesMask,
+        RunConfig.ClusterName,
+        RunConfig.ConfigsDispatcherInitInfo);
 
-    runConfig.ConfigsDispatcherInitInfo.RecordedInitialConfiguratorDeps =
+    RunConfig.ConfigsDispatcherInitInfo.RecordedInitialConfiguratorDeps =
         std::make_shared<NConfig::TRecordedInitialConfiguratorDeps>(DepsRecorder->GetRecordedDeps());
 
     for (int i = 0; i < config.ArgC; ++i) {
-        runConfig.ConfigsDispatcherInitInfo.Args.push_back(config.ArgV[i]);
+        RunConfig.ConfigsDispatcherInitInfo.Args.push_back(config.ArgV[i]);
     }
 
-    Y_ABORT_UNLESS(runConfig.NodeId);
-    return MainRun(runConfig, Factories);
+    Y_ABORT_UNLESS(RunConfig.NodeId);
+    return MainRun(RunConfig, Factories);
 }
 
 void TClientCommandServer::Config(TConfig& config) {
     TClientCommand::Config(config);
-
+    for (auto plugin: RunConfig.Plugins) {
+        plugin->SetupOpts(*config.Opts);
+    }
     NConfig::AddProtoConfigOptions(DepsRecorder->GetDeps().ProtoConfigFileProvider);
     InitCfg.RegisterCliOptions(*config.Opts);
     ProtoConfigFileProvider->RegisterCliOptions(*config.Opts);
diff --git a/ydb/core/driver_lib/cli_utils/cli_cmds_server.h b/ydb/core/driver_lib/cli_utils/cli_cmds_server.h
@@ -33,6 +33,10 @@ class TClientCommandServer : public TClientCommand {
     std::unique_ptr<NConfig::IInitialConfiguratorDepsRecorder> DepsRecorder;
 
     NConfig::TInitialConfigurator InitCfg;
+
+private:
+    NKikimrConfig::TAppConfig AppConfig;
+    TKikimrRunConfig RunConfig;
 };
 
 } // namespace NKikimr::NDriverClient
diff --git a/ydb/core/driver_lib/run/config.cpp b/ydb/core/driver_lib/run/config.cpp
@@ -6,6 +6,10 @@ TKikimrRunConfig::TKikimrRunConfig(NKikimrConfig::TAppConfig& appConfig, ui32 no
     : AppConfig(appConfig)
     , NodeId(nodeId)
     , ScopeId(scopeId)
-{}
+{
+    for (const auto& key: NYdb::NGlobalPlugins::TPluginFactory::GetRegisteredKeys()) {
+        Plugins.emplace_back(NYdb::NGlobalPlugins::TPluginFactory::Construct(key));
+    }
+}
 
 } // namespace NKikimr
diff --git a/ydb/core/driver_lib/run/config.h b/ydb/core/driver_lib/run/config.h
@@ -6,6 +6,7 @@
 #include <ydb/core/base/event_filter.h>
 #include <ydb/core/config/init/init.h>
 #include <ydb/core/driver_lib/cli_config_base/config_base.h>
+#include <ydb/library/global_plugins/abstract.h>
 
 #include <util/generic/hash.h>
 
@@ -27,6 +28,8 @@ struct TKikimrRunConfig {
 
     NConfig::TConfigsDispatcherInitInfo ConfigsDispatcherInitInfo;
 
+    TVector<TAtomicSharedPtr<NYdb::NGlobalPlugins::IPluginInitilizer>> Plugins;
+
     TKikimrRunConfig(NKikimrConfig::TAppConfig& appConfig,
                      ui32 nodeId = 0, const TKikimrScopeId& scopeId = {});
 };
diff --git a/ydb/core/driver_lib/run/run.cpp b/ydb/core/driver_lib/run/run.cpp
@@ -1800,6 +1800,9 @@ TIntrusivePtr<TServiceInitializersList> TKikimrRunner::CreateServiceInitializers
 }
 
 void TKikimrRunner::KikimrStart() {
+    for (auto plugin: Plugins) {
+        plugin->Start();
+    }
 
     if (!!PollerThreads) {
         PollerThreads->Start();
@@ -1962,6 +1965,9 @@ void TKikimrRunner::KikimrStop(bool graceful) {
     if (YdbDriver) {
         YdbDriver->Stop(true);
     }
+    for (auto plugin: Plugins) {
+        plugin->Stop();
+    }
 }
 
 void TKikimrRunner::BusyLoop() {
@@ -2028,6 +2034,14 @@ void TKikimrRunner::InitializeRegistries(const TKikimrRunConfig& runConfig) {
     NKikHouse::RegisterFormat(*FormatFactory);
 }
 
+void TKikimrRunner::InitializePlugins(const TKikimrRunConfig& runConfig) {
+    for (const auto& initializer: runConfig.Plugins) {
+        if (auto plugin = initializer->CreatePlugin()) {
+            Plugins.push_back(plugin);
+        }
+    }
+}
+
 TIntrusivePtr<TKikimrRunner> TKikimrRunner::CreateKikimrRunner(
         const TKikimrRunConfig& runConfig,
         std::shared_ptr<TModuleFactories> factories) {
@@ -2044,6 +2058,7 @@ TIntrusivePtr<TKikimrRunner> TKikimrRunner::CreateKikimrRunner(
     runner->InitializeKqpController(runConfig);
     runner->InitializeGracefulShutdown(runConfig);
     runner->InitializeGRpc(runConfig);
+    runner->InitializePlugins(runConfig);
     return runner;
 }
 
diff --git a/ydb/core/driver_lib/run/run.h b/ydb/core/driver_lib/run/run.h
@@ -64,6 +64,8 @@ class TKikimrRunner : public virtual TThrRefBase, private IGlobalObjectStorage {
 
     TIntrusivePtr<NMemory::IProcessMemoryInfoProvider> ProcessMemoryInfoProvider;
 
+    TVector<NYdb::NGlobalPlugins::IPlugin::TPtr> Plugins;
+
     TKikimrRunner(std::shared_ptr<TModuleFactories> factories = {});
 
     virtual ~TKikimrRunner();
@@ -90,6 +92,8 @@ class TKikimrRunner : public virtual TThrRefBase, private IGlobalObjectStorage {
 
     void InitializeAppData(const TKikimrRunConfig& runConfig);
 
+    void InitializePlugins(const TKikimrRunConfig& runConfig);
+
     void InitializeActorSystem(
         const TKikimrRunConfig& runConfig,
         TIntrusivePtr<TServiceInitializersList> serviceInitializers,
diff --git a/ydb/core/driver_lib/run/ya.make b/ydb/core/driver_lib/run/ya.make
@@ -135,6 +135,7 @@ PEERDIR(
     ydb/library/actors/util
     ydb/library/folder_service
     ydb/library/folder_service/proto
+    ydb/library/global_plugins
     ydb/library/grpc/server
     ydb/library/grpc/server/actors
     ydb/library/pdisk_io
diff --git a/ydb/core/driver_lib/version/version.cpp b/ydb/core/driver_lib/version/version.cpp
@@ -1,6 +1,7 @@
 #include <google/protobuf/text_format.h>
 #include <google/protobuf/util/message_differencer.h>
 #include <library/cpp/svnversion/svnversion.h>
+#include <ydb/library/global_plugins/abstract.h>
 #include <ydb/library/yverify_stream/yverify_stream.h>
 #include <ydb/core/viewer/json/json.h>
 #include "version.h"
@@ -775,6 +776,10 @@ TString TCompatibilityInfo::PrintHumanReadable(const NKikimrConfig::TCurrentComp
     }
     str << "\n";
 
+    if (NYdb::NGlobalPlugins::TPluginFactory::Has("internal_breakpad")) {
+        str << "    HasInternalBreakpad: true" << Endl;
+    }
+
     // print common rule
     if (current->HasVersion() && current->GetVersion().HasYear() && current->GetVersion().HasMajor()) {
         const auto& version = current->GetVersion();
diff --git a/ydb/core/driver_lib/version/ya.make b/ydb/core/driver_lib/version/ya.make
@@ -10,6 +10,7 @@ PEERDIR(
     ydb/library/actors/interconnect
     library/cpp/monlib/service/pages
     library/cpp/svnversion
+    ydb/library/global_plugins
     ydb/core/protos
     ydb/core/viewer/json
 )
diff --git a/ydb/library/breakpad/about.txt b/ydb/library/breakpad/about.txt
@@ -0,0 +1 @@
+Pluggable Google Breakpad
diff --git a/ydb/library/breakpad/minidumps.cpp b/ydb/library/breakpad/minidumps.cpp
@@ -1,36 +1,60 @@
-#include <util/generic/ptr.h>
+#include <ydb/library/global_plugins/abstract.h>
 #include <contrib/libs/breakpad/src/client/linux/handler/exception_handler.h>
 #include <unistd.h>
 #include <sys/wait.h>
 
 
 class TMinidumper {
 public:
-    TMinidumper() {
-        if(const char* path = getenv("BREAKPAD_MINIDUMPS_PATH")) {
-            using namespace google_breakpad;
-            Handler = MakeHolder<ExceptionHandler>(MinidumpDescriptor(path), nullptr, DumpCallback, nullptr, true, -1, true);
+    TMinidumper(const char* path) {
+        Init(path);
+    }
+    void Init(const char* path) {
+        if (TStringBuf(path)) {
+            Handler = MakeHolder<google_breakpad::ExceptionHandler>(google_breakpad::MinidumpDescriptor(path), nullptr, DumpCallback, nullptr, true, -1, true);
         }
     }
 
-private:
-    static bool DumpCallback(const google_breakpad::MinidumpDescriptor& descriptor, void* /*context*/, bool succeeded) {
-        if (char* script = getenv("BREAKPAD_MINIDUMPS_SCRIPT")) {
-            if (auto pid = fork()) {
-                waitpid(pid, 0, 0);
-            } else {
-                char* dumpSucceded = succeeded ? (char *)"true" : (char *)"false";  
-                char* descriptorPath = succeeded ? (char *)descriptor.path() : (char *)"\0";  
-                char* cmd[] = {script, dumpSucceded, descriptorPath, NULL};  
-                if (execve(cmd[0], &cmd[0], NULL)) {
-                    fprintf(stderr, "Error while process BREAKPAD MINIDUMPS SCRIPT: execve(%s '%s' '%s' '%s'): %s\n", cmd[0], cmd[1], cmd[2], strerror(errno));
-                }
+    TString Script = getenv("BREAKPAD_MINIDUMPS_SCRIPT");
+
+    private:
+    static bool DumpCallback(const google_breakpad::MinidumpDescriptor& descriptor, void* context, bool succeeded);
+    THolder<google_breakpad::ExceptionHandler> Handler;
+};
+
+TMinidumper Minidumper(getenv("BREAKPAD_MINIDUMPS_PATH"));
+
+bool TMinidumper::DumpCallback(const google_breakpad::MinidumpDescriptor& descriptor, void* /*context*/, bool succeeded) {
+    if (Minidumper.Script) {
+        if (auto pid = fork()) {
+            waitpid(pid, 0, 0);
+        } else {
+            char* dumpSucceded = succeeded ? (char *)"true" : (char *)"false";  
+            char* descriptorPath = succeeded ? (char *)descriptor.path() : (char *)"\0";  
+            char* cmd[] = {Minidumper.Script.begin(), dumpSucceded, descriptorPath, NULL};  
+            if (execve(cmd[0], &cmd[0], NULL)) {
+                fprintf(stderr, "Error while process BREAKPAD MINIDUMPS SCRIPT: execve(%s '%s' '%s' '%s'): %s\n", cmd[0], cmd[1], cmd[2], strerror(errno));
             }
         }
-        return succeeded;
     }
+    return succeeded;
+}
 
-    THolder<google_breakpad::ExceptionHandler> Handler;
+
+class TMinidumperInitilizer final: public NYdb::NGlobalPlugins::IPluginInitilizer {
+public:
+    void SetupOpts(NLastGetopt::TOpts& opts) override {
+        opts.AddLongOption("breakpad-minidumps-path", "Path for minidumps generated by internal breakpad")
+            .RequiredArgument("PATH").Handler1T<TString>([](const TString& path) {
+            Minidumper.Init(path.c_str());
+        });
+        opts.AddLongOption("breakpad-minidumps-script", "Script for process minidumps generated by internal breakpad")
+            .RequiredArgument("SCRIPT").StoreResult(&Minidumper.Script);
+    }
+    NYdb::NGlobalPlugins::IPlugin::TPtr CreatePlugin() const override {
+        return {};
+    }
+    const static NYdb::NGlobalPlugins::TPluginFactory::TRegistrator<TMinidumperInitilizer> Registrar;
 };
 
-TMinidumper Minidumper;
+const NYdb::NGlobalPlugins::TPluginFactory::TRegistrator<TMinidumperInitilizer> TMinidumperInitilizer::Registrar("internal_breakpad");
diff --git a/ydb/library/breakpad/ya.make b/ydb/library/breakpad/ya.make
@@ -9,6 +9,9 @@ IF (OS_LINUX)
     SRCS(
         GLOBAL minidumps.cpp
     )
+
+    RESOURCE(about.txt "internal_breakpad_about")
+
 ENDIF()
 
 END()
diff --git a/ydb/library/global_plugins/abstract.cpp b/ydb/library/global_plugins/abstract.cpp
@@ -0,0 +1 @@
+#include "abstract.h"
diff --git a/ydb/library/global_plugins/abstract.h b/ydb/library/global_plugins/abstract.h
@@ -0,0 +1,23 @@
+#pragma once
+
+#include <library/cpp/object_factory/object_factory.h>
+#include <library/cpp/getopt/last_getopt.h>
+
+namespace NYdb::NGlobalPlugins {
+    class IPlugin: public TAtomicRefCount<IPlugin> {
+    public:
+        using TPtr = TIntrusivePtr<IPlugin>;
+        virtual ~IPlugin() = default;
+        virtual void Start() = 0;
+        virtual void Stop() = 0;
+    };
+
+    class IPluginInitilizer {
+    public:
+        virtual ~IPluginInitilizer() = default;
+        virtual void SetupOpts(NLastGetopt::TOpts& opts) = 0;
+        virtual IPlugin::TPtr CreatePlugin() const = 0;
+    };
+
+    using TPluginFactory = NObjectFactory::TObjectFactory<IPluginInitilizer, TString>;
+}
diff --git a/ydb/library/global_plugins/ya.make b/ydb/library/global_plugins/ya.make
@@ -0,0 +1,9 @@
+LIBRARY()
+
+SRCS(abstract.cpp)
+
+PEERDIR(
+    library/cpp/getopt
+)
+
+END()
diff --git a/ydb/library/ya.make b/ydb/library/ya.make
@@ -12,6 +12,7 @@ RECURSE(
     folder_service
     formats
     fyamlcpp
+    global_plugins
     grpc
     http_proxy
     keys
diff --git a/ydb/tests/functional/minidumps/test_break.py b/ydb/tests/functional/minidumps/test_break.py
diff --git a/ydb/tests/functional/minidumps/ya.make b/ydb/tests/functional/minidumps/ya.make
diff --git a/ydb/tests/library/harness/kikimr_config.py b/ydb/tests/library/harness/kikimr_config.py
diff --git a/ydb/tests/library/harness/kikimr_runner.py b/ydb/tests/library/harness/kikimr_runner.py

Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@ PEERDIR(`
`69`	`69`	`yql/essentials/udfs/common/url_base`
`70`	`70`	`yql/essentials/udfs/common/yson2`
`71`	`71`	`yql/essentials/udfs/logs/dsv`
`72`		`-# ydb/library/breakpad`
	`72`	`+ ydb/library/breakpad`
`73`	`73`	`ydb/public/sdk/cpp/client/ydb_persqueue_public/codecs`
`74`	`74`	`)`
`75`	`75`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@ PEERDIR(`
`10`	`10`	`ydb/library/actors/interconnect`
`11`	`11`	`library/cpp/monlib/service/pages`
`12`	`12`	`library/cpp/svnversion`
	`13`	`+ ydb/library/global_plugins`
`13`	`14`	`ydb/core/protos`
`14`	`15`	`ydb/core/viewer/json`
`15`	`16`	`)`