Initial logging integration

michaelklishin · michaelklishin · commit 687e867dba93 · 2025-10-02T21:24:50.000-04:00
at the 'trace' level. References rabbitmq/rabbitmqadmin-ng#51.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,9 @@
 
 ## v0.61.0 (in development)
 
-No changes yet.
+### Enhancements
+
+ * Integrated logging with the `log` crate. Both clients now emit trace-level logs for HTTP operations, including request/response details and retry attempts.
 
 ## v0.60.0 (Sep 28, 2025)
 
diff --git a/Cargo.toml b/Cargo.toml
@@ -28,6 +28,7 @@ tabled = { version = "0.20", features = ["derive", "macros"], optional = true }
 regex = { version = "1", features = ["std"] }
 url = "2.5"
 urlencoding = "2.1.3"
+log = "0.4"
 
 reqwest = { version = "0.12", default-features = false, features = [
     "json",
@@ -42,6 +43,7 @@ time = { version = "0.3.41", features = ["serde-human-readable"] }
 amqprs = { version = "2" }
 cargo-nextest = "0.9.104"
 proptest = "1.4"
+fern = "0.7"
 
 [features]
 default = ["blocking", "default-tls"]
diff --git a/src/api/client.rs b/src/api/client.rs
@@ -16,6 +16,7 @@
 use crate::commons::RetrySettings;
 use crate::error::Error::{ClientErrorResponse, NotFound, ServerErrorResponse};
 use backtrace::Backtrace;
+use log::trace;
 use reqwest::{Client as HttpClient, StatusCode, header::HeaderMap};
 use serde::Serialize;
 use std::fmt;
@@ -211,6 +212,11 @@ where
     pub fn new(endpoint: E, username: U, password: P) -> Self {
         let client = HttpClient::builder().build().unwrap();
 
+        trace!(
+            "Created new async RabbitMQ HTTP API client for endpoint: {}",
+            endpoint
+        );
+
         Self {
             endpoint,
             username,
@@ -282,8 +288,24 @@ where
         let n = self.retry_settings.max_attempts;
         for attempt in 0..=n {
             match operation().await {
-                Ok(response) => return Ok(response),
+                Ok(response) => {
+                    if attempt > 0 {
+                        trace!("Request succeeded after {} retry attempt(s)", attempt);
+                    }
+                    return Ok(response);
+                }
                 Err(e) => {
+                    if attempt < n {
+                        trace!(
+                            "Request failed on attempt {}/{}, retrying in {}ms: {}",
+                            attempt + 1,
+                            n + 1,
+                            self.retry_settings.delay_ms,
+                            e
+                        );
+                    } else {
+                        trace!("Request failed after {} attempt(s): {}", n + 1, e);
+                    }
                     last_error = Some(e);
 
                     // Don't sleep after the last attempt
@@ -346,6 +368,8 @@ where
         let username = self.username.to_string();
         let password = self.password.to_string();
 
+        trace!("HTTP GET: {}", rooted_path);
+
         self.with_retry(|| async {
             let response = self
                 .client
@@ -378,6 +402,12 @@ where
         let username = self.username.to_string();
         let password = self.password.to_string();
 
+        if let Ok(body) = serde_json::to_string_pretty(payload) {
+            trace!("HTTP PUT: {}\nRequest body:\n{}", rooted_path, body);
+        } else {
+            trace!("HTTP PUT: {}", rooted_path);
+        }
+
         self.with_retry(|| async {
             let response = self
                 .client
@@ -411,6 +441,12 @@ where
         let username = self.username.to_string();
         let password = self.password.to_string();
 
+        if let Ok(body) = serde_json::to_string_pretty(payload) {
+            trace!("HTTP POST: {}\nRequest body:\n{}", rooted_path, body);
+        } else {
+            trace!("HTTP POST: {}", rooted_path);
+        }
+
         self.with_retry(|| async {
             let response = self
                 .client
@@ -472,6 +508,8 @@ where
         let username = self.username.to_string();
         let password = self.password.to_string();
 
+        trace!("HTTP DELETE: {}", rooted_path);
+
         self.with_retry(|| async {
             let response = self
                 .client
@@ -533,6 +571,7 @@ where
             Some(status_code) if status_code == StatusCode::NOT_FOUND => {}
             _ => {
                 if status == StatusCode::NOT_FOUND {
+                    trace!("Resource not found (404) at {}", response.url());
                     return Err(NotFound);
                 }
             }
@@ -547,6 +586,7 @@ where
                     // this consumes `self` and makes the response largely useless to the caller,
                     // so we copy the key parts into the error first
                     let body = response.text().await?;
+                    trace!("HTTP API response: {} from {}: {}", status, url, body);
                     return Err(ClientErrorResponse {
                         url: Some(url),
                         body: Some(body),
@@ -567,6 +607,7 @@ where
                     // this consumes `self` and makes the response largely useless to the caller,
                     // so we copy the key parts into the error first
                     let body = response.text().await?;
+                    trace!("HTTP API response: {} from {}: {}", status, url, body);
                     return Err(ServerErrorResponse {
                         url: Some(url),
                         body: Some(body),
diff --git a/src/blocking_api/client.rs b/src/blocking_api/client.rs
@@ -16,6 +16,7 @@
 use crate::commons::RetrySettings;
 use crate::error::Error::{ClientErrorResponse, NotFound, ServerErrorResponse};
 use backtrace::Backtrace;
+use log::trace;
 use reqwest::{StatusCode, blocking::Client as HttpClient, header::HeaderMap};
 use serde::Serialize;
 use std::fmt;
@@ -210,6 +211,11 @@ where
     pub fn new(endpoint: E, username: U, password: P) -> Self {
         let client = HttpClient::builder().build().unwrap();
 
+        trace!(
+            "Created new blocking RabbitMQ HTTP API client for endpoint: {}",
+            endpoint
+        );
+
         Self {
             endpoint,
             username,
@@ -280,8 +286,24 @@ where
         let n = self.retry_settings.max_attempts;
         for attempt in 0..=n {
             match operation() {
-                Ok(response) => return Ok(response),
+                Ok(response) => {
+                    if attempt > 0 {
+                        trace!("Request succeeded after {} retry attempt(s)", attempt);
+                    }
+                    return Ok(response);
+                }
                 Err(e) => {
+                    if attempt < n {
+                        trace!(
+                            "Request failed on attempt {}/{}, retrying in {}ms: {}",
+                            attempt + 1,
+                            n + 1,
+                            self.retry_settings.delay_ms,
+                            e
+                        );
+                    } else {
+                        trace!("Request failed after {} attempt(s): {}", n + 1, e);
+                    }
                     last_error = Some(e);
 
                     // Don't sleep after the last attempt
@@ -348,6 +370,8 @@ where
         let username = self.username.to_string();
         let password = self.password.to_string();
 
+        trace!("HTTP GET: {}", rooted_path);
+
         self.with_retry(|| {
             let response = self
                 .client
@@ -377,6 +401,12 @@ where
         let username = self.username.to_string();
         let password = self.password.to_string();
 
+        if let Ok(body) = serde_json::to_string_pretty(payload) {
+            trace!("HTTP PUT: {}\nRequest body:\n{}", rooted_path, body);
+        } else {
+            trace!("HTTP PUT: {}", rooted_path);
+        }
+
         self.with_retry(|| {
             let response = self
                 .client
@@ -407,6 +437,12 @@ where
         let username = self.username.to_string();
         let password = self.password.to_string();
 
+        if let Ok(body) = serde_json::to_string_pretty(payload) {
+            trace!("HTTP POST: {}\nRequest body:\n{}", rooted_path, body);
+        } else {
+            trace!("HTTP POST: {}", rooted_path);
+        }
+
         self.with_retry(|| {
             let response = self
                 .client
@@ -462,6 +498,8 @@ where
         let username = self.username.to_string();
         let password = self.password.to_string();
 
+        trace!("HTTP DELETE: {}", rooted_path);
+
         self.with_retry(|| {
             let response = self
                 .client
@@ -517,6 +555,7 @@ where
             Some(status_code) if status_code == StatusCode::NOT_FOUND => {}
             _ => {
                 if status == StatusCode::NOT_FOUND {
+                    trace!("Resource not found (404) at {}", response.url());
                     return Err(NotFound);
                 }
             }
@@ -531,6 +570,7 @@ where
                     // this consumes `self` and makes the response largely useless to the caller,
                     // so we copy the key parts into the error first
                     let body = response.text()?;
+                    trace!("Client error response: {} from {}: {}", status, url, body);
                     return Err(ClientErrorResponse {
                         url: Some(url),
                         body: Some(body),
@@ -551,6 +591,7 @@ where
                     // this consumes `self` and makes the response largely useless to the caller,
                     // so we copy the key parts into the error first
                     let body = response.text()?;
+                    trace!("Server error response: {} from {}: {}", status, url, body);
                     return Err(ServerErrorResponse {
                         url: Some(url),
                         body: Some(body),
