Skip to content

feat(redis-cloud): add tracing instrumentation to API client #452

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
joshrotenberg merged 1 commit into from
Nov 21, 2025
Merged

feat(redis-cloud): add tracing instrumentation to API client #452

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions crates/redis-cloud/src/client.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ use crate::{CloudError as RestError, Result};
use reqwest::Client;
use serde::Serialize;
use std::sync::Arc;
use tracing::{debug, instrument, trace};

/// Builder for constructing a CloudClient with custom configuration
///
Expand Down Expand Up @@ -134,8 +135,10 @@ impl CloudClient {
}

/// Make a GET request with API key authentication
#[instrument(skip(self), fields(method = "GET"))]
pub async fn get<T: serde::de::DeserializeOwned>(&self, path: &str) -> Result<T> {
let url = self.normalize_url(path);
debug!("GET {}", url);

// Redis Cloud API uses these headers for authentication
let response = self
Expand All @@ -146,16 +149,20 @@ impl CloudClient {
.send()
.await?;

trace!("Response status: {}", response.status());
self.handle_response(response).await
}

/// Make a POST request
#[instrument(skip(self, body), fields(method = "POST"))]
pub async fn post<B: Serialize, T: serde::de::DeserializeOwned>(
&self,
path: &str,
body: &B,
) -> Result<T> {
let url = self.normalize_url(path);
debug!("POST {}", url);
trace!("Request body: {:?}", serde_json::to_value(body).ok());

// Same backwards header naming as GET
let response = self
Expand All @@ -167,16 +174,20 @@ impl CloudClient {
.send()
.await?;

trace!("Response status: {}", response.status());
self.handle_response(response).await
}

/// Make a PUT request
#[instrument(skip(self, body), fields(method = "PUT"))]
pub async fn put<B: Serialize, T: serde::de::DeserializeOwned>(
&self,
path: &str,
body: &B,
) -> Result<T> {
let url = self.normalize_url(path);
debug!("PUT {}", url);
trace!("Request body: {:?}", serde_json::to_value(body).ok());

// Same backwards header naming as GET
let response = self
Expand All @@ -188,12 +199,15 @@ impl CloudClient {
.send()
.await?;

trace!("Response status: {}", response.status());
self.handle_response(response).await
}

/// Make a DELETE request
#[instrument(skip(self), fields(method = "DELETE"))]
pub async fn delete(&self, path: &str) -> Result<()> {
let url = self.normalize_url(path);
debug!("DELETE {}", url);

// Same backwards header naming as GET
let response = self
Expand All @@ -204,6 +218,7 @@ impl CloudClient {
.send()
.await?;

trace!("Response status: {}", response.status());
if response.status().is_success() {
Ok(())
} else {
Expand All @@ -227,27 +242,33 @@ impl CloudClient {
}

/// Execute raw GET request returning JSON Value
#[instrument(skip(self), fields(method = "GET"))]
pub async fn get_raw(&self, path: &str) -> Result<serde_json::Value> {
self.get(path).await
}

/// Execute raw POST request with JSON body
#[instrument(skip(self, body), fields(method = "POST"))]
pub async fn post_raw(&self, path: &str, body: serde_json::Value) -> Result<serde_json::Value> {
self.post(path, &body).await
}

/// Execute raw PUT request with JSON body
#[instrument(skip(self, body), fields(method = "PUT"))]
pub async fn put_raw(&self, path: &str, body: serde_json::Value) -> Result<serde_json::Value> {
self.put(path, &body).await
}

/// Execute raw PATCH request with JSON body
#[instrument(skip(self, body), fields(method = "PATCH"))]
pub async fn patch_raw(
&self,
path: &str,
body: serde_json::Value,
) -> Result<serde_json::Value> {
let url = self.normalize_url(path);
debug!("PATCH {}", url);
trace!("Request body: {:?}", body);

// Use backwards header names for compatibility
let response = self
Expand All @@ -259,12 +280,15 @@ impl CloudClient {
.send()
.await?;

trace!("Response status: {}", response.status());
self.handle_response(response).await
}

/// Execute raw DELETE request returning any response body
#[instrument(skip(self), fields(method = "DELETE"))]
pub async fn delete_raw(&self, path: &str) -> Result<serde_json::Value> {
let url = self.normalize_url(path);
debug!("DELETE {}", url);

// Use backwards header names for compatibility
let response = self
Expand All @@ -275,6 +299,7 @@ impl CloudClient {
.send()
.await?;

trace!("Response status: {}", response.status());
if response.status().is_success() {
if response.content_length() == Some(0) {
Ok(serde_json::json!({"status": "deleted"}))
Expand Down Expand Up @@ -302,12 +327,15 @@ impl CloudClient {
}

/// Execute DELETE request with JSON body (used by some endpoints like PrivateLink principals)
#[instrument(skip(self, body), fields(method = "DELETE"))]
pub async fn delete_with_body<T: serde::de::DeserializeOwned>(
&self,
path: &str,
body: serde_json::Value,
) -> Result<T> {
let url = self.normalize_url(path);
debug!("DELETE {} (with body)", url);
trace!("Request body: {:?}", body);

let response = self
.client
Expand All @@ -318,6 +346,7 @@ impl CloudClient {
.send()
.await?;

trace!("Response status: {}", response.status());
self.handle_response(response).await
}

Expand Down