Line data Source code
1 : //! Structs representing the JSON formats used in the compute_ctl's HTTP API.
2 :
3 : use std::fmt::Display;
4 :
5 : use chrono::{DateTime, Utc};
6 : use serde::{Deserialize, Serialize, Serializer};
7 :
8 : use crate::{
9 : privilege::Privilege,
10 : spec::{ComputeSpec, Database, ExtVersion, PgIdent, Role},
11 : };
12 :
13 0 : #[derive(Serialize, Debug, Deserialize)]
14 : pub struct GenericAPIError {
15 : pub error: String,
16 : }
17 :
18 : /// Response of the /status API
19 0 : #[derive(Serialize, Debug, Deserialize)]
20 : #[serde(rename_all = "snake_case")]
21 : pub struct ComputeStatusResponse {
22 : pub start_time: DateTime<Utc>,
23 : pub tenant: Option<String>,
24 : pub timeline: Option<String>,
25 : pub status: ComputeStatus,
26 : #[serde(serialize_with = "rfc3339_serialize")]
27 : pub last_active: Option<DateTime<Utc>>,
28 : pub error: Option<String>,
29 : }
30 :
31 0 : #[derive(Deserialize, Serialize)]
32 : #[serde(rename_all = "snake_case")]
33 : pub struct ComputeState {
34 : pub status: ComputeStatus,
35 : /// Timestamp of the last Postgres activity
36 : #[serde(serialize_with = "rfc3339_serialize")]
37 : pub last_active: Option<DateTime<Utc>>,
38 : pub error: Option<String>,
39 : }
40 :
41 0 : #[derive(Serialize, Clone, Copy, Debug, Deserialize, PartialEq, Eq)]
42 : #[serde(rename_all = "snake_case")]
43 : pub enum ComputeStatus {
44 : // Spec wasn't provided at start, waiting for it to be
45 : // provided by control-plane.
46 : Empty,
47 : // Compute configuration was requested.
48 : ConfigurationPending,
49 : // Compute node has spec and initial startup and
50 : // configuration is in progress.
51 : Init,
52 : // Compute is configured and running.
53 : Running,
54 : // New spec is being applied.
55 : Configuration,
56 : // Either startup or configuration failed,
57 : // compute will exit soon or is waiting for
58 : // control-plane to terminate it.
59 : Failed,
60 : // Termination requested
61 : TerminationPending,
62 : // Terminated Postgres
63 : Terminated,
64 : }
65 :
66 : impl Display for ComputeStatus {
67 0 : fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
68 0 : match self {
69 0 : ComputeStatus::Empty => f.write_str("empty"),
70 0 : ComputeStatus::ConfigurationPending => f.write_str("configuration-pending"),
71 0 : ComputeStatus::Init => f.write_str("init"),
72 0 : ComputeStatus::Running => f.write_str("running"),
73 0 : ComputeStatus::Configuration => f.write_str("configuration"),
74 0 : ComputeStatus::Failed => f.write_str("failed"),
75 0 : ComputeStatus::TerminationPending => f.write_str("termination-pending"),
76 0 : ComputeStatus::Terminated => f.write_str("terminated"),
77 : }
78 0 : }
79 : }
80 :
81 0 : fn rfc3339_serialize<S>(x: &Option<DateTime<Utc>>, s: S) -> Result<S::Ok, S::Error>
82 0 : where
83 0 : S: Serializer,
84 0 : {
85 0 : if let Some(x) = x {
86 0 : x.to_rfc3339().serialize(s)
87 : } else {
88 0 : s.serialize_none()
89 : }
90 0 : }
91 :
92 : /// Response of the /metrics.json API
93 : #[derive(Clone, Debug, Default, Serialize)]
94 : pub struct ComputeMetrics {
95 : /// Time spent waiting in pool
96 : pub wait_for_spec_ms: u64,
97 :
98 : /// Time spent checking if safekeepers are synced
99 : pub sync_sk_check_ms: u64,
100 :
101 : /// Time spent syncing safekeepers (walproposer.c).
102 : /// In most cases this should be zero.
103 : pub sync_safekeepers_ms: u64,
104 :
105 : /// Time it took to establish a pg connection to the pageserver.
106 : /// This is two roundtrips, so it's a good proxy for compute-pageserver
107 : /// latency. The latency is usually 0.2ms, but it's not safe to assume
108 : /// that.
109 : pub pageserver_connect_micros: u64,
110 :
111 : /// Time to get basebackup from pageserver and write it to disk.
112 : pub basebackup_ms: u64,
113 :
114 : /// Compressed size of basebackup received.
115 : pub basebackup_bytes: u64,
116 :
117 : /// Time spent starting potgres. This includes initialization of shared
118 : /// buffers, preloading extensions, and other pg operations.
119 : pub start_postgres_ms: u64,
120 :
121 : /// Time spent applying pg catalog updates that were made in the console
122 : /// UI. This should be 0 when startup time matters, since cplane tries
123 : /// to do these updates eagerly, and passes the skip_pg_catalog_updates
124 : /// when it's safe to skip this step.
125 : pub config_ms: u64,
126 :
127 : /// Total time, from when we receive the spec to when we're ready to take
128 : /// pg connections.
129 : pub total_startup_ms: u64,
130 : pub load_ext_ms: u64,
131 : pub num_ext_downloaded: u64,
132 : pub largest_ext_size: u64, // these are measured in bytes
133 : pub total_ext_download_size: u64,
134 : }
135 :
136 : #[derive(Clone, Debug, Default, Serialize)]
137 : pub struct CatalogObjects {
138 : pub roles: Vec<Role>,
139 : pub databases: Vec<Database>,
140 : }
141 :
142 : /// Response of the `/computes/{compute_id}/spec` control-plane API.
143 : /// This is not actually a compute API response, so consider moving
144 : /// to a different place.
145 0 : #[derive(Deserialize, Debug)]
146 : pub struct ControlPlaneSpecResponse {
147 : pub spec: Option<ComputeSpec>,
148 : pub status: ControlPlaneComputeStatus,
149 : }
150 :
151 0 : #[derive(Deserialize, Clone, Copy, Debug, PartialEq, Eq)]
152 : #[serde(rename_all = "snake_case")]
153 : pub enum ControlPlaneComputeStatus {
154 : // Compute is known to control-plane, but it's not
155 : // yet attached to any timeline / endpoint.
156 : Empty,
157 : // Compute is attached to some timeline / endpoint and
158 : // should be able to start with provided spec.
159 : Attached,
160 : }
161 :
162 : #[derive(Clone, Debug, Default, Serialize)]
163 : pub struct InstalledExtension {
164 : pub extname: String,
165 : pub version: String,
166 : pub n_databases: u32, // Number of databases using this extension
167 : pub owned_by_superuser: String,
168 : }
169 :
170 : #[derive(Clone, Debug, Default, Serialize)]
171 : pub struct InstalledExtensions {
172 : pub extensions: Vec<InstalledExtension>,
173 : }
174 :
175 : #[derive(Clone, Debug, Default, Serialize)]
176 : pub struct ExtensionInstallResult {
177 : pub extension: PgIdent,
178 : pub version: ExtVersion,
179 : }
180 : #[derive(Clone, Debug, Default, Serialize)]
181 : pub struct SetRoleGrantsResponse {
182 : pub database: PgIdent,
183 : pub schema: PgIdent,
184 : pub privileges: Vec<Privilege>,
185 : pub role: PgIdent,
186 : }
|
