memfaultd 1.26.1

Memfault daemon for embedded Linux systems. Observability, logging, crash reporting, and updating all in one service. Learn more at https://docs.memfault.com/
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

//
// Copyright (c) Memfault, Inc.
// See License.txt for details
use std::path::PathBuf;

use crate::{
    config::{Config, PersistStorageConfig},
    mar::Metadata,
};

#[derive(Clone, Debug)]
pub struct MarConfig {
    tmp_dir: PathBuf,
    persist_dir: PathBuf,
    persist_config: Option<PersistStorageConfig>,
}

impl MarConfig {
    pub fn final_staging_path(&self, mar_metadata: &Metadata) -> PathBuf {
        let use_persist_dir =
            self.persist_config
                .as_ref()
                .is_some_and(|config| match mar_metadata {
                    Metadata::LinuxLogs { .. } => config.logs,
                    Metadata::DeviceAttributes { .. } => config.metrics,
                    Metadata::DeviceConfig { .. } => false,
                    Metadata::ElfCoredump { .. } => config.coredumps,
                    Metadata::LinuxReboot { .. } => config.reboots,
                    Metadata::LinuxHeartbeat { .. } => config.metrics,
                    Metadata::LinuxMetricReport { .. } => config.metrics,
                    Metadata::LinuxCustomTrace { .. } => config.coredumps,
                    Metadata::CustomDataRecording { .. } => false,
                    Metadata::Stacktrace { .. } => config.coredumps,
                });

        if use_persist_dir {
            self.persist_dir.clone()
        } else {
            self.tmp_dir.clone()
        }
    }

    pub fn tmp_staging_path(&self) -> PathBuf {
        self.tmp_dir.clone()
    }
}

impl From<&Config> for MarConfig {
    fn from(config: &Config) -> Self {
        Self {
            tmp_dir: config.mar_tmp_staging_path(),
            persist_dir: config.mar_persist_staging_path(),
            persist_config: config.mar_persist_storage_config().copied(),
        }
    }
}

#[cfg(test)]
mod test {
    use rstest::rstest;
    use std::{fs::create_dir_all, path::Path};

    use tempfile::TempDir;

    use super::*;

    #[rstest]
    #[case(Metadata::test_fixture_metrics(), true)]
    #[case(Metadata::test_fixture_reboot(), false)]
    fn test_final_staging_path(#[case] metadata: Metadata, #[case] moved_to_persist: bool) {
        let tmp_dir = TempDir::new().unwrap();
        let tmp_path = tmp_dir.path();

        let tmp_staging_dir = tmp_path.join("tmp");
        let persist_staging_dir = tmp_path.join("persist");
        create_dir_all(&tmp_staging_dir).unwrap();
        create_dir_all(&persist_staging_dir).unwrap();

        let persist_config = PersistStorageConfig {
            logs: true,
            metrics: true,
            coredumps: true,
            reboots: false,
            min_headroom: 1024,
            max_usage: 1024 * 1024 * 1024,
            min_inodes: 1024,
        };

        let config = MarConfig::test_fixture_with_config(
            &tmp_staging_dir,
            &persist_staging_dir,
            persist_config,
        );

        let final_path = config.final_staging_path(&metadata);
        assert_eq!(
            final_path.starts_with(&persist_staging_dir),
            moved_to_persist
        );
    }

    impl MarConfig {
        pub fn test_fixture(tmp_dir: &Path, persist_dir: &Path) -> Self {
            Self {
                tmp_dir: tmp_dir.to_path_buf(),
                persist_dir: persist_dir.to_path_buf(),
                persist_config: None,
            }
        }

        pub fn test_fixture_with_config(
            tmp_dir: &Path,
            persist_dir: &Path,
            persist_config: PersistStorageConfig,
        ) -> Self {
            Self {
                tmp_dir: tmp_dir.to_path_buf(),
                persist_dir: persist_dir.to_path_buf(),
                persist_config: Some(persist_config),
            }
        }
    }
}