redis-enterprise 0.9.1

Redis Enterprise REST API client library
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
//! Statistics and metrics collection for Redis Enterprise
//!
//! ## Overview
//! - Query cluster, node, database, and shard statistics
//! - Retrieve time-series metrics with configurable intervals
//! - Access both current and historical performance data
//!
//! ## Return Types
//!
//! Stats methods return either typed responses (`StatsResponse`, `LastStatsResponse`)
//! or raw `serde_json::Value` for endpoints with dynamic metric names as keys.
//! The Value returns allow access to all metrics without compile-time knowledge
//! of metric names.
//!
//! ## Examples
//!
//! ### Querying Database Stats
//! ```no_run
//! use redis_enterprise::EnterpriseClient;
//! use redis_enterprise::stats::StatsQuery;
//!
//! # async fn example(client: EnterpriseClient) -> Result<(), Box<dyn std::error::Error>> {
//! // Get last interval stats for a database
//! let last_stats = client.stats().database_last(1).await?;
//! println!("Database stats: {:?}", last_stats);
//!
//! // Query with specific interval (all metrics by default)
//! let query = StatsQuery {
//!     interval: Some("5min".to_string()),
//!     stime: None,
//!     etime: None,
//!     metrics: None,  // None means all metrics
//! };
//! let historical = client.stats().database(1, Some(query)).await?;
//! println!("5-minute intervals: {:?}", historical.intervals);
//! # Ok(())
//! # }
//! ```
//!
//! ### Cluster-Wide Statistics
//! ```no_run
//! # use redis_enterprise::EnterpriseClient;
//! # async fn example(client: EnterpriseClient) -> Result<(), Box<dyn std::error::Error>> {
//! // Get aggregated stats for all nodes
//! let all_nodes = client.stats().nodes_last().await?;
//! println!("Total stats across cluster: {:?}", all_nodes.stats);
//!
//! // Get aggregated database stats
//! let all_dbs = client.stats().databases_last().await?;
//! for resource_stats in &all_dbs.stats {
//!     println!("Resource {}: {:?}", resource_stats.uid, resource_stats.intervals);
//! }
//! # Ok(())
//! # }
//! ```

use crate::client::RestClient;
use crate::error::Result;
use futures::stream::Stream;
use serde::{Deserialize, Deserializer, Serialize};
use serde_json::Value;
use std::pin::Pin;
use std::time::Duration;
use tokio::time::sleep;

/// Stats query parameters
#[derive(Debug, Serialize)]
pub struct StatsQuery {
    /// Time interval for aggregation ("1min", "5min", "1hour", "1day")
    #[serde(skip_serializing_if = "Option::is_none")]
    pub interval: Option<String>,
    /// Start time for the query (ISO 8601 format)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub stime: Option<String>,
    /// End time for the query (ISO 8601 format)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub etime: Option<String>,
    /// Comma-separated list of specific metrics to retrieve
    #[serde(skip_serializing_if = "Option::is_none")]
    pub metrics: Option<String>,
}

/// Generic stats response
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct StatsResponse {
    /// Array of time intervals with their corresponding metrics
    pub intervals: Vec<StatsInterval>,
}

/// Stats interval
#[derive(Debug, Clone, Serialize)]
pub struct StatsInterval {
    /// Timestamp for this interval (ISO 8601 format)
    pub time: String,
    /// Metrics data for this time interval (dynamic field names)
    pub metrics: Value,
}

impl<'de> Deserialize<'de> for StatsInterval {
    fn deserialize<D>(deserializer: D) -> std::result::Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        let value = Value::deserialize(deserializer)?;
        let object = value.as_object().ok_or_else(|| {
            <D::Error as serde::de::Error>::custom("expected stats interval object")
        })?;

        if let (Some(time), Some(metrics)) = (
            object.get("time").and_then(Value::as_str),
            object.get("metrics"),
        ) {
            return Ok(Self {
                time: time.to_string(),
                metrics: metrics.clone(),
            });
        }

        let time = object
            .get("stime")
            .and_then(Value::as_str)
            .or_else(|| object.get("etime").and_then(Value::as_str))
            .ok_or_else(|| {
                <D::Error as serde::de::Error>::custom(
                    "expected stats interval to contain either time or stime/etime",
                )
            })?;

        Ok(Self {
            time: time.to_string(),
            metrics: value,
        })
    }
}

/// Last stats response for single resource
/// Response for last stats endpoint - the API returns metrics directly
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct LastStatsResponse {
    /// Start time of the stats interval
    pub stime: Option<String>,
    /// End time of the stats interval
    pub etime: Option<String>,
    /// Interval duration (e.g., "5min", "1hour")
    pub interval: Option<String>,
    /// All metric values for the last interval (dynamic field names)
    #[serde(flatten)]
    pub metrics: Value,
}

/// Aggregated stats response for multiple resources
#[derive(Debug, Clone, Serialize)]
pub struct AggregatedStatsResponse {
    /// Array of stats for individual resources (nodes, databases, shards)
    pub stats: Vec<ResourceStats>,
}

#[derive(Debug, Clone, Deserialize)]
#[serde(untagged)]
enum AggregatedStatsResponseWire {
    Wrapped { stats: Vec<ResourceStats> },
    Bare(Vec<ResourceStats>),
}

impl<'de> Deserialize<'de> for AggregatedStatsResponse {
    fn deserialize<D>(deserializer: D) -> std::result::Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        match AggregatedStatsResponseWire::deserialize(deserializer)? {
            AggregatedStatsResponseWire::Wrapped { stats } => Ok(Self { stats }),
            AggregatedStatsResponseWire::Bare(stats) => Ok(Self { stats }),
        }
    }
}

/// Stats for a single resource
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ResourceStats {
    /// Unique identifier of the resource (node UID, database UID, etc.)
    pub uid: u32,
    /// Time intervals with metrics for this specific resource
    pub intervals: Vec<StatsInterval>,
}

/// Stats handler for retrieving metrics
pub struct StatsHandler {
    client: RestClient,
}

impl StatsHandler {
    /// Create a new handler bound to the given REST client.
    pub fn new(client: RestClient) -> Self {
        StatsHandler { client }
    }

    /// Get cluster stats
    pub async fn cluster(&self, query: Option<StatsQuery>) -> Result<StatsResponse> {
        if let Some(q) = query {
            let query_str = serde_urlencoded::to_string(&q).unwrap_or_default();
            self.client
                .get(&format!("/v1/cluster/stats?{}", query_str))
                .await
        } else {
            self.client.get("/v1/cluster/stats").await
        }
    }

    /// Get cluster stats for last interval
    pub async fn cluster_last(&self) -> Result<LastStatsResponse> {
        self.client.get("/v1/cluster/stats/last").await
    }

    // raw variant removed: use cluster_last()

    /// Get node stats
    pub async fn node(&self, uid: u32, query: Option<StatsQuery>) -> Result<StatsResponse> {
        if let Some(q) = query {
            let query_str = serde_urlencoded::to_string(&q).unwrap_or_default();
            self.client
                .get(&format!("/v1/nodes/{}/stats?{}", uid, query_str))
                .await
        } else {
            self.client.get(&format!("/v1/nodes/{}/stats", uid)).await
        }
    }

    /// Get node stats for last interval
    pub async fn node_last(&self, uid: u32) -> Result<LastStatsResponse> {
        self.client
            .get(&format!("/v1/nodes/{}/stats/last", uid))
            .await
    }

    // raw variant removed: use node_last()

    /// Get all nodes stats
    pub async fn nodes(&self, query: Option<StatsQuery>) -> Result<AggregatedStatsResponse> {
        if let Some(q) = query {
            let query_str = serde_urlencoded::to_string(&q).unwrap_or_default();
            self.client
                .get(&format!("/v1/nodes/stats?{}", query_str))
                .await
        } else {
            self.client.get("/v1/nodes/stats").await
        }
    }

    // raw variant removed: use nodes()

    /// Get all nodes last stats
    pub async fn nodes_last(&self) -> Result<AggregatedStatsResponse> {
        self.client.get("/v1/nodes/stats/last").await
    }

    // raw variant removed: use nodes_last()

    /// Get node stats via alternate path form
    pub async fn node_alt(&self, uid: u32) -> Result<StatsResponse> {
        self.client.get(&format!("/v1/nodes/stats/{}", uid)).await
    }

    /// Get node last stats via alternate path form
    pub async fn node_last_alt(&self, uid: u32) -> Result<LastStatsResponse> {
        self.client
            .get(&format!("/v1/nodes/stats/last/{}", uid))
            .await
    }

    /// Get database stats
    pub async fn database(&self, uid: u32, query: Option<StatsQuery>) -> Result<StatsResponse> {
        if let Some(q) = query {
            let query_str = serde_urlencoded::to_string(&q).unwrap_or_default();
            self.client
                .get(&format!("/v1/bdbs/{}/stats?{}", uid, query_str))
                .await
        } else {
            self.client.get(&format!("/v1/bdbs/{}/stats", uid)).await
        }
    }

    /// Get database stats for last interval
    pub async fn database_last(&self, uid: u32) -> Result<LastStatsResponse> {
        self.client
            .get(&format!("/v1/bdbs/{}/stats/last", uid))
            .await
    }

    // raw variant removed: use database_last()

    /// Get all databases stats
    pub async fn databases(&self, query: Option<StatsQuery>) -> Result<AggregatedStatsResponse> {
        if let Some(q) = query {
            let query_str = serde_urlencoded::to_string(&q).unwrap_or_default();
            self.client
                .get(&format!("/v1/bdbs/stats?{}", query_str))
                .await
        } else {
            self.client.get("/v1/bdbs/stats").await
        }
    }

    // raw variant removed: use databases()

    /// Get all databases last stats (aggregate)
    pub async fn databases_last(&self) -> Result<AggregatedStatsResponse> {
        self.client.get("/v1/bdbs/stats/last").await
    }

    // raw variant removed: use databases_last()

    /// Get database stats via alternate path form
    pub async fn database_alt(&self, uid: u32) -> Result<StatsResponse> {
        self.client.get(&format!("/v1/bdbs/stats/{}", uid)).await
    }

    /// Get database last stats via alternate path form
    pub async fn database_last_alt(&self, uid: u32) -> Result<LastStatsResponse> {
        self.client
            .get(&format!("/v1/bdbs/stats/last/{}", uid))
            .await
    }

    /// Get shard stats
    pub async fn shard(&self, uid: u32, query: Option<StatsQuery>) -> Result<StatsResponse> {
        if let Some(q) = query {
            let query_str = serde_urlencoded::to_string(&q).unwrap_or_default();
            self.client
                .get(&format!("/v1/shards/stats/{}?{}", uid, query_str))
                .await
        } else {
            self.client.get(&format!("/v1/shards/stats/{}", uid)).await
        }
    }

    /// Get all shards stats
    pub async fn shards(&self, query: Option<StatsQuery>) -> Result<AggregatedStatsResponse> {
        if let Some(q) = query {
            let query_str = serde_urlencoded::to_string(&q).unwrap_or_default();
            self.client
                .get(&format!("/v1/shards/stats?{}", query_str))
                .await
        } else {
            self.client.get("/v1/shards/stats").await
        }
    }

    // raw variant removed: use shards()

    /// Get all shards last stats
    pub async fn shards_last(&self) -> Result<Value> {
        self.client.get("/v1/shards/stats/last").await
    }

    /// Get shard last stats
    pub async fn shard_last(&self, uid: u32) -> Result<Value> {
        self.client
            .get(&format!("/v1/shards/stats/last/{}", uid))
            .await
    }

    /// Stream cluster stats in real-time by polling
    ///
    /// # Arguments
    /// * `poll_interval` - Time to wait between polls
    ///
    /// # Returns
    /// A stream of stats responses
    pub fn stream_cluster(
        &self,
        poll_interval: Duration,
    ) -> Pin<Box<dyn Stream<Item = Result<LastStatsResponse>> + Send + '_>> {
        Box::pin(async_stream::stream! {
            loop {
                match self.cluster_last().await {
                    Ok(stats) => yield Ok(stats),
                    Err(e) => {
                        yield Err(e);
                        break;
                    }
                }
                sleep(poll_interval).await;
            }
        })
    }

    /// Stream node stats in real-time by polling
    ///
    /// # Arguments
    /// * `uid` - Node ID
    /// * `poll_interval` - Time to wait between polls
    ///
    /// # Returns
    /// A stream of stats responses
    pub fn stream_node(
        &self,
        uid: u32,
        poll_interval: Duration,
    ) -> Pin<Box<dyn Stream<Item = Result<LastStatsResponse>> + Send + '_>> {
        Box::pin(async_stream::stream! {
            loop {
                match self.node_last(uid).await {
                    Ok(stats) => yield Ok(stats),
                    Err(e) => {
                        yield Err(e);
                        break;
                    }
                }
                sleep(poll_interval).await;
            }
        })
    }

    /// Stream database stats in real-time by polling
    ///
    /// # Arguments
    /// * `uid` - Database ID
    /// * `poll_interval` - Time to wait between polls
    ///
    /// # Returns
    /// A stream of stats responses
    pub fn stream_database(
        &self,
        uid: u32,
        poll_interval: Duration,
    ) -> Pin<Box<dyn Stream<Item = Result<LastStatsResponse>> + Send + '_>> {
        Box::pin(async_stream::stream! {
            loop {
                match self.database_last(uid).await {
                    Ok(stats) => yield Ok(stats),
                    Err(e) => {
                        yield Err(e);
                        break;
                    }
                }
                sleep(poll_interval).await;
            }
        })
    }
}