Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add optional shutdown timeout to servers #43

Merged
merged 1 commit into from
Nov 22, 2023
Merged

feat: add optional shutdown timeout to servers #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ publish = false
anyhow = { version = "1.0", features = [ "backtrace" ] }
axum = { version = "0.6", features = [ "http2", "json" ] }
configured = { version = "0.7" }
humantime-serde = { version = "1.1" }
opentelemetry = { version = "0.21" }
opentelemetry_sdk = { version = "0.21", features = [ "rt-tokio" ] }
opentelemetry-http = { version = "0.10", features = [ "reqwest" ] }
Expand Down
1 change: 1 addition & 0 deletions hello-tracing-backend/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ hello-tracing-common = { path = "../hello-tracing-common" }
anyhow = { workspace = true }
axum = { workspace = true }
configured = { workspace = true }
humantime-serde = { workspace = true }
opentelemetry = { workspace = true }
opentelemetry-http = { workspace = true }
opentelemetry-otlp = { workspace = true }
Expand Down
1 change: 1 addition & 0 deletions hello-tracing-backend/config/default.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
api:
addr: 0.0.0.0
port: 8080
shutdown-timeout: 3s

tracing:
service-name: hello-tracing-backend
Expand Down
30 changes: 18 additions & 12 deletions hello-tracing-backend/src/api/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,11 @@ use anyhow::{Context, Result};
use axum::{body::Body, http::Request};
use hello_tracing_common::otel::http::{accept_trace, record_trace_id};
use serde::Deserialize;
use std::net::{IpAddr, SocketAddr};
use tokio::signal::unix::{signal, SignalKind};
use std::{net::IpAddr, time::Duration};
use tokio::{
signal::unix::{signal, SignalKind},
time,
};
use tonic::transport::Server;
use tower::ServiceBuilder;
use tower_http::trace::TraceLayer;
Expand All @@ -16,16 +19,16 @@ use tracing::{field, info_span, Span};
pub struct Config {
addr: IpAddr,
port: u16,
}

impl Config {
fn socket_addr(&self) -> SocketAddr {
SocketAddr::new(self.addr, self.port)
}
#[serde(with = "humantime_serde")]
shutdown_timeout: Option<Duration>,
}

pub async fn serve(config: Config) -> Result<()> {
let socket_addr = config.socket_addr();
let Config {
addr,
port,
shutdown_timeout,
} = config;

let app = Server::builder()
.layer(
Expand All @@ -36,19 +39,22 @@ pub async fn serve(config: Config) -> Result<()> {
)
.add_service(v0::hello());

app.serve_with_shutdown(socket_addr, shutdown_signal())
app.serve_with_shutdown((addr, port).into(), shutdown_signal(shutdown_timeout))
.await
.context("serving the api")
.context("run server")
}

fn make_span(request: &Request<Body>) -> Span {
let headers = request.headers();
info_span!("incoming request", ?headers, trace_id = field::Empty)
}

async fn shutdown_signal() {
async fn shutdown_signal(shutdown_timeout: Option<Duration>) {
signal(SignalKind::terminate())
.expect("install SIGTERM handler")
.recv()
.await;
if let Some(shutdown_timeout) = shutdown_timeout {
time::sleep(shutdown_timeout).await;
}
}
1 change: 1 addition & 0 deletions hello-tracing-gateway/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ hello-tracing-common = { path = "../hello-tracing-common" }
anyhow = { workspace = true }
axum = { workspace = true }
configured = { workspace = true }
humantime-serde = { workspace = true }
opentelemetry = { workspace = true }
opentelemetry-http = { workspace = true }
opentelemetry-otlp = { workspace = true }
Expand Down
1 change: 1 addition & 0 deletions hello-tracing-gateway/config/default.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
api:
addr: 0.0.0.0
port: 8080
shutdown-timeout: 3s

# backend:
# endpoint: ...
Expand Down
32 changes: 20 additions & 12 deletions hello-tracing-gateway/src/api/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,11 @@ use axum::{
};
use hello_tracing_common::otel::http::{accept_trace, record_trace_id};
use serde::Deserialize;
use std::net::{IpAddr, SocketAddr};
use tokio::signal::unix::{signal, SignalKind};
use std::{net::IpAddr, time::Duration};
use tokio::{
signal::unix::{signal, SignalKind},
time,
};
use tower::ServiceBuilder;
use tower_http::trace::TraceLayer;
use tracing::{field, info_span, Span};
Expand All @@ -22,15 +25,17 @@ use tracing::{field, info_span, Span};
pub struct Config {
addr: IpAddr,
port: u16,
}

impl Config {
fn socket_addr(&self) -> SocketAddr {
SocketAddr::new(self.addr, self.port)
}
#[serde(with = "humantime_serde")]
shutdown_timeout: Option<Duration>,
}

pub async fn serve(config: Config, backend: Backend) -> Result<()> {
let Config {
addr,
port,
shutdown_timeout,
} = config;

let app = Router::new()
.route("/", get(ready))
.nest("/v0", v0::app(backend))
Expand All @@ -41,11 +46,11 @@ pub async fn serve(config: Config, backend: Backend) -> Result<()> {
.map_request(record_trace_id),
);

Server::bind(&config.socket_addr())
Server::bind(&(addr, port).into())
.serve(app.into_make_service())
.with_graceful_shutdown(shutdown_signal())
.with_graceful_shutdown(shutdown_signal(shutdown_timeout))
.await
.context("serving api")
.context("run server")
}

async fn ready() -> impl IntoResponse {
Expand All @@ -57,9 +62,12 @@ fn make_span(request: &Request<Body>) -> Span {
info_span!("incoming request", ?headers, trace_id = field::Empty)
}

async fn shutdown_signal() {
async fn shutdown_signal(shutdown_timeout: Option<Duration>) {
signal(SignalKind::terminate())
.expect("install SIGTERM handler")
.recv()
.await;
if let Some(shutdown_timeout) = shutdown_timeout {
time::sleep(shutdown_timeout).await;
}
}
4 changes: 2 additions & 2 deletions justfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,14 @@ run-gateway port="8080" backend_port="8081":
APP__API__PORT={{port}} \
APP__BACKEND__ENDPOINT=http://localhost:{{backend_port}} \
cargo run -p hello-tracing-gateway \
> $HOME/tmp/hello-tracing-gateway.log
| jq

run-backend port="8081":
RUST_LOG=hello_tracing_backend=debug,info \
CONFIG_DIR=hello-tracing-backend/config \
APP__API__PORT={{port}} \
cargo run -p hello-tracing-backend \
> $HOME/tmp/hello-tracing-backend.log
| jq

docker tag="latest":
docker build \
Expand Down