feat: adds information_schema cluster_info table (#3832)

* feat: adds server running mode to KvBackendCatalogManager * feat: adds MetaClient to KvBackendCatalogManager * feat: impl information_schema.cluster_info table * fix: forgot files * test: update information_schema result * feat: adds start_time and uptime to cluster_info * chore: tweak cargo and comment * feat: rename greptime_region_peers to region_peers * fix: cluster_info result * chore: simplify sqlness commands * chore: set peer_id to -1 for frontends * fix: move cluster_info to greptime catalog * chore: use official proto * feat: adds active_time * chore: apply suggestion Co-authored-by: Jeremyhi <[email protected]> * chore: STANDALONE for runtime_metrics --------- Co-authored-by: Jeremyhi <[email protected]> Co-authored-by: tison <[email protected]>
GreptimeTeam · May 2, 2024 · 65d47ba · 65d47ba
1 parent f6e2039
commit 65d47ba
Show file tree

Hide file tree

Showing 40 changed files with 860 additions and 68 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -116,7 +116,7 @@ etcd-client = { git = "https://github.com/MichaelScofield/etcd-client.git", rev
 fst = "0.4.7"
 futures = "0.3"
 futures-util = "0.3"
-greptime-proto = { git = "https://github.com/GreptimeTeam/greptime-proto.git", rev = "b5412f72257c18410fdccbb893fa5d245b846141" }
+greptime-proto = { git = "https://github.com/GreptimeTeam/greptime-proto.git", rev = "f699e240f7a6c83f139dabac8669714f08513120" }
 humantime = "2.1"
 humantime-serde = "1.1"
 itertools = "0.10"

diff --git a/src/catalog/Cargo.toml b/src/catalog/Cargo.toml
@@ -17,6 +17,7 @@ arrow-schema.workspace = true
 async-stream.workspace = true
 async-trait = "0.1"
 common-catalog.workspace = true
+common-config.workspace = true
 common-error.workspace = true
 common-macro.workspace = true
 common-meta.workspace = true
@@ -30,6 +31,7 @@ datafusion.workspace = true
 datatypes.workspace = true
 futures = "0.3"
 futures-util.workspace = true
+humantime.workspace = true
 itertools.workspace = true
 lazy_static.workspace = true
 meta-client.workspace = true

diff --git a/src/catalog/src/error.rs b/src/catalog/src/error.rs
@@ -49,6 +49,12 @@ pub enum Error {
         source: BoxedError,
     },
 
+    #[snafu(display("Failed to list nodes in cluster: {source}"))]
+    ListNodes {
+        location: Location,
+        source: BoxedError,
+    },
+
     #[snafu(display("Failed to re-compile script due to internal error"))]
     CompileScriptInternal {
         location: Location,
@@ -294,6 +300,7 @@ impl ErrorExt for Error {
             }
 
             Error::ListCatalogs { source, .. }
+            | Error::ListNodes { source, .. }
             | Error::ListSchemas { source, .. }
             | Error::ListTables { source, .. } => source.status_code(),
 

diff --git a/src/catalog/src/information_schema.rs b/src/catalog/src/information_schema.rs
@@ -12,6 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+mod cluster_info;
 pub mod columns;
 pub mod key_column_usage;
 mod memory_table;
@@ -23,6 +24,7 @@ pub mod schemata;
 mod table_constraints;
 mod table_names;
 pub mod tables;
+pub(crate) mod utils;
 
 use std::collections::HashMap;
 use std::sync::{Arc, Weak};
@@ -47,6 +49,7 @@ pub use table_names::*;
 
 use self::columns::InformationSchemaColumns;
 use crate::error::Result;
+use crate::information_schema::cluster_info::InformationSchemaClusterInfo;
 use crate::information_schema::key_column_usage::InformationSchemaKeyColumnUsage;
 use crate::information_schema::memory_table::{get_schema_columns, MemoryTable};
 use crate::information_schema::partitions::InformationSchemaPartitions;
@@ -150,6 +153,7 @@ impl InformationSchemaProvider {
     fn build_tables(&mut self) {
         let mut tables = HashMap::new();
 
+        // SECURITY NOTE:
         // Carefully consider the tables that may expose sensitive cluster configurations,
         // authentication details, and other critical information.
         // Only put these tables under `greptime` catalog to prevent info leak.
@@ -166,6 +170,10 @@ impl InformationSchemaProvider {
                 REGION_PEERS.to_string(),
                 self.build_table(REGION_PEERS).unwrap(),
             );
+            tables.insert(
+                CLUSTER_INFO.to_string(),
+                self.build_table(CLUSTER_INFO).unwrap(),
+            );
         }
 
         tables.insert(TABLES.to_string(), self.build_table(TABLES).unwrap());
@@ -251,6 +259,9 @@ impl InformationSchemaProvider {
                 self.catalog_name.clone(),
                 self.catalog_manager.clone(),
             )) as _),
+            CLUSTER_INFO => Some(Arc::new(InformationSchemaClusterInfo::new(
+                self.catalog_manager.clone(),
+            )) as _),
             _ => None,
         }
     }