joule-profiler-core 2.1.0

Core library for joule-profiler, handling orchestration and energy measurements
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

use crate::orchestrator::error::OrchestratorError;
use crate::source::error::MetricSourceError;
use thiserror::Error;

/// Top-level error type for `JouleProfiler`.
///
/// Represents all possible errors that can occur during profiler execution,
/// from initialization and orchestration to source errors and aggregation.
#[derive(Debug, Error)]
pub enum JouleProfilerError {
    /// The profiled command failed during execution.
    #[error("Failed to execute command: {0}")]
    CommandExecutionFailed(String),

    /// The profiled command binary was not found on the system.
    #[error("Command not found: {0}")]
    CommandNotFound(String),

    #[error("The provided command is empty.")]
    EmptyCommand,

    /// The output file could not be created at the given path.
    #[error("Failed to create output file: {0}")]
    OutputFileCreationFailed(String),

    /// The provided token pattern is not a valid regular expression.
    #[error("Invalid regex pattern: {0}")]
    InvalidPattern(#[from] regex::Error),

    /// Failed to capture the profiled command's stdout.
    #[error("Stdout capture failed")]
    StdOutCaptureFail,

    /// Failed to retrieve `SUDO_USER` environment variable.
    #[error(
        "Cannot retrieve SUDO_USER environment variable, please retry without root privileges or use \"--use-root\" CLI argument."
    )]
    CannotRetrieveSudoUser,

    /// The environment variable exists but is not parsable into the wanted format.
    #[error("Unable to parse {0} environment variable.")]
    CannotParseEnvVariable(String),

    /// Unable to retrieve the current effective user id by it's name with the `getpwnam` libc function.
    #[error("Unable to retrieve current user id by it's name.")]
    CannotRetrieveCurrentUserId,

    /// Cannot convert string to a known metric unit.
    #[error("Invalid metric unit: {0}")]
    InvalidUnit(String),

    /// Generic I/O error.
    #[error("I/O error")]
    IoError(
        #[from]
        #[source]
        std::io::Error,
    ),

    /// Returned when there's no metric sources configured to profile the program with.
    #[error("No metric sources configured.")]
    NoSourceConfigured,

    /// A process control operation (e.g. kill, wait) failed.
    #[error("Process control failed: {0}")]
    ProcessControlFailed(String),

    /// Failed to spawn the stdout reader thread.
    #[error("Failed to spawn stdout reader thread: {0}")]
    ReaderThreadSpawnFailed(String),

    /// The stdout reader thread panicked before completing.
    #[error("Stdout reader thread panicked")]
    ReaderThreadPanicked,

    /// Error propagated from a metric source.
    #[error("Metric source error.")]
    MetricSourceError(#[from] MetricSourceError),

    /// Error propagated from the source orchestrator.
    #[error("Orchestrator error.")]
    OrchestratorError(#[from] OrchestratorError),
}