zentinel-common 0.6.21

Common utilities and types for Zentinel reverse proxy
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

//! Common utilities and shared components for Zentinel proxy
//!
//! This crate provides shared functionality used across all Zentinel components,
//! including observability (metrics, logging, tracing), error types, and common utilities.
//!
//! # Module Organization
//!
//! - [`ids`]: Type-safe identifier newtypes (CorrelationId, RequestId, etc.)
//! - [`types`]: Common type definitions (ByteSize, Priority, etc.)
//! - [`errors`]: Error types and result aliases
//! - [`limits`]: Resource limits and rate limiting
//! - [`observability`]: Metrics, logging, and tracing (runtime only)
//! - [`circuit_breaker`]: Circuit breaker state machine (runtime only)
//! - [`registry`]: Generic type-safe registry abstraction (runtime only)

pub mod budget;
#[cfg(feature = "runtime")]
pub mod circuit_breaker;
pub mod errors;
pub mod ids;
pub mod inference;
pub mod limits;
#[cfg(feature = "runtime")]
pub mod observability;
#[cfg(feature = "runtime")]
pub mod registry;
#[cfg(feature = "runtime")]
pub mod scoped_metrics;
#[cfg(feature = "runtime")]
pub mod scoped_registry;
pub mod types;

// Re-export commonly used items at the crate root (runtime only)
#[cfg(feature = "runtime")]
pub use observability::{
    init_tracing, AuditLogEntry, ComponentHealth, ComponentHealthTracker, HealthStatus,
    RequestMetrics,
};

// Backwards compatibility alias (deprecated, use ComponentHealthTracker)
#[cfg(feature = "runtime")]
#[deprecated(since = "0.2.0", note = "Use ComponentHealthTracker instead")]
pub type HealthChecker = ComponentHealthTracker;

// Re-export error types
pub use errors::{ZentinelError, ZentinelResult};

// Re-export limit types
pub use limits::{Limits, RateLimiter};

// Re-export identifier types
pub use ids::{AgentId, CorrelationId, QualifiedId, RequestId, RouteId, Scope, UpstreamId};

// Re-export common types
pub use types::{CircuitBreakerConfig, TraceIdFormat};

// Re-export inference types
pub use inference::{
    ColdModelAction, InferenceProbeConfig, InferenceReadinessConfig, ModelStatusConfig,
    QueueDepthConfig, WarmthDetectionConfig,
};

// Re-export circuit breaker (runtime only)
#[cfg(feature = "runtime")]
pub use circuit_breaker::CircuitBreaker;

// Re-export registries (runtime only)
#[cfg(feature = "runtime")]
pub use registry::Registry;
#[cfg(feature = "runtime")]
pub use scoped_registry::ScopedRegistry;

// Re-export scoped metrics (runtime only)
#[cfg(feature = "runtime")]
pub use scoped_metrics::{ScopeLabels, ScopedMetrics};

// Re-export budget types
pub use budget::{
    BudgetAlert, BudgetCheckResult, BudgetPeriod, CostAttributionConfig, CostResult, ModelPricing,
    TenantBudgetStatus, TokenBudgetConfig,
};