rename rustfs-logging to rustfs-obs

2026-08-13 00:26:53 +00:00 · 2025-03-09 10:47:03 +08:00
parent 4ecb53c526
commit bcab86fc38
8 changed files with 181 additions and 32 deletions
@@ -0,0 +1,190 @@
+//! Logging utilities
+
+///
+/// This crate provides utilities for logging.
+///
+/// # Examples
+/// ```
+/// use rustfs_obs::{log_info, log_error};
+///
+/// log_info("This is an informational message");
+/// log_error("This is an error message");
+/// ```
+#[cfg(feature = "audit-kafka")]
+pub use audit::KafkaAuditTarget;
+#[cfg(feature = "audit-webhook")]
+pub use audit::WebhookAuditTarget;
+pub use audit::{AuditEntry, AuditLogger, AuditTarget, FileAuditTarget};
+pub use logger::{log_debug, log_error, log_info};
+pub use telemetry::Telemetry;
+
+mod audit;
+mod logger;
+mod telemetry;
+
+#[cfg(test)]
+mod tests {
+    use crate::{log_info, AuditEntry, AuditLogger, AuditTarget, FileAuditTarget, Telemetry};
+    use chrono::Utc;
+    use opentelemetry::global;
+    use opentelemetry::trace::{TraceContextExt, Tracer};
+    use std::time::{Duration, SystemTime};
+    use tracing::{instrument, Span};
+    use tracing_opentelemetry::OpenTelemetrySpanExt;
+
+    #[instrument(fields(bucket, object, user))]
+    async fn put_object(audit_logger: &AuditLogger, bucket: String, object: String, user: String) {
+        let start_time = SystemTime::now();
+        log_info("Starting PUT operation");
+
+        // Simulate the operation
+        tokio::time::sleep(Duration::from_millis(100)).await;
+
+        // Record Metrics
+        let meter = global::meter("rustfs.rs");
+        let request_duration = meter.f64_histogram("s3_request_duration_seconds").build();
+        request_duration.record(
+            start_time.elapsed().unwrap().as_secs_f64(),
+            &[opentelemetry::KeyValue::new("operation", "put_object")],
+        );
+
+        // Gets the current span
+        let span = Span::current();
+
+        // Use 'OpenTelemetrySpanExt' to get 'SpanContext'
+        let span_context = span.context(); // Get context via OpenTelemetrySpanExt
+        let span_id = span_context.span().span_context().span_id().to_string(); // Get the SpanId
+
+        // Audit events are logged
+        let audit_entry = AuditEntry {
+            version: "1.0".to_string(),
+            event_type: "s3_put_object".to_string(),
+            bucket,
+            object,
+            user,
+            time: Utc::now().to_rfc3339(),
+            user_agent: "rustfs.rs-client".to_string(),
+            span_id,
+        };
+        audit_logger.log(audit_entry).await;
+
+        log_info("PUT operation completed");
+    }
+
+    #[tokio::test]
+    // #[cfg(feature = "audit-webhook")]
+    // #[cfg(feature = "audit-kafka")]
+    async fn test_main() {
+        let telemetry = Telemetry::init();
+
+        // Initialize multiple audit objectives
+        let audit_targets: Vec<Box<dyn AuditTarget>> = vec![
+            Box::new(FileAuditTarget),
+            // Box::new(KafkaAuditTarget::new("localhost:9092", "rustfs-audit")),
+            // Box::new(WebhookAuditTarget::new("http://localhost:8080/audit")),
+        ];
+        let audit_logger = AuditLogger::new(audit_targets);
+
+        // 创建根 Span 并执行操作
+        // let tracer = global::tracer("main");
+        // tracer.in_span("main_operation", |cx| {
+        //     Span::current().set_parent(cx);
+        //     log_info("Starting test async");
+        //     tokio::runtime::Runtime::new().unwrap().block_on(async {
+        log_info("Starting test");
+        // Test the PUT operation
+        put_object(&audit_logger, "my-bucket".to_string(), "my-object.txt".to_string(), "user123".to_string()).await;
+        tokio::time::sleep(Duration::from_millis(100)).await;
+        query_object(&audit_logger, "my-bucket".to_string(), "my-object.txt".to_string(), "user123".to_string()).await;
+        tokio::time::sleep(Duration::from_millis(100)).await;
+        for i in 0..100 {
+            put_object(
+                &audit_logger,
+                format!("my-bucket-{}", i),
+                format!("my-object-{}", i),
+                "user123".to_string(),
+            )
+            .await;
+            tokio::time::sleep(Duration::from_millis(100)).await;
+            query_object(
+                &audit_logger,
+                format!("my-bucket-{}", i),
+                format!("my-object-{}", i),
+                "user123".to_string(),
+            )
+            .await;
+            tokio::time::sleep(Duration::from_millis(100)).await;
+        }
+
+        // Wait for the export to complete
+        tokio::time::sleep(Duration::from_secs(2)).await;
+        log_info("Test completed");
+        //     });
+        // });
+        drop(telemetry); // Make sure to clean up
+    }
+
+    #[instrument(fields(bucket, object, user))]
+    async fn query_object(audit_logger: &AuditLogger, bucket: String, object: String, user: String) {
+        let start_time = SystemTime::now();
+        log_info("Starting query operation");
+
+        // Simulate the operation
+        tokio::time::sleep(Duration::from_millis(100)).await;
+
+        // Record Metrics
+        let meter = global::meter("rustfs.rs");
+        let request_duration = meter.f64_histogram("s3_request_duration_seconds").build();
+        request_duration.record(
+            start_time.elapsed().unwrap().as_secs_f64(),
+            &[opentelemetry::KeyValue::new("operation", "query_object")],
+        );
+
+        // Gets the current span
+        let span = Span::current();
+        // Use 'OpenTelemetrySpanExt' to get 'SpanContext'
+        let span_context = span.context(); // Get context via OpenTelemetrySpanExt
+        let span_id = span_context.span().span_context().span_id().to_string(); // Get the SpanId
+        query_one(user.clone());
+        query_two(user.clone());
+        query_three(user.clone());
+        // Audit events are logged
+        let audit_entry = AuditEntry {
+            version: "1.0".to_string(),
+            event_type: "s3_query_object".to_string(),
+            bucket,
+            object,
+            user,
+            time: Utc::now().to_rfc3339(),
+            user_agent: "rustfs.rs-client".to_string(),
+            span_id,
+        };
+        audit_logger.log(audit_entry).await;
+
+        log_info("query operation completed");
+    }
+    #[instrument(fields(user))]
+    fn query_one(user: String) {
+        // 初始化 OpenTelemetry Tracer
+        let tracer = global::tracer("query_one");
+        tracer.in_span("doing_work", |cx| {
+            // Traced app logic here...
+            Span::current().set_parent(cx);
+            log_info("Doing work...");
+            let current_span = Span::current();
+            let span_context = current_span.context();
+            let trace_id = span_context.clone().span().span_context().trace_id().to_string();
+            let span_id = span_context.clone().span().span_context().span_id().to_string();
+            log_info(format!("trace_id: {}, span_id: {}", trace_id, span_id).as_str());
+        });
+        log_info(format!("Starting query_one operation user:{}", user).as_str());
+    }
+    #[instrument(fields(user))]
+    fn query_two(user: String) {
+        log_info(format!("Starting query_two operation user:{}", user).as_str());
+    }
+    #[instrument(fields(user))]
+    fn query_three(user: String) {
+        log_info(format!("Starting query_three operation user: {}", user).as_str());
+    }
+}