Merge pull request #3762 from albinsuresh/feat/extensible-config-management

feat: extensible log management

Author: didier-wenzek

Cargo.lock

@@ -7,6 +7,7 @@ members = [
     "plugins/c8y_firmware_plugin",
     "plugins/c8y_remote_access_plugin",
     "plugins/tedge_apt_plugin",
+    "plugins/tedge_file_log_plugin",
 ]
 resolver = "2"
 
@@ -43,6 +44,7 @@ mqtt_tests = { path = "crates/tests/mqtt_tests" }
 plugin_sm = { path = "crates/core/plugin_sm" }
 tedge-agent = { path = "crates/core/tedge_agent" }
 tedge-apt-plugin = { path = "plugins/tedge_apt_plugin" }
+tedge-file-log-plugin = { path = "plugins/tedge_file_log_plugin" }
 tedge-mapper = { path = "crates/core/tedge_mapper", default-features = false }
 tedge-p11-server = { path = "crates/extensions/tedge-p11-server" }
 tedge-watchdog = { path = "crates/core/tedge_watchdog" }

Cargo.toml

@@ -56,6 +56,7 @@ fi
 if [ -d /etc/sudoers.d ]; then
     echo "tedge    ALL = (ALL) NOPASSWD:SETENV: /usr/bin/tedge, /etc/tedge/sm-plugins/[a-zA-Z0-9]*, /bin/sync, /sbin/init" > /etc/sudoers.d/tedge
     echo "tedge    ALL = (ALL) NOPASSWD:SETENV: /usr/bin/tedge-write /etc/*" >> /etc/sudoers.d/tedge
+    echo "tedge    ALL = (ALL) NOPASSWD:SETENV: /usr/share/tedge/log-plugins/[a-zA-Z0-9]*" >> /etc/sudoers.d/tedge
 fi
 
 

configuration/package_scripts/_generated/tedge/apk/preinst

@@ -56,6 +56,7 @@ fi
 if [ -d /etc/sudoers.d ]; then
     echo "tedge    ALL = (ALL) NOPASSWD:SETENV: /usr/bin/tedge, /etc/tedge/sm-plugins/[a-zA-Z0-9]*, /bin/sync, /sbin/init" > /etc/sudoers.d/tedge
     echo "tedge    ALL = (ALL) NOPASSWD:SETENV: /usr/bin/tedge-write /etc/*" >> /etc/sudoers.d/tedge
+    echo "tedge    ALL = (ALL) NOPASSWD:SETENV: /usr/share/tedge/log-plugins/[a-zA-Z0-9]*" >> /etc/sudoers.d/tedge
 fi
 
 

configuration/package_scripts/_generated/tedge/deb/preinst

@@ -56,6 +56,7 @@ fi
 if [ -d /etc/sudoers.d ]; then
     echo "tedge    ALL = (ALL) NOPASSWD:SETENV: /usr/bin/tedge, /etc/tedge/sm-plugins/[a-zA-Z0-9]*, /bin/sync, /sbin/init" > /etc/sudoers.d/tedge
     echo "tedge    ALL = (ALL) NOPASSWD:SETENV: /usr/bin/tedge-write /etc/*" >> /etc/sudoers.d/tedge
+    echo "tedge    ALL = (ALL) NOPASSWD:SETENV: /usr/share/tedge/log-plugins/[a-zA-Z0-9]*" >> /etc/sudoers.d/tedge
 fi
 
 

configuration/package_scripts/_generated/tedge/rpm/preinst

@@ -56,6 +56,7 @@ fi
 if [ -d /etc/sudoers.d ]; then
     echo "tedge    ALL = (ALL) NOPASSWD:SETENV: /usr/bin/tedge, /etc/tedge/sm-plugins/[a-zA-Z0-9]*, /bin/sync, /sbin/init" > /etc/sudoers.d/tedge
     echo "tedge    ALL = (ALL) NOPASSWD:SETENV: /usr/bin/tedge-write /etc/*" >> /etc/sudoers.d/tedge
+    echo "tedge    ALL = (ALL) NOPASSWD:SETENV: /usr/share/tedge/log-plugins/[a-zA-Z0-9]*" >> /etc/sudoers.d/tedge
 fi
 
 

configuration/package_scripts/tedge/preinst

@@ -936,7 +936,13 @@ define_tedge_config! {
         /// The directories where diagnostic plugins are stored
         #[tedge_config(example = "/usr/share/diag-plugins,/etc/tedge/diag-plugins", default(value = "/usr/share/tedge/diag-plugins"))]
         plugin_paths: TemplatesSet,
-    }
+    },
+
+    log: {
+        /// The directories where log plugins are stored
+        #[tedge_config(example = "/usr/share/log-plugins,/etc/tedge/log-plugins", default(value = "/usr/share/tedge/log-plugins"))]
+        plugin_paths: TemplatesSet,
+    },
 }
 
 static CLOUD_ROOT_CERTIFICATES: OnceLock<Arc<[Certificate]>> = OnceLock::new();

crates/common/tedge_config/src/tedge_toml/tedge_config.rs

@@ -49,6 +49,7 @@ strum_macros = { workspace = true }
 tar = { workspace = true }
 tedge-agent = { workspace = true }
 tedge-apt-plugin = { workspace = true }
+tedge-file-log-plugin = { workspace = true }
 tedge-mapper = { workspace = true, default-features = false }
 tedge-watchdog = { workspace = true }
 tedge-write = { workspace = true }

crates/core/tedge/Cargo.toml

@@ -95,6 +95,14 @@ impl TEdgeInitCmd {
         create_directory(&config.logs.path, &permissions).await?;
         create_directory(&config.data.path, &permissions).await?;
 
+        for log_plugins_dir in &config.log.plugin_paths.0 {
+            create_directory(&log_plugins_dir, &permissions).await?;
+        }
+        // The last directory of the log plugin path list is the location for thin-edge provided plugins
+        if let Some(main_log_plugins_dir) = config.log.plugin_paths.0.last() {
+            create_symlinks_for("file", target, Path::new(main_log_plugins_dir), &RealEnv).await?;
+        }
+
         let entity_store_file = config_dir.join(".agent").join("entity_store.jsonl");
 
         if entity_store_file.exists() {

crates/core/tedge/src/cli/init.rs

@@ -10,6 +10,7 @@ use tedge_agent::AgentOpt;
 use tedge_apt_plugin::AptCli;
 use tedge_config::cli::CommonArgs;
 use tedge_config::TEdgeConfig;
+use tedge_file_log_plugin::bin::FileLogCli;
 use tedge_mapper::MapperOpt;
 use tedge_watchdog::WatchdogOpt;
 use tedge_write::bin::Args as TedgeWriteOpt;
@@ -70,6 +71,8 @@ pub enum Component {
     #[clap(alias = "apt")]
     TedgeAptPlugin(AptCli),
 
+    TedgeFileLogPlugin(FileLogCli),
+
     TedgeMapper(MapperOpt),
 
     TedgeWatchdog(WatchdogOpt),