2023-09-29 16:41:00 +00:00
|
|
|
use std::fs::{self, Permissions};
|
|
|
|
|
use std::os::unix::fs::PermissionsExt;
|
2022-05-10 11:16:57 +00:00
|
|
|
use std::sync::Arc;
|
|
|
|
|
|
|
|
|
|
use async_trait::async_trait;
|
|
|
|
|
|
|
|
|
|
use futures::future::Future;
|
|
|
|
|
|
2022-05-24 10:16:39 +00:00
|
|
|
use hyper::header::HeaderValue;
|
2022-05-10 11:16:57 +00:00
|
|
|
use hyper::server::conn::AddrStream;
|
|
|
|
|
use hyper::service::{make_service_fn, service_fn};
|
|
|
|
|
use hyper::{Body, Request, Response, Server};
|
2022-05-24 10:16:39 +00:00
|
|
|
use hyper::{HeaderMap, StatusCode};
|
2022-05-10 11:16:57 +00:00
|
|
|
|
2023-09-29 16:41:00 +00:00
|
|
|
use hyperlocal::UnixServerExt;
|
|
|
|
|
|
|
|
|
|
use tokio::net::UnixStream;
|
|
|
|
|
|
2022-05-10 11:16:57 +00:00
|
|
|
use opentelemetry::{
|
|
|
|
|
global,
|
|
|
|
|
metrics::{Counter, ValueRecorder},
|
|
|
|
|
trace::{FutureExt, SpanRef, TraceContextExt, Tracer},
|
|
|
|
|
Context, KeyValue,
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
use garage_util::error::Error as GarageError;
|
2023-02-09 13:49:43 +00:00
|
|
|
use garage_util::forwarded_headers;
|
2022-05-10 11:16:57 +00:00
|
|
|
use garage_util::metrics::{gen_trace_id, RecordDuration};
|
2023-09-29 16:41:00 +00:00
|
|
|
use garage_util::socket_address::UnixOrTCPSocketAddress;
|
2022-05-10 11:16:57 +00:00
|
|
|
|
|
|
|
|
pub(crate) trait ApiEndpoint: Send + Sync + 'static {
|
|
|
|
|
fn name(&self) -> &'static str;
|
|
|
|
|
fn add_span_attributes(&self, span: SpanRef<'_>);
|
|
|
|
|
}
|
|
|
|
|
|
2022-05-24 10:16:39 +00:00
|
|
|
pub trait ApiError: std::error::Error + Send + Sync + 'static {
|
|
|
|
|
fn http_status_code(&self) -> StatusCode;
|
|
|
|
|
fn add_http_headers(&self, header_map: &mut HeaderMap<HeaderValue>);
|
|
|
|
|
fn http_body(&self, garage_region: &str, path: &str) -> Body;
|
|
|
|
|
}
|
|
|
|
|
|
2022-05-10 11:16:57 +00:00
|
|
|
#[async_trait]
|
|
|
|
|
pub(crate) trait ApiHandler: Send + Sync + 'static {
|
|
|
|
|
const API_NAME: &'static str;
|
|
|
|
|
const API_NAME_DISPLAY: &'static str;
|
|
|
|
|
|
|
|
|
|
type Endpoint: ApiEndpoint;
|
2022-05-24 10:16:39 +00:00
|
|
|
type Error: ApiError;
|
2022-05-10 11:16:57 +00:00
|
|
|
|
2022-05-24 10:16:39 +00:00
|
|
|
fn parse_endpoint(&self, r: &Request<Body>) -> Result<Self::Endpoint, Self::Error>;
|
2022-05-10 11:16:57 +00:00
|
|
|
async fn handle(
|
|
|
|
|
&self,
|
|
|
|
|
req: Request<Body>,
|
|
|
|
|
endpoint: Self::Endpoint,
|
2022-05-24 10:16:39 +00:00
|
|
|
) -> Result<Response<Body>, Self::Error>;
|
2022-05-10 11:16:57 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
pub(crate) struct ApiServer<A: ApiHandler> {
|
|
|
|
|
region: String,
|
|
|
|
|
api_handler: A,
|
|
|
|
|
|
|
|
|
|
// Metrics
|
|
|
|
|
request_counter: Counter<u64>,
|
|
|
|
|
error_counter: Counter<u64>,
|
|
|
|
|
request_duration: ValueRecorder<f64>,
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
impl<A: ApiHandler> ApiServer<A> {
|
|
|
|
|
pub fn new(region: String, api_handler: A) -> Arc<Self> {
|
|
|
|
|
let meter = global::meter("garage/api");
|
|
|
|
|
Arc::new(Self {
|
|
|
|
|
region,
|
|
|
|
|
api_handler,
|
|
|
|
|
request_counter: meter
|
|
|
|
|
.u64_counter(format!("api.{}.request_counter", A::API_NAME))
|
|
|
|
|
.with_description(format!(
|
|
|
|
|
"Number of API calls to the various {} API endpoints",
|
|
|
|
|
A::API_NAME_DISPLAY
|
|
|
|
|
))
|
|
|
|
|
.init(),
|
|
|
|
|
error_counter: meter
|
|
|
|
|
.u64_counter(format!("api.{}.error_counter", A::API_NAME))
|
|
|
|
|
.with_description(format!(
|
|
|
|
|
"Number of API calls to the various {} API endpoints that resulted in errors",
|
|
|
|
|
A::API_NAME_DISPLAY
|
|
|
|
|
))
|
|
|
|
|
.init(),
|
|
|
|
|
request_duration: meter
|
|
|
|
|
.f64_value_recorder(format!("api.{}.request_duration", A::API_NAME))
|
|
|
|
|
.with_description(format!(
|
|
|
|
|
"Duration of API calls to the various {} API endpoints",
|
|
|
|
|
A::API_NAME_DISPLAY
|
|
|
|
|
))
|
|
|
|
|
.init(),
|
|
|
|
|
})
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
pub async fn run_server(
|
|
|
|
|
self: Arc<Self>,
|
2023-09-29 16:41:00 +00:00
|
|
|
bind_addr: UnixOrTCPSocketAddress,
|
2023-10-03 15:31:40 +00:00
|
|
|
unix_bind_addr_mode: Option<u32>,
|
2022-05-10 11:16:57 +00:00
|
|
|
shutdown_signal: impl Future<Output = ()>,
|
|
|
|
|
) -> Result<(), GarageError> {
|
2023-09-29 16:41:00 +00:00
|
|
|
let tcp_service = make_service_fn(|conn: &AddrStream| {
|
2022-05-10 11:16:57 +00:00
|
|
|
let this = self.clone();
|
|
|
|
|
|
|
|
|
|
let client_addr = conn.remote_addr();
|
|
|
|
|
async move {
|
|
|
|
|
Ok::<_, GarageError>(service_fn(move |req: Request<Body>| {
|
|
|
|
|
let this = this.clone();
|
|
|
|
|
|
2023-09-29 16:41:00 +00:00
|
|
|
this.handler(req, client_addr.to_string())
|
2022-05-10 11:16:57 +00:00
|
|
|
}))
|
|
|
|
|
}
|
|
|
|
|
});
|
|
|
|
|
|
2023-09-29 16:41:00 +00:00
|
|
|
let unix_service = make_service_fn(|_: &UnixStream| {
|
|
|
|
|
let this = self.clone();
|
|
|
|
|
|
|
|
|
|
let path = bind_addr.to_string();
|
|
|
|
|
async move {
|
|
|
|
|
Ok::<_, GarageError>(service_fn(move |req: Request<Body>| {
|
|
|
|
|
let this = this.clone();
|
|
|
|
|
|
|
|
|
|
this.handler(req, path.clone())
|
|
|
|
|
}))
|
|
|
|
|
}
|
|
|
|
|
});
|
2022-05-10 11:16:57 +00:00
|
|
|
|
|
|
|
|
info!(
|
2023-09-29 16:41:00 +00:00
|
|
|
"{} API server listening on {}",
|
2022-05-10 11:16:57 +00:00
|
|
|
A::API_NAME_DISPLAY,
|
|
|
|
|
bind_addr
|
|
|
|
|
);
|
|
|
|
|
|
2023-09-29 16:41:00 +00:00
|
|
|
match bind_addr {
|
|
|
|
|
UnixOrTCPSocketAddress::TCPSocket(addr) => {
|
|
|
|
|
Server::bind(&addr)
|
|
|
|
|
.serve(tcp_service)
|
|
|
|
|
.with_graceful_shutdown(shutdown_signal)
|
|
|
|
|
.await?
|
|
|
|
|
}
|
|
|
|
|
UnixOrTCPSocketAddress::UnixSocket(ref path) => {
|
|
|
|
|
if path.exists() {
|
|
|
|
|
fs::remove_file(path)?
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
let bound = Server::bind_unix(path)?;
|
|
|
|
|
|
2023-10-03 15:31:40 +00:00
|
|
|
fs::set_permissions(
|
|
|
|
|
path,
|
|
|
|
|
Permissions::from_mode(unix_bind_addr_mode.unwrap_or(0o222)),
|
|
|
|
|
)?;
|
2023-09-29 16:41:00 +00:00
|
|
|
|
|
|
|
|
bound
|
|
|
|
|
.serve(unix_service)
|
|
|
|
|
.with_graceful_shutdown(shutdown_signal)
|
|
|
|
|
.await?;
|
|
|
|
|
}
|
|
|
|
|
};
|
|
|
|
|
|
2022-05-10 11:16:57 +00:00
|
|
|
Ok(())
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
async fn handler(
|
|
|
|
|
self: Arc<Self>,
|
|
|
|
|
req: Request<Body>,
|
2023-09-29 16:41:00 +00:00
|
|
|
addr: String,
|
2022-05-10 11:16:57 +00:00
|
|
|
) -> Result<Response<Body>, GarageError> {
|
|
|
|
|
let uri = req.uri().clone();
|
2023-02-04 09:49:56 +00:00
|
|
|
|
2023-02-09 13:49:43 +00:00
|
|
|
if let Ok(forwarded_for_ip_addr) =
|
2023-05-09 19:49:34 +00:00
|
|
|
forwarded_headers::handle_forwarded_for_headers(req.headers())
|
2023-02-09 13:49:43 +00:00
|
|
|
{
|
2023-02-04 09:49:56 +00:00
|
|
|
info!(
|
|
|
|
|
"{} (via {}) {} {}",
|
|
|
|
|
forwarded_for_ip_addr,
|
|
|
|
|
addr,
|
|
|
|
|
req.method(),
|
|
|
|
|
uri
|
|
|
|
|
);
|
|
|
|
|
} else {
|
|
|
|
|
info!("{} {} {}", addr, req.method(), uri);
|
|
|
|
|
}
|
2022-05-10 11:16:57 +00:00
|
|
|
debug!("{:?}", req);
|
|
|
|
|
|
|
|
|
|
let tracer = opentelemetry::global::tracer("garage");
|
|
|
|
|
let span = tracer
|
|
|
|
|
.span_builder(format!("{} API call (unknown)", A::API_NAME_DISPLAY))
|
|
|
|
|
.with_trace_id(gen_trace_id())
|
|
|
|
|
.with_attributes(vec![
|
|
|
|
|
KeyValue::new("method", format!("{}", req.method())),
|
|
|
|
|
KeyValue::new("uri", req.uri().to_string()),
|
|
|
|
|
])
|
|
|
|
|
.start(&tracer);
|
|
|
|
|
|
|
|
|
|
let res = self
|
|
|
|
|
.handler_stage2(req)
|
|
|
|
|
.with_context(Context::current_with_span(span))
|
|
|
|
|
.await;
|
|
|
|
|
|
|
|
|
|
match res {
|
|
|
|
|
Ok(x) => {
|
|
|
|
|
debug!("{} {:?}", x.status(), x.headers());
|
|
|
|
|
Ok(x)
|
|
|
|
|
}
|
|
|
|
|
Err(e) => {
|
2022-05-24 10:16:39 +00:00
|
|
|
let body: Body = e.http_body(&self.region, uri.path());
|
2022-05-25 15:05:56 +00:00
|
|
|
let mut http_error_builder = Response::builder().status(e.http_status_code());
|
2022-05-10 11:16:57 +00:00
|
|
|
|
|
|
|
|
if let Some(header_map) = http_error_builder.headers_mut() {
|
2022-05-24 10:16:39 +00:00
|
|
|
e.add_http_headers(header_map)
|
2022-05-10 11:16:57 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
let http_error = http_error_builder.body(body)?;
|
|
|
|
|
|
|
|
|
|
if e.http_status_code().is_server_error() {
|
|
|
|
|
warn!("Response: error {}, {}", e.http_status_code(), e);
|
|
|
|
|
} else {
|
|
|
|
|
info!("Response: error {}, {}", e.http_status_code(), e);
|
|
|
|
|
}
|
|
|
|
|
Ok(http_error)
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2022-05-24 10:16:39 +00:00
|
|
|
async fn handler_stage2(&self, req: Request<Body>) -> Result<Response<Body>, A::Error> {
|
2022-05-10 11:16:57 +00:00
|
|
|
let endpoint = self.api_handler.parse_endpoint(&req)?;
|
|
|
|
|
debug!("Endpoint: {}", endpoint.name());
|
|
|
|
|
|
|
|
|
|
let current_context = Context::current();
|
|
|
|
|
let current_span = current_context.span();
|
2022-09-26 14:20:30 +00:00
|
|
|
current_span.update_name::<String>(format!(
|
|
|
|
|
"{} API {}",
|
|
|
|
|
A::API_NAME_DISPLAY,
|
|
|
|
|
endpoint.name()
|
|
|
|
|
));
|
2022-05-10 11:16:57 +00:00
|
|
|
current_span.set_attribute(KeyValue::new("endpoint", endpoint.name()));
|
|
|
|
|
endpoint.add_span_attributes(current_span);
|
|
|
|
|
|
|
|
|
|
let metrics_tags = &[KeyValue::new("api_endpoint", endpoint.name())];
|
|
|
|
|
|
|
|
|
|
let res = self
|
|
|
|
|
.api_handler
|
|
|
|
|
.handle(req, endpoint)
|
|
|
|
|
.record_duration(&self.request_duration, &metrics_tags[..])
|
|
|
|
|
.await;
|
|
|
|
|
|
|
|
|
|
self.request_counter.add(1, &metrics_tags[..]);
|
|
|
|
|
|
|
|
|
|
let status_code = match &res {
|
|
|
|
|
Ok(r) => r.status(),
|
|
|
|
|
Err(e) => e.http_status_code(),
|
|
|
|
|
};
|
|
|
|
|
if status_code.is_client_error() || status_code.is_server_error() {
|
|
|
|
|
self.error_counter.add(
|
|
|
|
|
1,
|
|
|
|
|
&[
|
|
|
|
|
metrics_tags[0].clone(),
|
|
|
|
|
KeyValue::new("status_code", status_code.as_str().to_string()),
|
|
|
|
|
],
|
|
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
res
|
|
|
|
|
}
|
|
|
|
|
}
|
