reqx 0.1.35

Rust HTTP transport client for API SDK libraries with retry, timeout, idempotency, proxy, and pluggable TLS backends
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
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
use std::collections::BTreeMap;
use std::sync::Arc;
use std::sync::Mutex;
use std::sync::atomic::{AtomicU64, Ordering};
use std::time::{Duration, Instant};

use http::Method;

use crate::error::{Error, ErrorCode, TimeoutPhase, TransportErrorKind};
use crate::otel::{OtelRequestSpan, OtelTelemetry};
use crate::response::Response;
use crate::util::lock_unpoisoned;

#[derive(Clone, Debug, Default)]
/// Snapshot of client-side transport metrics.
pub struct MetricsSnapshot {
    /// Request lifecycle counters.
    pub requests: RequestMetrics,
    /// Response status counters.
    pub responses: ResponseMetrics,
    /// Timeout counters.
    pub timeouts: TimeoutMetrics,
    /// Error counters.
    pub errors: ErrorMetrics,
    /// Aggregate latency counters.
    pub latency: LatencyMetrics,
}

#[derive(Clone, Debug, Default)]
/// Request lifecycle counters.
pub struct RequestMetrics {
    /// Requests started.
    pub started: u64,
    /// Requests completed successfully.
    pub succeeded: u64,
    /// Requests completed with an error.
    pub failed: u64,
    /// Requests canceled before completion.
    pub canceled: u64,
    /// Retry attempts scheduled after an initial request.
    pub retries: u64,
    /// Requests currently in flight.
    pub in_flight: u64,
}

#[derive(Clone, Debug, Default)]
/// Response status counters.
pub struct ResponseMetrics {
    /// Counts keyed by HTTP status code.
    pub status_counts: BTreeMap<u16, u64>,
}

#[derive(Clone, Debug, Default)]
/// Timeout counters grouped by phase.
pub struct TimeoutMetrics {
    /// Timeouts that happened before handing out the response body stream.
    pub transport: u64,
    /// Timeouts that happened while reading a response body stream.
    pub response_body: u64,
    /// Overall request deadlines that elapsed.
    pub deadline_exceeded: u64,
}

#[derive(Clone, Debug, Default)]
/// Error counters grouped by category.
pub struct ErrorMetrics {
    /// Transport-layer errors before a response was received.
    pub transport: u64,
    /// Errors while reading a buffered response body.
    pub read_body: u64,
    /// Errors while writing a streamed response body to a sink.
    pub write_body: u64,
    /// Responses rejected for exceeding the configured body limit.
    pub response_body_too_large: u64,
    /// Responses rejected by the active status policy.
    pub http_status: u64,
    /// Counts keyed by stable [`ErrorCode`].
    pub by_code: BTreeMap<ErrorCode, u64>,
    /// Counts keyed by [`TimeoutPhase`].
    pub by_timeout_phase: BTreeMap<TimeoutPhase, u64>,
    /// Counts keyed by [`TransportErrorKind`].
    pub by_transport_kind: BTreeMap<TransportErrorKind, u64>,
    /// HTTP status error counts keyed by status code.
    pub by_http_status: BTreeMap<u16, u64>,
}

#[derive(Clone, Debug, Default)]
/// Aggregate latency counters.
pub struct LatencyMetrics {
    /// Number of latency samples recorded.
    pub samples: u64,
    /// Sum of all request latencies in milliseconds.
    pub total_ms: u64,
    /// Average request latency in milliseconds.
    pub average_ms: f64,
}

#[derive(Clone, Debug, Default)]
pub(crate) struct ClientMetrics {
    inner: Option<Arc<ClientMetricsInner>>,
    otel: OtelTelemetry,
}

#[derive(Debug, Default)]
struct ClientMetricsInner {
    requests_started: AtomicU64,
    requests_succeeded: AtomicU64,
    requests_failed: AtomicU64,
    requests_canceled: AtomicU64,
    retries: AtomicU64,
    timeout_transport: AtomicU64,
    timeout_response_body: AtomicU64,
    deadline_exceeded: AtomicU64,
    transport_errors: AtomicU64,
    read_body_errors: AtomicU64,
    write_body_errors: AtomicU64,
    response_body_too_large: AtomicU64,
    http_status_errors: AtomicU64,
    in_flight: AtomicU64,
    latency_total_ms: AtomicU64,
    latency_samples: AtomicU64,
    status_counts: Mutex<BTreeMap<u16, u64>>,
    error_code_counts: Mutex<BTreeMap<ErrorCode, u64>>,
    timeout_phase_counts: Mutex<BTreeMap<TimeoutPhase, u64>>,
    transport_error_kind_counts: Mutex<BTreeMap<TransportErrorKind, u64>>,
    http_status_error_counts: Mutex<BTreeMap<u16, u64>>,
}

#[derive(Debug)]
pub(crate) struct InFlightGuard {
    inner: Option<Arc<ClientMetricsInner>>,
}

#[derive(Debug)]
pub(crate) struct StreamCompletion {
    metrics: ClientMetrics,
    request_span: Option<OtelRequestSpan>,
    request_started_at: Instant,
    status: u16,
    in_flight_guard: Option<InFlightGuard>,
    state: StreamCompletionState,
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
enum StreamCompletionState {
    Pending,
    Success,
    Error,
    Canceled,
}

impl ClientMetrics {
    pub(crate) fn with_options(metrics_enabled: bool, otel: OtelTelemetry) -> Self {
        Self {
            inner: metrics_enabled.then(|| Arc::new(ClientMetricsInner::default())),
            otel,
        }
    }

    pub(crate) fn start_otel_request_span(
        &self,
        method: &Method,
        uri: &str,
        stream: bool,
    ) -> OtelRequestSpan {
        self.otel.start_request_span(method, uri, stream)
    }

    pub(crate) fn finish_otel_request_span_success(
        &self,
        request_span: OtelRequestSpan,
        status: u16,
    ) {
        self.otel.finish_request_span_success(request_span, status);
    }

    pub(crate) fn finish_otel_request_span_error(
        &self,
        request_span: OtelRequestSpan,
        error: &Error,
    ) {
        self.otel.finish_request_span_error(request_span, error);
    }

    pub(crate) fn finish_otel_request_span_canceled(&self, request_span: OtelRequestSpan) {
        self.otel.finish_request_span_canceled(request_span);
    }

    pub(crate) fn record_request_started(&self) {
        if let Some(inner) = &self.inner {
            inner.requests_started.fetch_add(1, Ordering::Relaxed);
        }
        self.otel.record_request_started();
    }

    pub(crate) fn enter_in_flight(&self) -> InFlightGuard {
        match &self.inner {
            Some(inner) => {
                inner.in_flight.fetch_add(1, Ordering::Relaxed);
                InFlightGuard {
                    inner: Some(Arc::clone(inner)),
                }
            }
            None => InFlightGuard { inner: None },
        }
    }

    pub(crate) fn record_retry(&self) {
        if let Some(inner) = &self.inner {
            inner.retries.fetch_add(1, Ordering::Relaxed);
        }
        self.otel.record_retry();
    }

    pub(crate) fn record_request_completed(
        &self,
        result: &Result<Response, Error>,
        latency: Duration,
    ) {
        match result {
            Ok(response) => {
                self.record_request_completed_success(response.status().as_u16(), latency)
            }
            Err(error) => {
                self.record_request_completed_error(error, latency);
            }
        }
    }

    pub(crate) fn stream_completion(
        &self,
        request_span: Option<OtelRequestSpan>,
        request_started_at: Instant,
        status: u16,
        in_flight_guard: InFlightGuard,
    ) -> StreamCompletion {
        StreamCompletion {
            metrics: self.clone(),
            request_span,
            request_started_at,
            status,
            in_flight_guard: Some(in_flight_guard),
            state: StreamCompletionState::Pending,
        }
    }

    pub(crate) fn record_request_completed_error(&self, error: &Error, latency: Duration) {
        if let Some(inner) = &self.inner {
            inner.requests_failed.fetch_add(1, Ordering::Relaxed);
        }
        self.record_latency(latency);
        self.otel.record_request_failed(error);

        self.add_error_code_count(error.code());

        match error {
            Error::Timeout { phase, .. } => {
                if let Some(inner) = &self.inner {
                    match phase {
                        TimeoutPhase::Transport => {
                            inner.timeout_transport.fetch_add(1, Ordering::Relaxed);
                        }
                        TimeoutPhase::ResponseBody => {
                            inner.timeout_response_body.fetch_add(1, Ordering::Relaxed);
                        }
                    }
                }
                self.add_timeout_phase_count(*phase);
            }
            Error::DeadlineExceeded { .. } => {
                if let Some(inner) = &self.inner {
                    inner.deadline_exceeded.fetch_add(1, Ordering::Relaxed);
                }
            }
            Error::Transport { kind, .. } => {
                if let Some(inner) = &self.inner {
                    inner.transport_errors.fetch_add(1, Ordering::Relaxed);
                }
                self.add_transport_error_kind_count(*kind);
            }
            Error::ReadBody { .. } => {
                if let Some(inner) = &self.inner {
                    inner.read_body_errors.fetch_add(1, Ordering::Relaxed);
                }
            }
            Error::WriteBody { .. } => {
                if let Some(inner) = &self.inner {
                    inner.write_body_errors.fetch_add(1, Ordering::Relaxed);
                }
            }
            Error::ResponseBodyTooLarge { .. } => {
                if let Some(inner) = &self.inner {
                    inner
                        .response_body_too_large
                        .fetch_add(1, Ordering::Relaxed);
                }
            }
            Error::HttpStatus { status, .. } => {
                if let Some(inner) = &self.inner {
                    inner.http_status_errors.fetch_add(1, Ordering::Relaxed);
                }
                self.add_status_count(*status);
                self.add_http_status_error_count(*status);
            }
            Error::InvalidUri { .. }
            | Error::InvalidNoProxyRule { .. }
            | Error::InvalidProxyConfig { .. }
            | Error::ProxyAuthorizationRequiresHttpProxy
            | Error::InvalidAdaptiveConcurrencyPolicy { .. }
            | Error::SerializeJson { .. }
            | Error::SerializeQuery { .. }
            | Error::SerializeForm { .. }
            | Error::RequestBuild { .. }
            | Error::DeserializeJson { .. }
            | Error::DecodeText { .. }
            | Error::InvalidHeaderName { .. }
            | Error::InvalidHeaderValue { .. }
            | Error::DecodeContentEncoding { .. }
            | Error::ConcurrencyLimitClosed
            | Error::TlsBackendUnavailable { .. }
            | Error::TlsBackendInit { .. }
            | Error::TlsConfig { .. }
            | Error::RetryBudgetExhausted { .. }
            | Error::CircuitOpen { .. }
            | Error::MissingRedirectLocation { .. }
            | Error::InvalidRedirectLocation { .. }
            | Error::RedirectLimitExceeded { .. }
            | Error::RedirectBodyNotReplayable { .. } => {}
        }
    }

    pub(crate) fn record_request_completed_canceled(&self, latency: Duration) {
        if let Some(inner) = &self.inner {
            inner.requests_canceled.fetch_add(1, Ordering::Relaxed);
        }
        self.record_latency(latency);
        self.otel.record_request_canceled();
    }

    fn record_request_completed_success(&self, status: u16, latency: Duration) {
        if let Some(inner) = &self.inner {
            inner.requests_succeeded.fetch_add(1, Ordering::Relaxed);
        }
        self.add_status_count(status);
        self.otel.record_request_succeeded(status);
        self.record_latency(latency);
    }

    pub(crate) fn snapshot(&self) -> MetricsSnapshot {
        let Some(inner) = &self.inner else {
            return MetricsSnapshot::default();
        };

        let requests_started = inner.requests_started.load(Ordering::Relaxed);
        let requests_succeeded = inner.requests_succeeded.load(Ordering::Relaxed);
        let requests_failed = inner.requests_failed.load(Ordering::Relaxed);
        let requests_canceled = inner.requests_canceled.load(Ordering::Relaxed);
        let retries = inner.retries.load(Ordering::Relaxed);
        let timeout_transport = inner.timeout_transport.load(Ordering::Relaxed);
        let timeout_response_body = inner.timeout_response_body.load(Ordering::Relaxed);
        let deadline_exceeded = inner.deadline_exceeded.load(Ordering::Relaxed);
        let transport_errors = inner.transport_errors.load(Ordering::Relaxed);
        let read_body_errors = inner.read_body_errors.load(Ordering::Relaxed);
        let write_body_errors = inner.write_body_errors.load(Ordering::Relaxed);
        let response_body_too_large = inner.response_body_too_large.load(Ordering::Relaxed);
        let http_status_errors = inner.http_status_errors.load(Ordering::Relaxed);
        let in_flight = inner.in_flight.load(Ordering::Relaxed);
        let latency_samples = inner.latency_samples.load(Ordering::Relaxed);
        let latency_total_ms = inner.latency_total_ms.load(Ordering::Relaxed);
        let latency_avg_ms = if latency_samples == 0 {
            0.0
        } else {
            latency_total_ms as f64 / latency_samples as f64
        };
        let status_counts = lock_unpoisoned(&inner.status_counts).clone();
        let error_code_counts = lock_unpoisoned(&inner.error_code_counts).clone();
        let timeout_phase_counts = lock_unpoisoned(&inner.timeout_phase_counts).clone();
        let transport_error_kind_counts =
            lock_unpoisoned(&inner.transport_error_kind_counts).clone();
        let http_status_error_counts = lock_unpoisoned(&inner.http_status_error_counts).clone();

        MetricsSnapshot {
            requests: RequestMetrics {
                started: requests_started,
                succeeded: requests_succeeded,
                failed: requests_failed,
                canceled: requests_canceled,
                retries,
                in_flight,
            },
            responses: ResponseMetrics { status_counts },
            timeouts: TimeoutMetrics {
                transport: timeout_transport,
                response_body: timeout_response_body,
                deadline_exceeded,
            },
            errors: ErrorMetrics {
                transport: transport_errors,
                read_body: read_body_errors,
                write_body: write_body_errors,
                response_body_too_large,
                http_status: http_status_errors,
                by_code: error_code_counts,
                by_timeout_phase: timeout_phase_counts,
                by_transport_kind: transport_error_kind_counts,
                by_http_status: http_status_error_counts,
            },
            latency: LatencyMetrics {
                samples: latency_samples,
                total_ms: latency_total_ms,
                average_ms: latency_avg_ms,
            },
        }
    }

    fn record_latency(&self, latency: Duration) {
        self.otel.record_request_latency(latency);

        let Some(inner) = &self.inner else {
            return;
        };
        inner.latency_samples.fetch_add(1, Ordering::Relaxed);
        inner.latency_total_ms.fetch_add(
            latency.as_millis().min(u64::MAX as u128) as u64,
            Ordering::Relaxed,
        );
    }

    fn add_status_count(&self, status: u16) {
        let Some(inner) = &self.inner else {
            return;
        };
        let mut status_counts = lock_unpoisoned(&inner.status_counts);
        *status_counts.entry(status).or_insert(0) += 1;
    }

    fn add_error_code_count(&self, error_code: ErrorCode) {
        let Some(inner) = &self.inner else {
            return;
        };
        let mut error_code_counts = lock_unpoisoned(&inner.error_code_counts);
        *error_code_counts.entry(error_code).or_insert(0) += 1;
    }

    fn add_timeout_phase_count(&self, phase: TimeoutPhase) {
        let Some(inner) = &self.inner else {
            return;
        };
        let mut timeout_phase_counts = lock_unpoisoned(&inner.timeout_phase_counts);
        *timeout_phase_counts.entry(phase).or_insert(0) += 1;
    }

    fn add_transport_error_kind_count(&self, kind: TransportErrorKind) {
        let Some(inner) = &self.inner else {
            return;
        };
        let mut transport_error_kind_counts = lock_unpoisoned(&inner.transport_error_kind_counts);
        *transport_error_kind_counts.entry(kind).or_insert(0) += 1;
    }

    fn add_http_status_error_count(&self, status: u16) {
        let Some(inner) = &self.inner else {
            return;
        };
        let mut http_status_error_counts = lock_unpoisoned(&inner.http_status_error_counts);
        *http_status_error_counts.entry(status).or_insert(0) += 1;
    }
}

impl Drop for InFlightGuard {
    fn drop(&mut self) {
        if let Some(inner) = &self.inner {
            inner.in_flight.fetch_sub(1, Ordering::Relaxed);
        }
    }
}

impl StreamCompletion {
    pub(crate) fn complete_success(&mut self) {
        if self.state != StreamCompletionState::Pending {
            return;
        }
        self.state = StreamCompletionState::Success;
        let latency = self.request_started_at.elapsed();
        self.metrics
            .record_request_completed_success(self.status, latency);
        if let Some(span) = self.request_span.take() {
            self.metrics
                .finish_otel_request_span_success(span, self.status);
        }
        let _ = self.in_flight_guard.take();
    }

    pub(crate) fn complete_error(&mut self, error: &Error) {
        if self.state != StreamCompletionState::Pending {
            return;
        }
        self.state = StreamCompletionState::Error;
        let latency = self.request_started_at.elapsed();
        self.metrics.record_request_completed_error(error, latency);
        if let Some(span) = self.request_span.take() {
            self.metrics.finish_otel_request_span_error(span, error);
        }
        let _ = self.in_flight_guard.take();
    }

    pub(crate) fn complete_canceled(&mut self) {
        if self.state != StreamCompletionState::Pending {
            return;
        }
        self.state = StreamCompletionState::Canceled;
        let latency = self.request_started_at.elapsed();
        self.metrics.record_request_completed_canceled(latency);
        if let Some(span) = self.request_span.take() {
            self.metrics.finish_otel_request_span_canceled(span);
        }
        let _ = self.in_flight_guard.take();
    }
}

impl Drop for StreamCompletion {
    fn drop(&mut self) {
        self.complete_canceled();
    }
}