improve code

packages/obs/src/entry/audit.rs

@@ -0,0 +1,88 @@
+use chrono::{DateTime, Utc};
+use serde::{Deserialize, Serialize};
+use serde_json::Value;
+use std::collections::HashMap;
+
+/// ObjectVersion object version key/versionId
+#[derive(Debug, Serialize, Deserialize, Clone)]
+pub struct ObjectVersion {
+    #[serde(rename = "objectName")]
+    pub object_name: String,
+    #[serde(rename = "versionId", skip_serializing_if = "Option::is_none")]
+    pub version_id: Option<String>,
+}
+
+/// API details structure
+#[derive(Debug, Serialize, Deserialize, Clone)]
+pub struct ApiDetails {
+    #[serde(rename = "name", skip_serializing_if = "Option::is_none")]
+    pub name: Option<String>,
+    #[serde(rename = "bucket", skip_serializing_if = "Option::is_none")]
+    pub bucket: Option<String>,
+    #[serde(rename = "object", skip_serializing_if = "Option::is_none")]
+    pub object: Option<String>,
+    #[serde(rename = "objects", skip_serializing_if = "Vec::is_empty", default)]
+    pub objects: Vec<ObjectVersion>,
+    #[serde(rename = "status", skip_serializing_if = "Option::is_none")]
+    pub status: Option<String>,
+    #[serde(rename = "statusCode", skip_serializing_if = "Option::is_none")]
+    pub status_code: Option<i32>,
+    #[serde(rename = "rx")]
+    pub input_bytes: i64,
+    #[serde(rename = "tx")]
+    pub output_bytes: i64,
+    #[serde(rename = "txHeaders", skip_serializing_if = "Option::is_none")]
+    pub header_bytes: Option<i64>,
+    #[serde(rename = "timeToFirstByte", skip_serializing_if = "Option::is_none")]
+    pub time_to_first_byte: Option<String>,
+    #[serde(rename = "timeToFirstByteInNS", skip_serializing_if = "Option::is_none")]
+    pub time_to_first_byte_in_ns: Option<String>,
+    #[serde(rename = "timeToResponse", skip_serializing_if = "Option::is_none")]
+    pub time_to_response: Option<String>,
+    #[serde(rename = "timeToResponseInNS", skip_serializing_if = "Option::is_none")]
+    pub time_to_response_in_ns: Option<String>,
+}
+
+/// Entry - audit entry logs
+#[derive(Debug, Serialize, Deserialize, Clone)]
+pub struct AuditEntry {
+    pub version: String,
+    #[serde(rename = "deploymentid", skip_serializing_if = "Option::is_none")]
+    pub deployment_id: Option<String>,
+    pub time: DateTime<Utc>,
+    pub event: String,
+
+    // Class of audit message - S3, admin ops, bucket management
+    #[serde(rename = "type", skip_serializing_if = "Option::is_none")]
+    pub entry_type: Option<String>,
+
+    // Deprecated, replaced by 'Event'
+    pub trigger: String,
+    pub api: ApiDetails,
+    #[serde(rename = "remotehost", skip_serializing_if = "Option::is_none")]
+    pub remote_host: Option<String>,
+    #[serde(rename = "requestID", skip_serializing_if = "Option::is_none")]
+    pub request_id: Option<String>,
+    #[serde(rename = "userAgent", skip_serializing_if = "Option::is_none")]
+    pub user_agent: Option<String>,
+    #[serde(rename = "requestPath", skip_serializing_if = "Option::is_none")]
+    pub req_path: Option<String>,
+    #[serde(rename = "requestHost", skip_serializing_if = "Option::is_none")]
+    pub req_host: Option<String>,
+    #[serde(rename = "requestClaims", skip_serializing_if = "Option::is_none")]
+    pub req_claims: Option<HashMap<String, Value>>,
+    #[serde(rename = "requestQuery", skip_serializing_if = "Option::is_none")]
+    pub req_query: Option<HashMap<String, String>>,
+    #[serde(rename = "requestHeader", skip_serializing_if = "Option::is_none")]
+    pub req_header: Option<HashMap<String, String>>,
+    #[serde(rename = "responseHeader", skip_serializing_if = "Option::is_none")]
+    pub resp_header: Option<HashMap<String, String>>,
+    #[serde(rename = "tags", skip_serializing_if = "Option::is_none")]
+    pub tags: Option<HashMap<String, Value>>,
+    #[serde(rename = "accessKey", skip_serializing_if = "Option::is_none")]
+    pub access_key: Option<String>,
+    #[serde(rename = "parentUser", skip_serializing_if = "Option::is_none")]
+    pub parent_user: Option<String>,
+    #[serde(rename = "error", skip_serializing_if = "Option::is_none")]
+    pub error: Option<String>,
+}

packages/obs/src/entry/base.rs

@@ -0,0 +1,114 @@
+use chrono::{DateTime, Utc};
+use serde::{Deserialize, Serialize};
+use serde_json::Value;
+use std::collections::HashMap;
+
+/// ObjectVersion object version key/versionId
+#[derive(Debug, Clone, Serialize, Deserialize)]
+pub struct ObjectVersion {
+    #[serde(rename = "objectName")]
+    pub object_name: String,
+    #[serde(rename = "versionId", skip_serializing_if = "Option::is_none")]
+    pub version_id: Option<String>,
+}
+
+/// Args - defines the arguments for the API
+#[derive(Debug, Clone, Serialize, Deserialize)]
+pub struct Args {
+    #[serde(rename = "bucket", skip_serializing_if = "Option::is_none")]
+    pub bucket: Option<String>,
+    #[serde(rename = "object", skip_serializing_if = "Option::is_none")]
+    pub object: Option<String>,
+    #[serde(rename = "versionId", skip_serializing_if = "Option::is_none")]
+    pub version_id: Option<String>,
+    #[serde(rename = "objects", skip_serializing_if = "Option::is_none")]
+    pub objects: Option<Vec<ObjectVersion>>,
+    #[serde(rename = "metadata", skip_serializing_if = "Option::is_none")]
+    pub metadata: Option<HashMap<String, String>>,
+}
+
+/// Trace - defines the trace
+#[derive(Debug, Clone, Serialize, Deserialize)]
+pub struct Trace {
+    #[serde(rename = "message", skip_serializing_if = "Option::is_none")]
+    pub message: Option<String>,
+    #[serde(rename = "source", skip_serializing_if = "Option::is_none")]
+    pub source: Option<Vec<String>>,
+    #[serde(rename = "variables", skip_serializing_if = "Option::is_none")]
+    pub variables: Option<HashMap<String, Value>>,
+}
+
+/// API - defines the api type and its args
+#[derive(Debug, Clone, Serialize, Deserialize)]
+pub struct API {
+    #[serde(rename = "name", skip_serializing_if = "Option::is_none")]
+    pub name: Option<String>,
+    #[serde(rename = "args", skip_serializing_if = "Option::is_none")]
+    pub args: Option<Args>,
+}
+
+/// Log kind/level enum
+#[derive(Debug, Clone, Serialize, Deserialize)]
+pub enum LogKind {
+    #[serde(rename = "INFO")]
+    Info,
+    #[serde(rename = "WARNING")]
+    Warning,
+    #[serde(rename = "ERROR")]
+    Error,
+    #[serde(rename = "FATAL")]
+    Fatal,
+}
+
+/// Entry - defines fields and values of each log entry
+#[derive(Debug, Clone, Serialize, Deserialize)]
+pub struct Entry {
+    #[serde(rename = "site", skip_serializing_if = "Option::is_none")]
+    pub site: Option<String>,
+
+    #[serde(rename = "deploymentid", skip_serializing_if = "Option::is_none")]
+    pub deployment_id: Option<String>,
+
+    pub level: LogKind,
+
+    #[serde(rename = "errKind", skip_serializing_if = "Option::is_none")]
+    pub log_kind: Option<LogKind>, // Deprecated Jan 2024
+
+    pub time: DateTime<Utc>,
+
+    #[serde(rename = "api", skip_serializing_if = "Option::is_none")]
+    pub api: Option<API>,
+
+    #[serde(rename = "remotehost", skip_serializing_if = "Option::is_none")]
+    pub remote_host: Option<String>,
+
+    #[serde(rename = "host", skip_serializing_if = "Option::is_none")]
+    pub host: Option<String>,
+
+    #[serde(rename = "requestID", skip_serializing_if = "Option::is_none")]
+    pub request_id: Option<String>,
+
+    #[serde(rename = "userAgent", skip_serializing_if = "Option::is_none")]
+    pub user_agent: Option<String>,
+
+    #[serde(rename = "message", skip_serializing_if = "Option::is_none")]
+    pub message: Option<String>,
+
+    #[serde(rename = "error", skip_serializing_if = "Option::is_none")]
+    pub trace: Option<Trace>,
+}
+
+/// Info holds console log messages
+#[derive(Debug, Clone, Serialize, Deserialize)]
+pub struct Info {
+    #[serde(flatten)]
+    pub entry: Entry,
+
+    pub console_msg: String,
+
+    #[serde(rename = "node")]
+    pub node_name: String,
+
+    #[serde(skip)]
+    pub err: Option<String>,
+}

packages/obs/src/entry/log.rs

@@ -0,0 +1,83 @@
+use chrono::{DateTime, Utc};
+use serde::de::Error;
+use serde::{Deserialize, Deserializer, Serialize, Serializer};
+use tracing_core::Level;
+
+/// Wrapper for `tracing_core::Level` to implement `Serialize` and `Deserialize`
+#[derive(Debug, Clone)]
+pub struct SerializableLevel(pub Level);
+
+impl From<Level> for SerializableLevel {
+    fn from(level: Level) -> Self {
+        SerializableLevel(level)
+    }
+}
+
+impl From<SerializableLevel> for Level {
+    fn from(serializable_level: SerializableLevel) -> Self {
+        serializable_level.0
+    }
+}
+
+impl Serialize for SerializableLevel {
+    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
+    where
+        S: Serializer,
+    {
+        serializer.serialize_str(self.0.as_str())
+    }
+}
+
+impl<'de> Deserialize<'de> for SerializableLevel {
+    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
+    where
+        D: Deserializer<'de>,
+    {
+        let s = String::deserialize(deserializer)?;
+        match s.as_str() {
+            "TRACE" => Ok(SerializableLevel(Level::TRACE)),
+            "DEBUG" => Ok(SerializableLevel(Level::DEBUG)),
+            "INFO" => Ok(SerializableLevel(Level::INFO)),
+            "WARN" => Ok(SerializableLevel(Level::WARN)),
+            "ERROR" => Ok(SerializableLevel(Level::ERROR)),
+            _ => Err(D::Error::custom("unknown log level")),
+        }
+    }
+}
+
+/// Server log entry structure
+#[derive(Debug, Serialize, Deserialize, Clone)]
+pub struct LogEntry {
+    pub timestamp: DateTime<Utc>,      // Log timestamp
+    pub level: SerializableLevel,      // Log Level
+    pub message: String,               // Log messages
+    pub source: String,                // Log source (such as module name)
+    pub target: Option<String>,        // Log target
+    pub request_id: Option<String>,    // Request ID (Common Server Fields)
+    pub user_id: Option<String>,       // User ID (Common Server Fields)
+    pub fields: Vec<(String, String)>, // Attached fields (key value pairs)
+}
+
+impl LogEntry {
+    /// Create a new LogEntry
+    pub fn new(
+        level: Level,
+        message: String,
+        source: String,
+        target: Option<String>,
+        request_id: Option<String>,
+        user_id: Option<String>,
+        fields: Vec<(String, String)>,
+    ) -> Self {
+        LogEntry {
+            timestamp: Utc::now(),
+            level: SerializableLevel::from(level),
+            message,
+            source,
+            target,
+            request_id,
+            user_id,
+            fields,
+        }
+    }
+}

packages/obs/src/entry/mod.rs

@@ -0,0 +1,3 @@
+pub(crate) mod audit;
+mod base;
+pub(crate) mod log;