feat: add metric enable config

Author: ThisSeanZhang

landscape-common/src/config/loader.rs

@@ -95,6 +95,7 @@ impl RuntimeConfig {
         };
 
         let metric = MetricRuntimeConfig {
+            enable: config.metric.enable.unwrap_or(crate::DEFAULT_METRIC_ENABLE),
             raw_retention_minutes: config
                 .metric
                 .raw_retention_minutes

landscape-common/src/config/runtime.rs

@@ -50,6 +50,7 @@ pub struct StoreRuntimeConfig {
 
 #[derive(Clone, Debug)]
 pub struct MetricRuntimeConfig {
+    pub enable: bool,
     pub raw_retention_minutes: u64,
     pub rollup_1m_retention_days: u64,
     pub rollup_1h_retention_days: u64,
@@ -107,6 +108,7 @@ impl RuntimeConfig {
          Database Connect: {}\n\
          \n\
           [Metric]\n\
+         Enabled: {}\n\
          Raw Retention: {} mins\n\
          Rollup 1m Retention: {} days\n\
          Rollup 1h Retention: {} days\n\
@@ -131,6 +133,7 @@ impl RuntimeConfig {
             address_http_str,
             address_https_str,
             self.store.database_path,
+            self.metric.enable,
             self.metric.raw_retention_minutes,
             self.metric.rollup_1m_retention_days,
             self.metric.rollup_1h_retention_days,
@@ -150,6 +153,9 @@ impl RuntimeConfig {
 
 impl MetricRuntimeConfig {
     pub fn update_from_file_config(&mut self, config: &LandscapeMetricConfig) {
+        if let Some(v) = config.enable {
+            self.enable = v;
+        }
         if let Some(v) = config.raw_retention_minutes {
             self.raw_retention_minutes = v;
         }

landscape-common/src/config/settings.rs

@@ -49,6 +49,9 @@ pub struct LandscapeStoreConfig {
 #[derive(Debug, Serialize, Deserialize, Clone, Default)]
 #[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
 pub struct LandscapeMetricConfig {
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    #[cfg_attr(feature = "openapi", schema(required = false, nullable = false))]
+    pub enable: Option<bool>,
     #[serde(default, skip_serializing_if = "Option::is_none")]
     #[cfg_attr(feature = "openapi", schema(required = false, nullable = false))]
     pub raw_retention_minutes: Option<u64>,

landscape-common/src/lib.rs

@@ -77,6 +77,7 @@ pub const LANDSCAPE_METRIC_DIR_NAME: &str = "metric";
 pub const LANDSCAPE_METRIC_DB_VERSION: u32 = 10;
 
 // Metric Retention Defaults
+pub const DEFAULT_METRIC_ENABLE: bool = true;
 pub const DEFAULT_METRIC_RAW_RETENTION_MINUTES: u64 = 5;
 pub const DEFAULT_METRIC_ROLLUP_1M_RETENTION_DAYS: u64 = 1;
 pub const DEFAULT_METRIC_ROLLUP_1H_RETENTION_DAYS: u64 = 7;

landscape-webserver/src/main.rs

@@ -366,7 +366,7 @@ async fn run(home_path: PathBuf, config: RuntimeConfig) -> LdResult<()> {
         dns_upstream_service.clone(),
         config.dns.clone(),
         cert_service.clone(),
-        Some(metric_service.data.dns_metric.get_msg_channel()),
+        metric_service.get_dns_metric_channel(),
     )
     .await;
     let fire_wall_rule_service = FirewallRuleService::new(db_store_provider.clone()).await;

landscape-webui/src/i18n/en/config.ts

@@ -9,6 +9,10 @@ export default {
   save_dns: "Save DNS Config",
   save_metric: "Save Metric Config",
 
+  metric_enabled: "Enable Metric Service",
+  metric_enabled_desc:
+    "When disabled, new connection and DNS metric data will no longer be collected",
+
   language: "Language",
   theme: "Theme",
   theme_placeholder: "Light mode is under development",

landscape-webui/src/i18n/zh/config.ts

@@ -9,6 +9,9 @@ export default {
   save_dns: "保存 DNS 配置",
   save_metric: "保存指标配置",
 
+  metric_enabled: "启用指标服务",
+  metric_enabled_desc: "关闭后不再采集新的连接与 DNS 指标数据",
+
   language: "语言设定",
   theme: "外观主题",
   theme_placeholder: "浅色模式适配中，暂不可用",

landscape-webui/src/stores/metric_config.ts

@@ -4,6 +4,7 @@ import type { LandscapeMetricConfig } from "@landscape-router/types/api/schemas"
 import { get_metric_config_edit, update_metric_config } from "@/api/sys/config";
 
 export const useMetricConfigStore = defineStore("metric_config", () => {
+  const enabled = ref<boolean>(true);
   const rawRetentionMinutes = ref<number | undefined>(undefined);
   const rollup1mRetentionDays = ref<number | undefined>(undefined);
   const rollup1hRetentionDays = ref<number | undefined>(undefined);
@@ -21,6 +22,7 @@ export const useMetricConfigStore = defineStore("metric_config", () => {
 
   async function loadMetricConfig() {
     const { metric, hash } = await get_metric_config_edit();
+    enabled.value = metric.enable ?? true;
     rawRetentionMinutes.value = metric.raw_retention_minutes ?? undefined;
     rollup1mRetentionDays.value = metric.rollup_1m_retention_days ?? undefined;
     rollup1hRetentionDays.value = metric.rollup_1h_retention_days ?? undefined;
@@ -41,6 +43,7 @@ export const useMetricConfigStore = defineStore("metric_config", () => {
 
   async function saveMetricConfig() {
     const new_metric: LandscapeMetricConfig = {
+      enable: enabled.value,
       raw_retention_minutes: rawRetentionMinutes.value,
       rollup_1m_retention_days: rollup1mRetentionDays.value,
       rollup_1h_retention_days: rollup1hRetentionDays.value,
@@ -66,6 +69,7 @@ export const useMetricConfigStore = defineStore("metric_config", () => {
   }
 
   return {
+    enabled,
     rawRetentionMinutes,
     rollup1mRetentionDays,
     rollup1hRetentionDays,

landscape-webui/src/views/config_parts/MetricConfigCard.vue

@@ -29,6 +29,13 @@ async function handleSaveMetric() {
       </n-button>
     </template>
     <n-form label-placement="left" label-width="120">
+      <n-form-item :label="t('config.metric_enabled')">
+        <n-switch v-model:value="metricStore.enabled" />
+        <template #feedback>
+          {{ t("config.metric_enabled_desc") }}
+        </template>
+      </n-form-item>
+
       <n-divider title-placement="left">
         {{ t("config.conn_retention_mins") }}
       </n-divider>

landscape/src/bin/event_metric_loop.rs

@@ -29,6 +29,7 @@ async fn main() {
     let metric_service = MetricData::new(
         metric_path,
         landscape_common::config::MetricRuntimeConfig {
+            enable: landscape_common::DEFAULT_METRIC_ENABLE,
             raw_retention_minutes: landscape_common::DEFAULT_METRIC_RAW_RETENTION_MINUTES,
             rollup_1m_retention_days: landscape_common::DEFAULT_METRIC_ROLLUP_1M_RETENTION_DAYS,
             rollup_1h_retention_days: landscape_common::DEFAULT_METRIC_ROLLUP_1H_RETENTION_DAYS,