From d8e87f6c1df5c113fdd6026466caf8fccebd5150 Mon Sep 17 00:00:00 2001
From: Amos Bird <amosbird@gmail.com>
Date: Fri, 30 Jun 2023 14:48:20 +0800
Subject: [PATCH] Make common macros extendable

---
 src/Common/CurrentMetrics.cpp | 10 ++++++++--
 src/Common/ErrorCodes.cpp     |  8 +++++++-
 src/Common/ProfileEvents.cpp  |  7 ++++++-
 src/Common/StatusInfo.cpp     |  7 ++++++-
 4 files changed, 27 insertions(+), 5 deletions(-)

diff --git a/src/Common/CurrentMetrics.cpp b/src/Common/CurrentMetrics.cpp
index 105a7c0548f..4f0d55a9cb6 100644
--- a/src/Common/CurrentMetrics.cpp
+++ b/src/Common/CurrentMetrics.cpp
@@ -2,7 +2,7 @@
 
 
 /// Available metrics. Add something here as you wish.
-#define APPLY_FOR_METRICS(M) \
+#define APPLY_FOR_BUILTIN_METRICS(M) \
     M(Query, "Number of executing queries") \
     M(Merge, "Number of executing background merges") \
     M(Move, "Number of currently executing moves") \
@@ -200,7 +200,13 @@
     M(MergeTreeReadTaskRequestsSent, "The current number of callback requests in flight from the remote server back to the initiator server to choose the read task (for MergeTree tables). Measured on the remote server side.") \
     M(MergeTreeAllRangesAnnouncementsSent, "The current number of announcement being sent in flight from the remote server to the initiator server about the set of data parts (for MergeTree tables). Measured on the remote server side.") \
     M(CreatedTimersInQueryProfiler, "Number of Created thread local timers in QueryProfiler") \
-    M(ActiveTimersInQueryProfiler, "Number of Active thread local timers in QueryProfiler")
+    M(ActiveTimersInQueryProfiler, "Number of Active thread local timers in QueryProfiler") \
+
+#ifdef APPLY_FOR_EXTERNAL_METRICS
+  #define APPLY_FOR_METRICS(M) APPLY_FOR_BUILTIN_METRICS(M) APPLY_FOR_EXTERNAL_METRICS(M)
+#else
+  #define APPLY_FOR_METRICS(M) APPLY_FOR_BUILTIN_METRICS(M)
+#endif
 
 namespace CurrentMetrics
 {
diff --git a/src/Common/ErrorCodes.cpp b/src/Common/ErrorCodes.cpp
index 4c08d762df2..87619cdafad 100644
--- a/src/Common/ErrorCodes.cpp
+++ b/src/Common/ErrorCodes.cpp
@@ -13,7 +13,7 @@
   * - system.errors table
   */
 
-#define APPLY_FOR_ERROR_CODES(M) \
+#define APPLY_FOR_BUILTIN_ERROR_CODES(M) \
     M(0, OK) \
     M(1, UNSUPPORTED_METHOD) \
     M(2, UNSUPPORTED_PARAMETER) \
@@ -589,6 +589,12 @@
     M(1002, UNKNOWN_EXCEPTION) \
 /* See END */
 
+#ifdef APPLY_FOR_EXTERNAL_ERROR_CODES
+  #define APPLY_FOR_ERROR_CODES(M) APPLY_FOR_BUILTIN_ERROR_CODES(M) APPLY_FOR_EXTERNAL_ERROR_CODES(M)
+#else
+  #define APPLY_FOR_ERROR_CODES(M) APPLY_FOR_BUILTIN_ERROR_CODES(M)
+#endif
+
 namespace DB
 {
 namespace ErrorCodes
diff --git a/src/Common/ProfileEvents.cpp b/src/Common/ProfileEvents.cpp
index 0838e0366df..ecec1179875 100644
--- a/src/Common/ProfileEvents.cpp
+++ b/src/Common/ProfileEvents.cpp
@@ -4,7 +4,7 @@
 
 
 /// Available events. Add something here as you wish.
-#define APPLY_FOR_EVENTS(M) \
+#define APPLY_FOR_BUILTIN_EVENTS(M) \
     M(Query, "Number of queries to be interpreted and potentially executed. Does not include queries that failed to parse or were rejected due to AST size limits, quota limits or limits on the number of simultaneously running queries. May include internal queries initiated by ClickHouse itself. Does not count subqueries.") \
     M(SelectQuery, "Same as Query, but only for SELECT queries.") \
     M(InsertQuery, "Same as Query, but only for INSERT queries.") \
@@ -536,6 +536,11 @@ The server successfully detected this situation and will download merged part fr
     M(LogError, "Number of log messages with level Error") \
     M(LogFatal, "Number of log messages with level Fatal") \
 
+#ifdef APPLY_FOR_EXTERNAL_EVENTS
+  #define APPLY_FOR_EVENTS(M) APPLY_FOR_BUILTIN_EVENTS(M) APPLY_FOR_EXTERNAL_EVENTS(M)
+#else
+  #define APPLY_FOR_EVENTS(M) APPLY_FOR_BUILTIN_EVENTS(M)
+#endif
 
 namespace ProfileEvents
 {
diff --git a/src/Common/StatusInfo.cpp b/src/Common/StatusInfo.cpp
index 1f9ddfaf4b9..07828cd0aaf 100644
--- a/src/Common/StatusInfo.cpp
+++ b/src/Common/StatusInfo.cpp
@@ -2,9 +2,14 @@
 #include <Common/ExternalLoaderStatus.h>
 
 /// Available status. Add something here as you wish.
-#define APPLY_FOR_STATUS(M) \
+#define APPLY_FOR_BUILTIN_STATUS(M) \
     M(DictionaryStatus, "Dictionary Status.", DB::getStatusEnumAllPossibleValues()) \
 
+#ifdef APPLY_FOR_EXTERNAL_STATUS
+  #define APPLY_FOR_STATUS(M) APPLY_FOR_BUILTIN_STATUS(M) APPLY_FOR_EXTERNAL_STATUS(M)
+#else
+  #define APPLY_FOR_STATUS(M) APPLY_FOR_BUILTIN_STATUS(M)
+#endif
 
 namespace CurrentStatusInfo
 {