shepherd-rs 0.2.0

Shepherd is a resilient, non-blocking orchestrator that persistently transforms and delivers data—built for remote, compute-heavy workloads.
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

//! # Instrumentation Trait
//!
//! This trait defines the behavior of instrumentation in the shepherd
//! framework.
//!
//! ## Overview
//! - **Instrumentation**: Tracks events and provides monitoring capabilities.
//! - **Event Handling**: Handles transformation and consumption events.
//!
//! ## Example
//! ```rust
//! struct MyInstrumentation;
//!
//! impl Instrumentation for MyInstrumentation {
//!     // Implementation details...
//! }
//! ```

use std::sync::Arc;

use async_trait::async_trait;
use tokio::sync::Mutex;

use crate::config::Config;

#[async_trait]
pub trait Instrumentation: Send + Sync {
    type TransformRequestIdentifier;
    type TransformAttemptIdentifier;
    type ConsumeAttemptIdentifier;
    type Config: Config;

    async fn new(config: Arc<Mutex<Self::Config>>) -> Result<Self, String>
    where
        Self: Sized;

    async fn instrumentation_loop(&mut self) -> Result<(), String>;

    fn request_added(&mut self, request_id: Self::TransformRequestIdentifier);
    fn request_completed(&mut self, request_id: Self::TransformRequestIdentifier);
    fn transform_attempt_started(&mut self, request_id: Self::TransformAttemptIdentifier);
    fn transform_attempt_completed(&mut self, request_id: Self::TransformAttemptIdentifier);
    fn transform_attempt_failed(&mut self, request_id: Self::TransformAttemptIdentifier);
    fn consume_attempt_started(&mut self, request_id: Self::ConsumeAttemptIdentifier);
    fn consume_attempt_completed(&mut self, request_id: Self::ConsumeAttemptIdentifier);
    fn consume_attempt_failed(&mut self, request_id: Self::ConsumeAttemptIdentifier);
}