rs-zero 0.2.7

Rust-first microservice framework inspired by go-zero engineering practices
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

use std::time::Duration;

use crate::core::{CoreError, CoreResult};

/// Running profiling handle.
pub struct ProfilingHandle {
    inner: ProfilingHandleInner,
    shutdown_timeout: Duration,
}

enum ProfilingHandleInner {
    Disabled,
    Pyroscope(Option<pyroscope::PyroscopeAgent<pyroscope::pyroscope::PyroscopeAgentRunning>>),
}

impl ProfilingHandle {
    /// Creates a disabled handle that can be shut down safely.
    pub fn disabled() -> Self {
        Self {
            inner: ProfilingHandleInner::Disabled,
            shutdown_timeout: Duration::ZERO,
        }
    }

    pub(crate) fn pyroscope(
        agent: pyroscope::PyroscopeAgent<pyroscope::pyroscope::PyroscopeAgentRunning>,
        shutdown_timeout: Duration,
    ) -> Self {
        Self {
            inner: ProfilingHandleInner::Pyroscope(Some(agent)),
            shutdown_timeout,
        }
    }

    /// Returns whether profiling is currently running.
    pub fn is_running(&self) -> bool {
        matches!(self.inner, ProfilingHandleInner::Pyroscope(Some(_)))
    }

    /// Stops the profiler and releases agent resources.
    pub fn shutdown(mut self) -> CoreResult<()> {
        let ProfilingHandleInner::Pyroscope(agent) = &mut self.inner else {
            return Ok(());
        };
        let Some(agent) = agent.take() else {
            return Ok(());
        };
        let started_at = std::time::Instant::now();
        let ready = agent
            .stop()
            .map_err(|error| CoreError::Profiling(error.to_string()))?;
        ready.shutdown();
        if !self.shutdown_timeout.is_zero() && started_at.elapsed() > self.shutdown_timeout {
            return Err(CoreError::Profiling(format!(
                "pyroscope shutdown exceeded {:?}",
                self.shutdown_timeout
            )));
        }
        Ok(())
    }
}

impl std::fmt::Debug for ProfilingHandle {
    fn fmt(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        formatter
            .debug_struct("ProfilingHandle")
            .field("running", &self.is_running())
            .field("shutdown_timeout", &self.shutdown_timeout)
            .finish()
    }
}