mirror of
https://github.com/rustfs/rustfs.git
synced 2026-08-05 12:57:42 +00:00
evan slack
229 lines
9.2 KiB
Rust
229 lines
9.2 KiB
Rust
// Copyright 2024 RustFS Team
|
||
//
|
||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||
// you may not use this file except in compliance with the License.
|
||
// You may obtain a copy of the License at
|
||
//
|
||
// http://www.apache.org/licenses/LICENSE-2.0
|
||
//
|
||
// Unless required by applicable law or agreed to in writing, software
|
||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
// See the License for the specific language governing permissions and
|
||
// limitations under the License.
|
||
|
||
use rustfs_config::observability::{
|
||
DEFAULT_OBS_ENVIRONMENT_PRODUCTION, ENV_OBS_ENDPOINT, ENV_OBS_ENVIRONMENT, ENV_OBS_LOG_DIRECTORY, ENV_OBS_LOG_ENDPOINT,
|
||
ENV_OBS_LOG_FILENAME, ENV_OBS_LOG_KEEP_FILES, ENV_OBS_LOG_ROTATION_SIZE_MB, ENV_OBS_LOG_ROTATION_TIME,
|
||
ENV_OBS_LOG_STDOUT_ENABLED, ENV_OBS_LOGGER_LEVEL, ENV_OBS_LOGS_EXPORT_ENABLED, ENV_OBS_METER_INTERVAL,
|
||
ENV_OBS_METRIC_ENDPOINT, ENV_OBS_METRICS_EXPORT_ENABLED, ENV_OBS_SAMPLE_RATIO, ENV_OBS_SERVICE_NAME, ENV_OBS_SERVICE_VERSION,
|
||
ENV_OBS_TRACE_ENDPOINT, ENV_OBS_TRACES_EXPORT_ENABLED, ENV_OBS_USE_STDOUT,
|
||
};
|
||
use rustfs_config::{
|
||
APP_NAME, DEFAULT_LOG_KEEP_FILES, DEFAULT_LOG_LEVEL, DEFAULT_LOG_ROTATION_SIZE_MB, DEFAULT_LOG_ROTATION_TIME,
|
||
DEFAULT_OBS_LOG_FILENAME, DEFAULT_OBS_LOG_STDOUT_ENABLED, DEFAULT_OBS_LOGS_EXPORT_ENABLED,
|
||
DEFAULT_OBS_METRICS_EXPORT_ENABLED, DEFAULT_OBS_TRACES_EXPORT_ENABLED, ENVIRONMENT, METER_INTERVAL, SAMPLE_RATIO,
|
||
SERVICE_VERSION, USE_STDOUT,
|
||
};
|
||
use rustfs_utils::dirs::get_log_directory_to_string;
|
||
use rustfs_utils::{get_env_bool, get_env_f64, get_env_opt_str, get_env_str, get_env_u64, get_env_usize};
|
||
use serde::{Deserialize, Serialize};
|
||
use std::env;
|
||
|
||
/// Observability: OpenTelemetry configuration
|
||
/// # Fields
|
||
/// * `endpoint`: Endpoint for metric collection
|
||
/// * `use_stdout`: Output to stdout
|
||
/// * `sample_ratio`: Trace sampling ratio
|
||
/// * `meter_interval`: Metric collection interval
|
||
/// * `service_name`: Service name
|
||
/// * `service_version`: Service version
|
||
/// * `environment`: Environment
|
||
/// * `logger_level`: Logger level
|
||
/// * `local_logging_enabled`: Local logging enabled
|
||
/// # Added flexi_logger related configurations
|
||
/// * `log_directory`: Log file directory
|
||
/// * `log_filename`: The name of the log file
|
||
/// * `log_rotation_size_mb`: Log file size cut threshold (MB)
|
||
/// * `log_rotation_time`: Logs are cut by time (Hour,Day,Minute,Second)
|
||
/// * `log_keep_files`: Number of log files to be retained
|
||
/// # Returns
|
||
/// A new instance of OtelConfig
|
||
///
|
||
/// # Example
|
||
/// ```no_run
|
||
/// use rustfs_obs::OtelConfig;
|
||
///
|
||
/// let config = OtelConfig::new();
|
||
/// ```
|
||
#[derive(Debug, Deserialize, Serialize, Clone)]
|
||
pub struct OtelConfig {
|
||
pub endpoint: String, // Endpoint for otel collection
|
||
pub trace_endpoint: Option<String>, // Endpoint for trace collection
|
||
pub metric_endpoint: Option<String>, // Endpoint for metric collection
|
||
pub log_endpoint: Option<String>, // Endpoint for log collection
|
||
pub traces_export_enabled: Option<bool>, // Enable/disable trace export
|
||
pub metrics_export_enabled: Option<bool>, // Enable/disable metric export
|
||
pub logs_export_enabled: Option<bool>, // Enable/disable log export
|
||
pub use_stdout: Option<bool>, // Output to stdout
|
||
pub sample_ratio: Option<f64>, // Trace sampling ratio
|
||
pub meter_interval: Option<u64>, // Metric collection interval
|
||
pub service_name: Option<String>, // Service name
|
||
pub service_version: Option<String>, // Service version
|
||
pub environment: Option<String>, // Environment
|
||
pub logger_level: Option<String>, // Logger level
|
||
pub log_stdout_enabled: Option<bool>, // Stdout logging enabled
|
||
// Added flexi_logger related configurations
|
||
pub log_directory: Option<String>, // LOG FILE DIRECTORY
|
||
pub log_filename: Option<String>, // The name of the log file
|
||
pub log_rotation_size_mb: Option<u64>, // Log file size cut threshold (MB)
|
||
pub log_rotation_time: Option<String>, // Logs are cut by time (Hour， Day，Minute， Second)
|
||
pub log_keep_files: Option<usize>, // Number of log files to be retained
|
||
}
|
||
|
||
impl OtelConfig {
|
||
/// Helper function: Extract observable configuration from environment variables
|
||
pub fn extract_otel_config_from_env(endpoint: Option<String>) -> OtelConfig {
|
||
let endpoint = if let Some(endpoint) = endpoint {
|
||
if endpoint.is_empty() {
|
||
env::var(ENV_OBS_ENDPOINT).unwrap_or_else(|_| "".to_string())
|
||
} else {
|
||
endpoint
|
||
}
|
||
} else {
|
||
env::var(ENV_OBS_ENDPOINT).unwrap_or_else(|_| "".to_string())
|
||
};
|
||
let mut use_stdout = get_env_bool(ENV_OBS_USE_STDOUT, USE_STDOUT);
|
||
if endpoint.is_empty() {
|
||
use_stdout = true;
|
||
}
|
||
|
||
OtelConfig {
|
||
endpoint,
|
||
trace_endpoint: get_env_opt_str(ENV_OBS_TRACE_ENDPOINT),
|
||
metric_endpoint: get_env_opt_str(ENV_OBS_METRIC_ENDPOINT),
|
||
log_endpoint: get_env_opt_str(ENV_OBS_LOG_ENDPOINT),
|
||
traces_export_enabled: Some(get_env_bool(ENV_OBS_TRACES_EXPORT_ENABLED, DEFAULT_OBS_TRACES_EXPORT_ENABLED)),
|
||
metrics_export_enabled: Some(get_env_bool(ENV_OBS_METRICS_EXPORT_ENABLED, DEFAULT_OBS_METRICS_EXPORT_ENABLED)),
|
||
logs_export_enabled: Some(get_env_bool(ENV_OBS_LOGS_EXPORT_ENABLED, DEFAULT_OBS_LOGS_EXPORT_ENABLED)),
|
||
use_stdout: Some(use_stdout),
|
||
sample_ratio: Some(get_env_f64(ENV_OBS_SAMPLE_RATIO, SAMPLE_RATIO)),
|
||
meter_interval: Some(get_env_u64(ENV_OBS_METER_INTERVAL, METER_INTERVAL)),
|
||
service_name: Some(get_env_str(ENV_OBS_SERVICE_NAME, APP_NAME)),
|
||
service_version: Some(get_env_str(ENV_OBS_SERVICE_VERSION, SERVICE_VERSION)),
|
||
environment: Some(get_env_str(ENV_OBS_ENVIRONMENT, ENVIRONMENT)),
|
||
logger_level: Some(get_env_str(ENV_OBS_LOGGER_LEVEL, DEFAULT_LOG_LEVEL)),
|
||
log_stdout_enabled: Some(get_env_bool(ENV_OBS_LOG_STDOUT_ENABLED, DEFAULT_OBS_LOG_STDOUT_ENABLED)),
|
||
log_directory: Some(get_log_directory_to_string(ENV_OBS_LOG_DIRECTORY)),
|
||
log_filename: Some(get_env_str(ENV_OBS_LOG_FILENAME, DEFAULT_OBS_LOG_FILENAME)),
|
||
log_rotation_size_mb: Some(get_env_u64(ENV_OBS_LOG_ROTATION_SIZE_MB, DEFAULT_LOG_ROTATION_SIZE_MB)), // Default to 100 MB
|
||
log_rotation_time: Some(get_env_str(ENV_OBS_LOG_ROTATION_TIME, DEFAULT_LOG_ROTATION_TIME)), // Default to "Hour"
|
||
log_keep_files: Some(get_env_usize(ENV_OBS_LOG_KEEP_FILES, DEFAULT_LOG_KEEP_FILES)), // Default to keeping 30 log files
|
||
}
|
||
}
|
||
|
||
/// Create a new instance of OtelConfig with default values
|
||
///
|
||
/// # Returns
|
||
/// A new instance of OtelConfig
|
||
///
|
||
/// # Example
|
||
/// ```no_run
|
||
/// use rustfs_obs::OtelConfig;
|
||
///
|
||
/// let config = OtelConfig::new();
|
||
/// ```
|
||
pub fn new() -> Self {
|
||
Self::extract_otel_config_from_env(None)
|
||
}
|
||
}
|
||
|
||
/// Implement Default trait for OtelConfig
|
||
/// This allows creating a default instance of OtelConfig using OtelConfig::default()
|
||
/// which internally calls OtelConfig::new()
|
||
///
|
||
/// # Example
|
||
/// ```no_run
|
||
/// use rustfs_obs::OtelConfig;
|
||
///
|
||
/// let config = OtelConfig::default();
|
||
/// ```
|
||
impl Default for OtelConfig {
|
||
fn default() -> Self {
|
||
Self::new()
|
||
}
|
||
}
|
||
|
||
/// Overall application configuration
|
||
/// Add observability configuration
|
||
///
|
||
/// Observability: OpenTelemetry configuration
|
||
///
|
||
/// # Example
|
||
/// ```
|
||
/// use rustfs_obs::AppConfig;
|
||
///
|
||
/// let config = AppConfig::new_with_endpoint(None);
|
||
/// ```
|
||
#[derive(Debug, Deserialize, Clone)]
|
||
pub struct AppConfig {
|
||
pub observability: OtelConfig,
|
||
}
|
||
|
||
impl AppConfig {
|
||
/// Create a new instance of AppConfig with default values
|
||
///
|
||
/// # Returns
|
||
/// A new instance of AppConfig
|
||
pub fn new() -> Self {
|
||
Self {
|
||
observability: OtelConfig::default(),
|
||
}
|
||
}
|
||
|
||
/// Create a new instance of AppConfig with specified endpoint
|
||
///
|
||
/// # Arguments
|
||
/// * `endpoint` - An optional string representing the endpoint for metric collection
|
||
///
|
||
/// # Returns
|
||
/// A new instance of AppConfig
|
||
///
|
||
/// # Example
|
||
/// ```no_run
|
||
/// use rustfs_obs::AppConfig;
|
||
///
|
||
/// let config = AppConfig::new_with_endpoint(Some("http://localhost:4318".to_string()));
|
||
/// ```
|
||
pub fn new_with_endpoint(endpoint: Option<String>) -> Self {
|
||
Self {
|
||
observability: OtelConfig::extract_otel_config_from_env(endpoint),
|
||
}
|
||
}
|
||
}
|
||
|
||
/// Implement Default trait for AppConfig
|
||
/// This allows creating a default instance of AppConfig using AppConfig::default()
|
||
/// which internally calls AppConfig::new()
|
||
///
|
||
/// # Example
|
||
/// ```no_run
|
||
/// use rustfs_obs::AppConfig;
|
||
///
|
||
/// let config = AppConfig::default();
|
||
/// ```
|
||
impl Default for AppConfig {
|
||
fn default() -> Self {
|
||
Self::new()
|
||
}
|
||
}
|
||
|
||
/// Check if the current environment is production
|
||
///
|
||
/// # Returns
|
||
/// true if production, false otherwise
|
||
///
|
||
pub fn is_production_environment() -> bool {
|
||
get_env_str(ENV_OBS_ENVIRONMENT, ENVIRONMENT).eq_ignore_ascii_case(DEFAULT_OBS_ENVIRONMENT_PRODUCTION)
|
||
}
|