chore: change name to system metric

config/datanode.example.toml

@@ -101,3 +101,17 @@ parallel_scan_channel_size = 32
 # [logging]
 # dir = "/tmp/greptimedb/logs"
 # level = "info"
+
+# datanode export the metrics generated by itself
+# encoded to Prometheus remote-write format
+# and send to Prometheus remote-write compatible receiver (e.g. send to `greptimedb` itself)
+# This is only used for `greptimedb` to export its own metric internally. Please see `logging` option for normal export of metric.
+# [system_metric]
+# whether enable export system_metric, default is false
+# enable = false
+# The url of metric export endpoint, default is `greptimedb` default frontend endpoint
+# endpoint = "127.0.0.1:4000"
+# The database name of exported metrics stores, user needs to specify a valid database
+# db = ""
+# The interval of export metric
+# write_interval = "30s"

config/frontend.example.toml

@@ -77,3 +77,17 @@ tcp_nodelay = true
 timeout = "10s"
 connect_timeout = "10s"
 tcp_nodelay = true
+
+# frontend export the metrics generated by itself
+# encoded to Prometheus remote-write format
+# and send to Prometheus remote-write compatible receiver (e.g. send to `greptimedb` itself)
+# This is only used for `greptimedb` to export its own metric internally. Please see `logging` option for normal export of metric.
+# [system_metric]
+# whether enable export system_metric, default is false
+# enable = false
+# The url of metric export endpoint, default is `greptimedb` default frontend endpoint
+# endpoint = "127.0.0.1:4000"
+# The database name of exported metrics stores, user needs to specify a valid database
+# db = ""
+# The interval of export metric
+# write_interval = "30s"

config/metasrv.example.toml

@@ -66,3 +66,17 @@ provider = "raft_engine"
 # num_partitions = 1
 # Expected number of replicas of each partition.
 # replication_factor = 3
+
+# metasrv export the metrics generated by itself
+# encoded to Prometheus remote-write format
+# and send to Prometheus remote-write compatible receiver (e.g. send to `greptimedb` itself)
+# This is only used for `greptimedb` to export its own metric internally. Please see `logging` option for normal export of metric.
+# [system_metric]
+# whether enable export system_metric, default is false
+# enable = false
+# The url of metric export endpoint, default is `greptimedb` default frontend endpoint
+# endpoint = "127.0.0.1:4000"
+# The database name of exported metrics stores, user needs to specify a valid database
+# db = ""
+# The interval of export metric
+# write_interval = "30s"

config/standalone.example.toml

@@ -178,14 +178,16 @@ parallel_scan_channel_size = 32
 # The percentage of tracing will be sampled and exported. Valid range `[0, 1]`, 1 means all traces are sampled, 0 means all traces are not sampled, the default value is 1. ratio > 1 are treated as 1. Fractions < 0 are treated as 0
 # tracing_sample_ratio = 1.0
 
-# standalone/frontend/datanode/metasrv export the metrics generated by itself
-# send metrics to Prometheus remote-write compatible receiver (e.g. `greptimedb`)
-# [remote_write]
-# whether enable export remote_write, default is false
+# standalone export the metrics generated by itself
+# encoded to Prometheus remote-write format
+# and send to Prometheus remote-write compatible receiver (e.g. send to `greptimedb` itself)
+# This is only used for `greptimedb` to export its own metric internally. Please see `logging` option for normal export of metric.
+# [system_metric]
+# whether enable export system_metric, default is false
 # enable = false
-# The url of remote write endpoint.
-# Taking greptimedb as an example, for `standalone` deployed under the default configuration.
-# The user can create a database called `system` in the db and export the metric to `http://127.0.0.1:4000/v1/prometheus/write?db=system`
-# endpoint = "http://127.0.0.1:4000/v1/prometheus/write?db=system"
-# The interval of export metric, 
+# The url of metric export endpoint, default is `greptimedb` default frontend endpoint
+# endpoint = "127.0.0.1:4000"
+# The database name of exported metrics stores, user needs to specify a valid database
+# db = ""
+# The interval of export metric
 # write_interval = "30s"

src/cmd/src/frontend.rs

@@ -250,7 +250,7 @@ impl StartCommand {
         .context(StartFrontendSnafu)?;
 
         instance
-            .build_remote_write_metric_task(&opts.remote_write)
+            .build_system_metric_task(&opts.system_metric)
             .context(StartFrontendSnafu)?;
 
         instance

src/cmd/src/standalone.rs

@@ -45,7 +45,7 @@ use frontend::service_config::{
 use mito2::config::MitoConfig;
 use serde::{Deserialize, Serialize};
 use servers::http::HttpOptions;
-use servers::remote_writer::RemoteWriteOptions;
+use servers::system_metric::SystemMetricOption;
 use servers::tls::{TlsMode, TlsOption};
 use servers::Mode;
 use snafu::ResultExt;
@@ -113,7 +113,7 @@ pub struct StandaloneOptions {
     pub user_provider: Option<String>,
     /// Options for different store engines.
     pub region_engine: Vec<RegionEngineConfig>,
-    pub remote_write: RemoteWriteOptions,
+    pub system_metric: SystemMetricOption,
 }
 
 impl Default for StandaloneOptions {
@@ -133,7 +133,7 @@ impl Default for StandaloneOptions {
             metadata_store: KvBackendConfig::default(),
             procedure: ProcedureConfig::default(),
             logging: LoggingOptions::default(),
-            remote_write: RemoteWriteOptions::default(),
+            system_metric: SystemMetricOption::default(),
             user_provider: None,
             region_engine: vec![
                 RegionEngineConfig::Mito(MitoConfig::default()),
@@ -157,8 +157,8 @@ impl StandaloneOptions {
             meta_client: None,
             logging: self.logging,
             user_provider: self.user_provider,
-            // Handle the remote write metric task run by standalone to frontend for execution
-            remote_write: self.remote_write,
+            // Handle the system metric task run by standalone to frontend for execution
+            system_metric: self.system_metric,
             ..Default::default()
         }
     }
@@ -405,7 +405,7 @@ impl StartCommand {
             .context(StartFrontendSnafu)?;
 
         frontend
-            .build_remote_write_metric_task(&opts.frontend.remote_write)
+            .build_system_metric_task(&opts.frontend.system_metric)
             .context(StartFrontendSnafu)?;
 
         frontend

src/common/telemetry/src/metric.rs

@@ -14,7 +14,6 @@
 
 use std::sync::Arc;
 
-// metric stuffs, inspired by databend
 use greptime_proto::prometheus::remote::{Sample, TimeSeries};
 use greptime_proto::prometheus::*;
 use prometheus::proto::{LabelPair, MetricFamily, MetricType};

src/datanode/src/config.rs

@@ -30,7 +30,7 @@ use secrecy::SecretString;
 use serde::{Deserialize, Serialize};
 use servers::heartbeat_options::HeartbeatOptions;
 use servers::http::HttpOptions;
-use servers::remote_writer::RemoteWriteOptions;
+use servers::system_metric::SystemMetricOption;
 use servers::Mode;
 
 pub const DEFAULT_OBJECT_STORE_CACHE_SIZE: ReadableSize = ReadableSize::mb(256);
@@ -242,7 +242,7 @@ pub struct DatanodeOptions {
     pub region_engine: Vec<RegionEngineConfig>,
     pub logging: LoggingOptions,
     pub enable_telemetry: bool,
-    pub remote_write: RemoteWriteOptions,
+    pub system_metric: SystemMetricOption,
 }
 
 impl Default for DatanodeOptions {
@@ -267,7 +267,7 @@ impl Default for DatanodeOptions {
             logging: LoggingOptions::default(),
             heartbeat: HeartbeatOptions::datanode_default(),
             enable_telemetry: true,
-            remote_write: RemoteWriteOptions::default(),
+            system_metric: SystemMetricOption::default(),
         }
     }
 }

src/datanode/src/datanode.rs

@@ -42,8 +42,8 @@ use query::QueryEngineFactory;
 use servers::grpc::{GrpcServer, GrpcServerConfig};
 use servers::http::HttpServerBuilder;
 use servers::metrics_handler::MetricsHandler;
-use servers::remote_writer::RemoteWriteMetricTask;
 use servers::server::{start_server, ServerHandler, ServerHandlers};
+use servers::system_metric::SystemMetricTask;
 use servers::Mode;
 use snafu::{OptionExt, ResultExt};
 use store_api::logstore::LogStore;
@@ -82,7 +82,7 @@ pub struct Datanode {
     greptimedb_telemetry_task: Arc<GreptimeDBTelemetryTask>,
     leases_notifier: Option<Arc<Notify>>,
     plugins: Plugins,
-    remote_write_metric_task: Option<RemoteWriteMetricTask>,
+    system_metric_task: Option<SystemMetricTask>,
 }
 
 impl Datanode {
@@ -94,7 +94,7 @@ impl Datanode {
 
         self.start_telemetry();
 
-        if let Some(t) = self.remote_write_metric_task.as_ref() {
+        if let Some(t) = self.system_metric_task.as_ref() {
             t.start()
         }
 
@@ -265,8 +265,8 @@ impl DatanodeBuilder {
                 None
             };
 
-        let remote_write_metric_task =
-            RemoteWriteMetricTask::try_new(&self.opts.remote_write, Some(&self.plugins))
+        let system_metric_task =
+            SystemMetricTask::try_new(&self.opts.system_metric, Some(&self.plugins))
                 .context(StartServerSnafu)?;
 
         Ok(Datanode {
@@ -277,7 +277,7 @@ impl DatanodeBuilder {
             region_event_receiver,
             leases_notifier,
             plugins: self.plugins.clone(),
-            remote_write_metric_task,
+            system_metric_task,
         })
     }
 

src/frontend/src/frontend.rs

@@ -17,7 +17,7 @@ use meta_client::MetaClientOptions;
 use serde::{Deserialize, Serialize};
 use servers::heartbeat_options::HeartbeatOptions;
 use servers::http::HttpOptions;
-use servers::remote_writer::RemoteWriteOptions;
+use servers::system_metric::SystemMetricOption;
 use servers::Mode;
 use snafu::prelude::*;
 
@@ -45,7 +45,7 @@ pub struct FrontendOptions {
     pub logging: LoggingOptions,
     pub datanode: DatanodeOptions,
     pub user_provider: Option<String>,
-    pub remote_write: RemoteWriteOptions,
+    pub system_metric: SystemMetricOption,
 }
 
 impl Default for FrontendOptions {
@@ -66,7 +66,7 @@ impl Default for FrontendOptions {
             logging: LoggingOptions::default(),
             datanode: DatanodeOptions::default(),
             user_provider: None,
-            remote_write: RemoteWriteOptions::default(),
+            system_metric: SystemMetricOption::default(),
         }
     }
 }

src/frontend/src/instance.rs

@@ -65,8 +65,8 @@ use servers::query_handler::{
     InfluxdbLineProtocolHandler, OpenTelemetryProtocolHandler, OpentsdbProtocolHandler,
     PromStoreProtocolHandler, ScriptHandler,
 };
-use servers::remote_writer::{RemoteWriteMetricTask, RemoteWriteOptions};
 use servers::server::{start_server, ServerHandlers};
+use servers::system_metric::{SystemMetricOption, SystemMetricTask};
 use session::context::QueryContextRef;
 use snafu::prelude::*;
 use sql::dialect::Dialect;
@@ -118,7 +118,7 @@ pub struct Instance {
     heartbeat_task: Option<HeartbeatTask>,
     inserter: InserterRef,
     deleter: DeleterRef,
-    remote_write_metric_task: Option<RemoteWriteMetricTask>,
+    system_metric_task: Option<SystemMetricTask>,
 }
 
 impl Instance {
@@ -196,9 +196,9 @@ impl Instance {
         Ok(())
     }
 
-    pub fn build_remote_write_metric_task(&mut self, opts: &RemoteWriteOptions) -> Result<()> {
-        self.remote_write_metric_task =
-            RemoteWriteMetricTask::try_new(opts, Some(&self.plugins)).context(StartServerSnafu)?;
+    pub fn build_system_metric_task(&mut self, opts: &SystemMetricOption) -> Result<()> {
+        self.system_metric_task =
+            SystemMetricTask::try_new(opts, Some(&self.plugins)).context(StartServerSnafu)?;
         Ok(())
     }
 
@@ -231,7 +231,7 @@ impl FrontendInstance for Instance {
 
         self.script_executor.start(self)?;
 
-        if let Some(t) = self.remote_write_metric_task.as_ref() {
+        if let Some(t) = self.system_metric_task.as_ref() {
             t.start()
         }
 

src/frontend/src/instance/builder.rs

@@ -144,7 +144,7 @@ impl FrontendBuilder {
             heartbeat_task: self.heartbeat_task,
             inserter,
             deleter,
-            remote_write_metric_task: None,
+            system_metric_task: None,
         })
     }
 }

src/meta-srv/src/bootstrap.rs

@@ -28,8 +28,8 @@ use etcd_client::Client;
 use servers::configurator::ConfiguratorRef;
 use servers::http::{HttpServer, HttpServerBuilder};
 use servers::metrics_handler::MetricsHandler;
-use servers::remote_writer::RemoteWriteMetricTask;
 use servers::server::Server;
+use servers::system_metric::SystemMetricTask;
 use snafu::ResultExt;
 use tokio::net::TcpListener;
 use tokio::select;
@@ -60,7 +60,7 @@ pub struct MetaSrvInstance {
 
     plugins: Plugins,
 
-    remote_write_metric_task: Option<RemoteWriteMetricTask>,
+    system_metric_task: Option<SystemMetricTask>,
 }
 
 impl MetaSrvInstance {
@@ -77,23 +77,22 @@ impl MetaSrvInstance {
         );
         // put meta_srv into plugins for later use
         plugins.insert::<Arc<MetaSrv>>(Arc::new(meta_srv.clone()));
-        let remote_write_metric_task =
-            RemoteWriteMetricTask::try_new(&opts.remote_write, Some(&plugins))
-                .context(InitRemoteWriteMetricTaskSnafu)?;
+        let system_metric_task = SystemMetricTask::try_new(&opts.system_metric, Some(&plugins))
+            .context(InitRemoteWriteMetricTaskSnafu)?;
         Ok(MetaSrvInstance {
             meta_srv,
             http_srv,
             opts,
             signal_sender: None,
             plugins,
-            remote_write_metric_task,
+            system_metric_task,
         })
     }
 
     pub async fn start(&mut self) -> Result<()> {
         self.meta_srv.try_start().await?;
 
-        if let Some(t) = self.remote_write_metric_task.as_ref() {
+        if let Some(t) = self.system_metric_task.as_ref() {
             t.start()
         }
 

src/meta-srv/src/metasrv.rs

@@ -33,7 +33,7 @@ use common_telemetry::logging::LoggingOptions;
 use common_telemetry::{error, info, warn};
 use serde::{Deserialize, Serialize};
 use servers::http::HttpOptions;
-use servers::remote_writer::RemoteWriteOptions;
+use servers::system_metric::SystemMetricOption;
 use snafu::ResultExt;
 use table::metadata::TableId;
 use tokio::sync::broadcast::error::RecvError;
@@ -73,7 +73,7 @@ pub struct MetaSrvOptions {
     pub enable_telemetry: bool,
     pub data_home: String,
     pub wal: WalConfig,
-    pub remote_write: RemoteWriteOptions,
+    pub system_metric: SystemMetricOption,
 }
 
 impl Default for MetaSrvOptions {
@@ -99,7 +99,7 @@ impl Default for MetaSrvOptions {
             enable_telemetry: true,
             data_home: METASRV_HOME.to_string(),
             wal: WalConfig::default(),
-            remote_write: RemoteWriteOptions::default(),
+            system_metric: SystemMetricOption::default(),
         }
     }
 }

src/servers/src/lib.rs

@@ -37,10 +37,10 @@ pub mod postgres;
 pub mod prom_store;
 pub mod prometheus_handler;
 pub mod query_handler;
-pub mod remote_writer;
 mod row_writer;
 pub mod server;
 mod shutdown;
+pub mod system_metric;
 pub mod tls;
 
 #[derive(Clone, Debug, Serialize, Deserialize, Eq, PartialEq)]