set default log path to /var/log/tedge (#2480)

Signed-off-by: Pradeep Kumar K J <pkj@softwareag.com>

configuration/init/initd/tedge

@@ -22,9 +22,9 @@ user="tedge"
 name=$(basename $0)
 pid_file="/var/run/$name.pid"
 
-# Default location for logging assumed to be /var/log.
-stdout_log="/var/log/$name.log"
-stderr_log="/var/log/$name.err"
+# Default location for logging assumed to be /var/log/tedge.
+stdout_log="/var/log/tedge/$name.log"
+stderr_log="/var/log/tedge/$name.err"
 
 get_pid() {
     cat "$pid_file"

crates/common/tedge_config/src/tedge_config_cli/tedge_config.rs

@@ -655,7 +655,7 @@ define_tedge_config! {
 
     logs: {
         /// The directory used to store logs
-        #[tedge_config(example = "/var/log", default(value = "/var/log"))]
+        #[tedge_config(example = "/var/log/tedge", default(value = "/var/log/tedge"))]
         #[doku(as = "PathBuf")]
         path: Utf8PathBuf,
     },

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

@@ -155,7 +155,7 @@ impl TEdgeInitCmd {
         let config = self.context.config_repository.load()?;
 
         create_directory(
-            config.logs.path.join("tedge"),
+            config.logs.path.clone(),
             PermissionEntry::new(
                 Some(self.user.clone()),
                 Some(self.group.clone()),

crates/core/tedge_agent/src/agent.rs

@@ -123,7 +123,7 @@ impl AgentConfig {
         let use_lock = tedge_config.run.lock_files;
 
         // For agent specific
-        let log_dir = tedge_config.logs.path.join("tedge").join("agent");
+        let log_dir = tedge_config.logs.path.join("agent");
         let operations_dir = config_dir.join("operations");
 
         let identity = tedge_config.http.client.auth.identity()?;

crates/core/tedge_agent/src/software_manager/config.rs

@@ -44,7 +44,7 @@ impl SoftwareManagerConfig {
 
         let tmp_dir = &tedge_config.tmp.path;
         let sm_plugins_dir = config_dir.join("sm-plugins");
-        let log_dir = tedge_config.logs.path.join("tedge").join("agent");
+        let log_dir = tedge_config.logs.path.join("agent");
         let default_plugin_type = tedge_config
             .software
             .plugin

crates/extensions/c8y_log_manager/src/lib.rs

@@ -75,7 +75,7 @@ impl LogManagerBuilder {
         create_directory_with_defaults(&config.plugin_config_dir)?;
 
         // creating c8y-log-plugin.toml
-        let logs_path = format!("{}/tedge/agent/software-*", config.log_dir.display());
+        let logs_path = format!("{}/agent/software-*", config.log_dir.display());
         let data = format!(
             r#"files = [
     {{ type = "software-management", path = "{logs_path}" }},

crates/extensions/c8y_mapper_ext/src/converter.rs

@@ -101,7 +101,7 @@ const C8Y_CLOUD: &str = "c8y";
 const SUPPORTED_OPERATIONS_DIRECTORY: &str = "operations";
 const INTERNAL_ALARMS_TOPIC: &str = "c8y-internal/alarms/";
 const C8Y_JSON_MQTT_EVENTS_TOPIC: &str = "c8y/event/events/create";
-const TEDGE_AGENT_LOG_DIR: &str = "tedge/agent";
+const TEDGE_AGENT_LOG_DIR: &str = "agent";
 const CREATE_EVENT_SMARTREST_CODE: u16 = 400;
 const DEFAULT_EVENT_TYPE: &str = "ThinEdgeEvent";
 const FORBIDDEN_ID_CHARS: [char; 3] = ['/', '+', '#'];

crates/extensions/c8y_mapper_ext/src/tests.rs

@@ -2475,7 +2475,7 @@ async fn c8y_mapper_nested_child_service_event_mapping_to_smartrest() {
 }
 
 fn assert_command_exec_log_content(cfg_dir: TempTedgeDir, expected_contents: &str) {
-    let paths = fs::read_dir(cfg_dir.to_path_buf().join("tedge/agent")).unwrap();
+    let paths = fs::read_dir(cfg_dir.to_path_buf().join("agent")).unwrap();
     for path in paths {
         let mut file =
             File::open(path.unwrap().path()).expect("Unable to open the command exec log file");

docs/src/operate/configuration/update_config_paths.md

@@ -14,7 +14,7 @@ The following table captures the paths that can be changed, with their default l
 | Config Key | Description | Default Value |
 |------------|-------------|---------------|
 | tmp.path | Directory where temporary files are created/stored. E.g: while downloading files | `/tmp` |
-| logs.path | Directory where log files are created | `/var/log` |
+| logs.path | Directory where log files are created | `/var/log/tedge` |
 | run.path | Directory where runtime information are stored | `/run` |
 | data.path | Directory where data files are stored. E.g: Cached binary files, operation metadata etc | `/var/tedge` |
 

tests/RobotFramework/tests/customizing/log_path_config.robot

@@ -9,10 +9,10 @@ Suite Setup            Custom Setup
 Suite Teardown         Custom Teardown
 
 *** Test Cases ***
-Validate updated data path used by tedge-agent
+Validate updated log path used by tedge-agent
     Execute Command    sudo tedge config set logs.path /var/test
     Restart Service    tedge-agent
-    Directory Should Exist    /var/test/tedge/agent
+    Directory Should Exist    /var/test/agent
 
 *** Keywords ***
 Custom Setup

tests/RobotFramework/tests/tedge/call_tedge_config_list.robot

@@ -351,7 +351,7 @@ set/unset logs.path
     # Undo the change by using the 'unset' command, value returns to default one
     Execute Command    sudo tedge config unset logs.path
     ${unset}    Execute Command    tedge config list
-    Should Contain    ${unset}    logs.path=/var/log
+    Should Contain    ${unset}    logs.path=/var/log/tedge
 
 set/unset run.path
     Execute Command    sudo tedge config set run.path /run1    # Changing run.path