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
//! Types for the query parameters of the pipeline endpoints.
use serde::{Deserialize, Serialize};
use utoipa::{IntoParams, ToSchema};
use crate::runtime_status::RuntimeDesiredStatus;
/// Circuit metrics output format.
/// - `prometheus`: [format](https://github.com/prometheus/docs/blob/4b1b80f5f660a2f8dc25a54f52a65a502f31879a/docs/instrumenting/exposition_formats.md) expected by Prometheus
/// - `json`: JSON format
#[derive(Copy, Clone, Debug, PartialEq, Eq, Deserialize, ToSchema)]
#[serde(rename_all = "snake_case")]
pub enum MetricsFormat {
Prometheus,
Json,
}
/// Returns default metrics format.
fn default_metrics_format() -> MetricsFormat {
MetricsFormat::Prometheus
}
/// Query parameters to retrieve pipeline circuit metrics.
#[derive(Debug, Deserialize, IntoParams, ToSchema)]
pub struct MetricsParameters {
#[serde(default = "default_metrics_format")]
pub format: MetricsFormat,
}
#[derive(Debug, Deserialize, IntoParams, ToSchema)]
#[serde(default)]
pub struct ActivateParams {
#[serde(with = "crate::runtime_status::snake_case_runtime_desired_status")]
pub initial: RuntimeDesiredStatus,
}
impl Default for ActivateParams {
fn default() -> Self {
Self {
initial: RuntimeDesiredStatus::Running,
}
}
}
#[derive(Debug, Deserialize, Serialize, IntoParams, ToSchema)]
#[serde(default)]
pub struct SamplyProfileParams {
/// In a multihost pipeline, the ordinal of the pipeline to sample.
pub ordinal: usize,
/// The number of seconds to sample for the profile.
pub duration_secs: u64,
}
/// Default query parameters for POST of a pipeline samply profile.
impl Default for SamplyProfileParams {
fn default() -> Self {
Self {
ordinal: 0,
duration_secs: 30,
}
}
}
/// Query parameters to retrieve samply profile.
#[derive(Debug, Default, Deserialize, Serialize, IntoParams, ToSchema)]
#[into_params(parameter_in = Query)]
#[serde(default)]
pub struct SamplyProfileGetParams {
/// In a multihost pipeline, the ordinal of the pipeline to sample.
pub ordinal: usize,
/// If true, returns 204 redirect with Retry-After header if profile collection is in progress.
/// If false or not provided, returns the last collected profile.
pub latest: bool,
}
/// Query parameters to the `/approve` endpoint.
#[derive(Debug, Deserialize, IntoParams, ToSchema)]
pub struct ApproveParameters {
/// Bootstrap the pipeline with output connectors disabled.
#[serde(default)]
pub silent_bootstrap: bool,
/// Bootstrap new and modified views concurrently, keeping the pre-existing
/// views live while the new ones backfill. Mutually exclusive with
/// `silent_bootstrap`.
#[serde(default)]
pub concurrent_bootstrap: bool,
}
/// Query parameters to the `/stats` endpoint.
#[derive(Debug, Default, Deserialize, Serialize)]
pub struct StatsParams {
/// When `true`, include the most recent error messages for each endpoint
/// in the response (up to `MAX_CONNECTOR_ERRORS` per list). Default is
/// `false` so that callers polling `/stats` keep getting a lightweight
/// response. This selector is intended for the support-bundle collector.
#[serde(default)]
pub include_connector_errors: bool,
}