Line data Source code
1 : use pageserver_api::models::detach_ancestor::AncestorDetached;
2 : use pageserver_api::models::{
3 : DetachBehavior, LocationConfig, LocationConfigListResponse, PageserverUtilization,
4 : SecondaryProgress, TenantScanRemoteStorageResponse, TenantShardSplitRequest,
5 : TenantShardSplitResponse, TenantWaitLsnRequest, TimelineArchivalConfigRequest,
6 : TimelineCreateRequest, TimelineInfo, TopTenantShardsRequest, TopTenantShardsResponse,
7 : };
8 : use pageserver_api::shard::TenantShardId;
9 : use pageserver_client::BlockUnblock;
10 : use pageserver_client::mgmt_api::{Client, Result};
11 : use reqwest::StatusCode;
12 : use utils::id::{NodeId, TenantId, TimelineId};
13 :
14 : /// Thin wrapper around [`pageserver_client::mgmt_api::Client`]. It allows the storage
15 : /// controller to collect metrics in a non-intrusive manner.
16 : #[derive(Debug, Clone)]
17 : pub(crate) struct PageserverClient {
18 : inner: Client,
19 : node_id_label: String,
20 : }
21 :
22 : macro_rules! measured_request {
23 : ($name:literal, $method:expr, $node_id: expr, $invoke:expr) => {{
24 : let labels = crate::metrics::PageserverRequestLabelGroup {
25 : pageserver_id: $node_id,
26 : path: $name,
27 : method: $method,
28 : };
29 :
30 : let latency = &crate::metrics::METRICS_REGISTRY
31 : .metrics_group
32 : .storage_controller_pageserver_request_latency;
33 : let _timer_guard = latency.start_timer(labels.clone());
34 :
35 : let res = $invoke;
36 :
37 : if res.is_err() {
38 : let error_counters = &crate::metrics::METRICS_REGISTRY
39 : .metrics_group
40 : .storage_controller_pageserver_request_error;
41 : error_counters.inc(labels)
42 : }
43 :
44 : res
45 : }};
46 : }
47 :
48 : impl PageserverClient {
49 0 : pub(crate) fn new(
50 0 : node_id: NodeId,
51 0 : raw_client: reqwest::Client,
52 0 : mgmt_api_endpoint: String,
53 0 : jwt: Option<&str>,
54 0 : ) -> Self {
55 0 : Self {
56 0 : inner: Client::new(raw_client, mgmt_api_endpoint, jwt),
57 0 : node_id_label: node_id.0.to_string(),
58 0 : }
59 0 : }
60 :
61 0 : pub(crate) async fn tenant_delete(&self, tenant_shard_id: TenantShardId) -> Result<StatusCode> {
62 0 : measured_request!(
63 0 : "tenant",
64 0 : crate::metrics::Method::Delete,
65 0 : &self.node_id_label,
66 0 : self.inner.tenant_delete(tenant_shard_id).await
67 0 : )
68 0 : }
69 :
70 0 : pub(crate) async fn tenant_time_travel_remote_storage(
71 0 : &self,
72 0 : tenant_shard_id: TenantShardId,
73 0 : timestamp: &str,
74 0 : done_if_after: &str,
75 0 : ) -> Result<()> {
76 0 : measured_request!(
77 0 : "tenant_time_travel_remote_storage",
78 0 : crate::metrics::Method::Put,
79 0 : &self.node_id_label,
80 0 : self.inner
81 0 : .tenant_time_travel_remote_storage(tenant_shard_id, timestamp, done_if_after)
82 0 : .await
83 0 : )
84 0 : }
85 :
86 0 : pub(crate) async fn tenant_scan_remote_storage(
87 0 : &self,
88 0 : tenant_id: TenantId,
89 0 : ) -> Result<TenantScanRemoteStorageResponse> {
90 0 : measured_request!(
91 0 : "tenant_scan_remote_storage",
92 0 : crate::metrics::Method::Get,
93 0 : &self.node_id_label,
94 0 : self.inner.tenant_scan_remote_storage(tenant_id).await
95 0 : )
96 0 : }
97 :
98 0 : pub(crate) async fn tenant_secondary_download(
99 0 : &self,
100 0 : tenant_id: TenantShardId,
101 0 : wait: Option<std::time::Duration>,
102 0 : ) -> Result<(StatusCode, SecondaryProgress)> {
103 0 : measured_request!(
104 0 : "tenant_secondary_download",
105 0 : crate::metrics::Method::Post,
106 0 : &self.node_id_label,
107 0 : self.inner.tenant_secondary_download(tenant_id, wait).await
108 0 : )
109 0 : }
110 :
111 0 : pub(crate) async fn tenant_secondary_status(
112 0 : &self,
113 0 : tenant_shard_id: TenantShardId,
114 0 : ) -> Result<SecondaryProgress> {
115 0 : measured_request!(
116 0 : "tenant_secondary_status",
117 0 : crate::metrics::Method::Get,
118 0 : &self.node_id_label,
119 0 : self.inner.tenant_secondary_status(tenant_shard_id).await
120 0 : )
121 0 : }
122 :
123 0 : pub(crate) async fn tenant_heatmap_upload(&self, tenant_id: TenantShardId) -> Result<()> {
124 0 : measured_request!(
125 0 : "tenant_heatmap_upload",
126 0 : crate::metrics::Method::Post,
127 0 : &self.node_id_label,
128 0 : self.inner.tenant_heatmap_upload(tenant_id).await
129 0 : )
130 0 : }
131 :
132 0 : pub(crate) async fn location_config(
133 0 : &self,
134 0 : tenant_shard_id: TenantShardId,
135 0 : config: LocationConfig,
136 0 : flush_ms: Option<std::time::Duration>,
137 0 : lazy: bool,
138 0 : ) -> Result<()> {
139 0 : measured_request!(
140 0 : "location_config",
141 0 : crate::metrics::Method::Put,
142 0 : &self.node_id_label,
143 0 : self.inner
144 0 : .location_config(tenant_shard_id, config, flush_ms, lazy)
145 0 : .await
146 0 : )
147 0 : }
148 :
149 0 : pub(crate) async fn list_location_config(&self) -> Result<LocationConfigListResponse> {
150 0 : measured_request!(
151 0 : "location_configs",
152 0 : crate::metrics::Method::Get,
153 0 : &self.node_id_label,
154 0 : self.inner.list_location_config().await
155 0 : )
156 0 : }
157 :
158 0 : pub(crate) async fn get_location_config(
159 0 : &self,
160 0 : tenant_shard_id: TenantShardId,
161 0 : ) -> Result<Option<LocationConfig>> {
162 0 : measured_request!(
163 0 : "location_config",
164 0 : crate::metrics::Method::Get,
165 0 : &self.node_id_label,
166 0 : self.inner.get_location_config(tenant_shard_id).await
167 0 : )
168 0 : }
169 :
170 0 : pub(crate) async fn timeline_create(
171 0 : &self,
172 0 : tenant_shard_id: TenantShardId,
173 0 : req: &TimelineCreateRequest,
174 0 : ) -> Result<TimelineInfo> {
175 0 : measured_request!(
176 0 : "timeline",
177 0 : crate::metrics::Method::Post,
178 0 : &self.node_id_label,
179 0 : self.inner.timeline_create(tenant_shard_id, req).await
180 0 : )
181 0 : }
182 :
183 0 : pub(crate) async fn timeline_delete(
184 0 : &self,
185 0 : tenant_shard_id: TenantShardId,
186 0 : timeline_id: TimelineId,
187 0 : ) -> Result<StatusCode> {
188 0 : measured_request!(
189 0 : "timeline",
190 0 : crate::metrics::Method::Delete,
191 0 : &self.node_id_label,
192 0 : self.inner
193 0 : .timeline_delete(tenant_shard_id, timeline_id)
194 0 : .await
195 0 : )
196 0 : }
197 :
198 0 : pub(crate) async fn tenant_shard_split(
199 0 : &self,
200 0 : tenant_shard_id: TenantShardId,
201 0 : req: TenantShardSplitRequest,
202 0 : ) -> Result<TenantShardSplitResponse> {
203 0 : measured_request!(
204 0 : "tenant_shard_split",
205 0 : crate::metrics::Method::Put,
206 0 : &self.node_id_label,
207 0 : self.inner.tenant_shard_split(tenant_shard_id, req).await
208 0 : )
209 0 : }
210 :
211 0 : pub(crate) async fn timeline_list(
212 0 : &self,
213 0 : tenant_shard_id: &TenantShardId,
214 0 : ) -> Result<Vec<TimelineInfo>> {
215 0 : measured_request!(
216 0 : "timelines",
217 0 : crate::metrics::Method::Get,
218 0 : &self.node_id_label,
219 0 : self.inner.timeline_list(tenant_shard_id).await
220 0 : )
221 0 : }
222 :
223 0 : pub(crate) async fn timeline_archival_config(
224 0 : &self,
225 0 : tenant_shard_id: TenantShardId,
226 0 : timeline_id: TimelineId,
227 0 : req: &TimelineArchivalConfigRequest,
228 0 : ) -> Result<()> {
229 0 : measured_request!(
230 0 : "timeline_archival_config",
231 0 : crate::metrics::Method::Put,
232 0 : &self.node_id_label,
233 0 : self.inner
234 0 : .timeline_archival_config(tenant_shard_id, timeline_id, req)
235 0 : .await
236 0 : )
237 0 : }
238 :
239 0 : pub(crate) async fn timeline_detach_ancestor(
240 0 : &self,
241 0 : tenant_shard_id: TenantShardId,
242 0 : timeline_id: TimelineId,
243 0 : behavior: Option<DetachBehavior>,
244 0 : ) -> Result<AncestorDetached> {
245 0 : measured_request!(
246 0 : "timeline_detach_ancestor",
247 0 : crate::metrics::Method::Put,
248 0 : &self.node_id_label,
249 0 : self.inner
250 0 : .timeline_detach_ancestor(tenant_shard_id, timeline_id, behavior)
251 0 : .await
252 0 : )
253 0 : }
254 :
255 0 : pub(crate) async fn timeline_block_unblock_gc(
256 0 : &self,
257 0 : tenant_shard_id: TenantShardId,
258 0 : timeline_id: TimelineId,
259 0 : dir: BlockUnblock,
260 0 : ) -> Result<()> {
261 0 : // measuring these makes no sense because we synchronize with the gc loop and remote
262 0 : // storage on block_gc so there should be huge outliers
263 0 : measured_request!(
264 0 : "timeline_block_unblock_gc",
265 0 : crate::metrics::Method::Post,
266 0 : &self.node_id_label,
267 0 : self.inner
268 0 : .timeline_block_unblock_gc(tenant_shard_id, timeline_id, dir)
269 0 : .await
270 0 : )
271 0 : }
272 :
273 0 : pub(crate) async fn timeline_download_heatmap_layers(
274 0 : &self,
275 0 : tenant_shard_id: TenantShardId,
276 0 : timeline_id: TimelineId,
277 0 : concurrency: Option<usize>,
278 0 : recurse: bool,
279 0 : ) -> Result<()> {
280 0 : measured_request!(
281 0 : "download_heatmap_layers",
282 0 : crate::metrics::Method::Post,
283 0 : &self.node_id_label,
284 0 : self.inner
285 0 : .timeline_download_heatmap_layers(
286 0 : tenant_shard_id,
287 0 : timeline_id,
288 0 : concurrency,
289 0 : recurse
290 0 : )
291 0 : .await
292 0 : )
293 0 : }
294 :
295 0 : pub(crate) async fn get_utilization(&self) -> Result<PageserverUtilization> {
296 0 : measured_request!(
297 0 : "utilization",
298 0 : crate::metrics::Method::Get,
299 0 : &self.node_id_label,
300 0 : self.inner.get_utilization().await
301 0 : )
302 0 : }
303 :
304 0 : pub(crate) async fn top_tenant_shards(
305 0 : &self,
306 0 : request: TopTenantShardsRequest,
307 0 : ) -> Result<TopTenantShardsResponse> {
308 0 : measured_request!(
309 0 : "top_tenants",
310 0 : crate::metrics::Method::Post,
311 0 : &self.node_id_label,
312 0 : self.inner.top_tenant_shards(request).await
313 0 : )
314 0 : }
315 :
316 0 : pub(crate) async fn wait_lsn(
317 0 : &self,
318 0 : tenant_shard_id: TenantShardId,
319 0 : request: TenantWaitLsnRequest,
320 0 : ) -> Result<StatusCode> {
321 0 : measured_request!(
322 0 : "wait_lsn",
323 0 : crate::metrics::Method::Post,
324 0 : &self.node_id_label,
325 0 : self.inner.wait_lsn(tenant_shard_id, request).await
326 0 : )
327 0 : }
328 : }
|
