rust-tokio-supervisor 0.1.2

A Rust tokio supervisor with declarative task supervision, restart policy, shutdown coordination, and observability.
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

//! Tracing signal records for lifecycle events.
//!
//! The module defines project-owned tracing data that can be sent to a concrete
//! tracing subscriber by higher-level runtime code.

use crate::event::payload::SupervisorEvent;
use serde::{Deserialize, Serialize};

/// Tracing span metadata for a child attempt.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct AttemptSpan {
    /// Span name used for tracing output.
    pub name: String,
    /// Event sequence that opened the span.
    pub sequence: u64,
    /// Correlation identifier shared with the event.
    pub correlation_id: String,
    /// Child identifier when the event has one.
    pub child_id: Option<String>,
}

impl AttemptSpan {
    /// Creates span metadata from a supervisor event.
    ///
    /// # Arguments
    ///
    /// - `event`: Lifecycle event that starts or describes an attempt.
    ///
    /// # Returns
    ///
    /// Returns an [`AttemptSpan`] value.
    ///
    /// # Examples
    ///
    /// ```
    /// let time = rust_supervisor::event::time::EventTime::deterministic(
    ///     1,
    ///     1,
    ///     0,
    ///     rust_supervisor::id::types::Generation::initial(),
    ///     rust_supervisor::id::types::Attempt::first(),
    /// );
    /// let event = rust_supervisor::event::payload::SupervisorEvent::new(
    ///     rust_supervisor::event::time::When::new(time),
    ///     rust_supervisor::event::payload::Where::new(
    ///         rust_supervisor::id::types::SupervisorPath::root(),
    ///     ),
    ///     rust_supervisor::event::payload::What::ChildStarting { transition: None },
    ///     rust_supervisor::event::time::EventSequence::new(1),
    ///     rust_supervisor::event::time::CorrelationId::from_uuid(uuid::Uuid::nil()),
    ///     1,
    /// );
    /// let span = rust_supervisor::observe::tracing::AttemptSpan::from_event(&event);
    /// assert_eq!(span.name, "supervisor.child_attempt");
    /// ```
    pub fn from_event(event: &SupervisorEvent) -> Self {
        Self {
            name: "supervisor.child_attempt".to_owned(),
            sequence: event.sequence.value,
            correlation_id: event.correlation_id.value.to_string(),
            child_id: event
                .r#where
                .child_id
                .as_ref()
                .map(std::string::ToString::to_string),
        }
    }
}

/// Tracing event metadata derived from a lifecycle event.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct TracingEvent {
    /// Tracing event name.
    pub name: String,
    /// Event sequence.
    pub sequence: u64,
    /// Correlation identifier shared with other observability signals.
    pub correlation_id: String,
    /// Event payload name.
    pub payload: String,
}

impl TracingEvent {
    /// Creates tracing event metadata from a supervisor event.
    ///
    /// # Arguments
    ///
    /// - `event`: Lifecycle event to translate.
    ///
    /// # Returns
    ///
    /// Returns a [`TracingEvent`] value.
    pub fn from_event(event: &SupervisorEvent) -> Self {
        Self {
            name: "supervisor.lifecycle_event".to_owned(),
            sequence: event.sequence.value,
            correlation_id: event.correlation_id.value.to_string(),
            payload: event.what.name().to_owned(),
        }
    }
}