solti-runner 0.0.1

Solti SDK runner plugin trait.
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

//! # Metrics collection abstraction.
//!
//! Provides [`MetricsBackend`] trait and a zero-cost [`NoOpMetrics`] default.
//! Concrete backends (e.g. `solti-prometheus`) implement the trait; the active backend is injected via [`BuildContext`](crate::BuildContext).
//!
//! ## Contents
//!
//! - [`MetricsBackend`]: trait with `record_task_started`, `record_task_completed`, `record_runner_error`.
//! - [`MetricsHandle`]: `Arc<dyn MetricsBackend>`, cloneable shared handle.
//! - [`NoOpMetrics`]: zero-size backend (`#[inline(always)]`, compiles to nothing).
//! - [`RunnerType`]: metric label enum: `Subprocess`, `Wasm`, `Container`.
//! - [`TaskOutcome`]: metric label enum: `Success`, `Failure`, `Canceled`, `Timeout`.
//! - [`noop_metrics`]: convenience constructor for `Arc<NoOpMetrics>`.
mod backend;
pub use backend::{MetricsBackend, MetricsHandle, RunnerType, TaskOutcome};

mod noop;
pub use noop::NoOpMetrics;

use std::sync::Arc;

/// Create a no-op metrics handle.
#[inline]
pub fn noop_metrics() -> MetricsHandle {
    Arc::new(NoOpMetrics)
}