neo3 1.3.0

Production-ready Rust SDK for Neo N3 blockchain with high-level API, unified error handling, and enterprise features
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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157

//! # Monitoring
//!
//! This module provides monitoring infrastructure for health checks, metrics,
//! and distributed tracing. It is intentionally framework-neutral: the SDK keeps
//! in-process registries and tracing spans, while applications choose how to
//! export them.

pub mod health;
pub mod metrics;
pub mod tracing;

use once_cell::sync::Lazy;
use std::sync::Arc;

/// Global monitoring configuration
pub static MONITORING: Lazy<Arc<MonitoringConfig>> =
	Lazy::new(|| Arc::new(MonitoringConfig::from_env()));

/// Monitoring configuration
#[derive(Debug, Clone)]
#[non_exhaustive]
pub struct MonitoringConfig {
	pub metrics_enabled: bool,
	pub metrics_port: u16,
	pub tracing_enabled: bool,
	pub tracing_endpoint: String,
	pub log_level: String,
	pub health_check_enabled: bool,
	pub health_check_port: u16,
}

impl MonitoringConfig {
	/// Creates a new builder for the configuration
	pub fn builder() -> MonitoringConfigBuilder {
		MonitoringConfigBuilder::default()
	}
}

/// Builder for `MonitoringConfig`
#[derive(Debug, Default, Clone)]
pub struct MonitoringConfigBuilder {
	metrics_enabled: Option<bool>,
	metrics_port: Option<u16>,
	tracing_enabled: Option<bool>,
	tracing_endpoint: Option<String>,
	log_level: Option<String>,
	health_check_enabled: Option<bool>,
	health_check_port: Option<u16>,
}

impl MonitoringConfigBuilder {
	pub fn metrics_enabled(mut self, val: bool) -> Self {
		self.metrics_enabled = Some(val);
		self
	}

	pub fn metrics_port(mut self, val: u16) -> Self {
		self.metrics_port = Some(val);
		self
	}

	pub fn tracing_enabled(mut self, val: bool) -> Self {
		self.tracing_enabled = Some(val);
		self
	}

	pub fn tracing_endpoint(mut self, val: String) -> Self {
		self.tracing_endpoint = Some(val);
		self
	}

	pub fn log_level(mut self, val: String) -> Self {
		self.log_level = Some(val);
		self
	}

	pub fn health_check_enabled(mut self, val: bool) -> Self {
		self.health_check_enabled = Some(val);
		self
	}

	pub fn health_check_port(mut self, val: u16) -> Self {
		self.health_check_port = Some(val);
		self
	}

	/// Builds the `MonitoringConfig`. Missing fields fallback to defaults or environment variables.
	pub fn build(self) -> MonitoringConfig {
		let env_default = MonitoringConfig::from_env();
		MonitoringConfig {
			metrics_enabled: self.metrics_enabled.unwrap_or(env_default.metrics_enabled),
			metrics_port: self.metrics_port.unwrap_or(env_default.metrics_port),
			tracing_enabled: self.tracing_enabled.unwrap_or(env_default.tracing_enabled),
			tracing_endpoint: self.tracing_endpoint.unwrap_or(env_default.tracing_endpoint),
			log_level: self.log_level.unwrap_or(env_default.log_level),
			health_check_enabled: self
				.health_check_enabled
				.unwrap_or(env_default.health_check_enabled),
			health_check_port: self.health_check_port.unwrap_or(env_default.health_check_port),
		}
	}
}

impl MonitoringConfig {
	/// Create configuration from environment variables
	pub fn from_env() -> Self {
		Self {
			metrics_enabled: std::env::var("NEO_METRICS_ENABLED")
				.unwrap_or_else(|_| "true".to_string())
				.parse()
				.unwrap_or(true),
			metrics_port: std::env::var("NEO_METRICS_PORT")
				.unwrap_or_else(|_| "9090".to_string())
				.parse()
				.unwrap_or(9090),
			tracing_enabled: std::env::var("NEO_TRACING_ENABLED")
				.unwrap_or_else(|_| "true".to_string())
				.parse()
				.unwrap_or(true),
			tracing_endpoint: std::env::var("NEO_TRACING_ENDPOINT")
				.unwrap_or_else(|_| "http://localhost:4317".to_string()),
			log_level: std::env::var("NEO_LOG_LEVEL").unwrap_or_else(|_| "info".to_string()),
			health_check_enabled: std::env::var("NEO_HEALTH_CHECK_ENABLED")
				.unwrap_or_else(|_| "true".to_string())
				.parse()
				.unwrap_or(true),
			health_check_port: std::env::var("NEO_HEALTH_CHECK_PORT")
				.unwrap_or_else(|_| "8080".to_string())
				.parse()
				.unwrap_or(8080),
		}
	}
}

/// Initialize monitoring subsystems.
pub fn init() -> Result<(), Box<dyn std::error::Error>> {
	if MONITORING.metrics_enabled {
		metrics::init(MONITORING.metrics_port)?;
	}

	if MONITORING.tracing_enabled {
		tracing::init(&MONITORING.tracing_endpoint, &MONITORING.log_level)?;
	}

	if MONITORING.health_check_enabled {
		health::init(MONITORING.health_check_port)?;
	}

	Ok(())
}

/// Shutdown monitoring subsystems.
pub fn shutdown() {
	metrics::shutdown();
	tracing::shutdown();
	health::shutdown();
}