service_v2.rs 21.9 KB
Newer Older
1
// SPDX-FileCopyrightText: Copyright (c) 2024-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2
// SPDX-License-Identifier: Apache-2.0
3

4
use std::collections::HashMap;
5
use std::env::var;
Graham King's avatar
Graham King committed
6
use std::path::PathBuf;
7
use std::sync::Arc;
8
9
use std::sync::atomic::AtomicBool;
use std::sync::atomic::Ordering;
10
use std::time::Duration;
11

12
13
14
use axum::body::Body;
use axum::http::Response;

15
use super::Metrics;
16
use super::RouteDoc;
17
use super::metrics;
18
use super::metrics::register_worker_timing_metrics;
19
use crate::discovery::ModelManager;
20
use crate::endpoint_type::EndpointType;
21
use crate::kv_router::metrics::{register_routing_overhead_metrics, register_worker_load_metrics};
22
use crate::request_template::RequestTemplate;
23
use anyhow::Result;
Graham King's avatar
Graham King committed
24
use axum_server::tls_rustls::RustlsConfig;
25
use derive_builder::Builder;
26
use dynamo_runtime::config::environment_names::llm as env_llm;
27
use dynamo_runtime::discovery::{Discovery, KVStoreDiscovery};
28
use dynamo_runtime::logging::make_request_span;
29
use dynamo_runtime::storage::kv;
Graham King's avatar
Graham King committed
30
use std::net::SocketAddr;
31
use tokio::task::JoinHandle;
32
use tokio_util::sync::CancellationToken;
33
use tower_http::trace::TraceLayer;
34

35
36
37
38
/// HTTP service shared state
pub struct State {
    metrics: Arc<Metrics>,
    manager: Arc<ModelManager>,
39
    store: kv::Manager,
40
    discovery_client: Arc<dyn Discovery>,
41
    flags: StateFlags,
42
    cancel_token: CancellationToken,
43
44
45
46
47
48
49
}

#[derive(Default, Debug)]
struct StateFlags {
    chat_endpoints_enabled: AtomicBool,
    cmpl_endpoints_enabled: AtomicBool,
    embeddings_endpoints_enabled: AtomicBool,
50
    images_endpoints_enabled: AtomicBool,
51
    videos_endpoints_enabled: AtomicBool,
52
53
54
55
56
57
58
59
60
    responses_endpoints_enabled: AtomicBool,
}

impl StateFlags {
    pub fn get(&self, endpoint_type: &EndpointType) -> bool {
        match endpoint_type {
            EndpointType::Chat => self.chat_endpoints_enabled.load(Ordering::Relaxed),
            EndpointType::Completion => self.cmpl_endpoints_enabled.load(Ordering::Relaxed),
            EndpointType::Embedding => self.embeddings_endpoints_enabled.load(Ordering::Relaxed),
61
            EndpointType::Images => self.images_endpoints_enabled.load(Ordering::Relaxed),
62
            EndpointType::Videos => self.videos_endpoints_enabled.load(Ordering::Relaxed),
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
            EndpointType::Responses => self.responses_endpoints_enabled.load(Ordering::Relaxed),
        }
    }

    pub fn set(&self, endpoint_type: &EndpointType, enabled: bool) {
        match endpoint_type {
            EndpointType::Chat => self
                .chat_endpoints_enabled
                .store(enabled, Ordering::Relaxed),
            EndpointType::Completion => self
                .cmpl_endpoints_enabled
                .store(enabled, Ordering::Relaxed),
            EndpointType::Embedding => self
                .embeddings_endpoints_enabled
                .store(enabled, Ordering::Relaxed),
78
79
80
            EndpointType::Images => self
                .images_endpoints_enabled
                .store(enabled, Ordering::Relaxed),
81
82
83
            EndpointType::Videos => self
                .videos_endpoints_enabled
                .store(enabled, Ordering::Relaxed),
84
85
86
87
88
            EndpointType::Responses => self
                .responses_endpoints_enabled
                .store(enabled, Ordering::Relaxed),
        }
    }
89
90
91
}

impl State {
92
93
94
95
96
    pub fn new(
        manager: Arc<ModelManager>,
        store: kv::Manager,
        cancel_token: CancellationToken,
    ) -> Self {
97
98
99
        // Initialize discovery backed by KV store
        // Create a cancellation token for the discovery's watch streams
        let discovery_client = {
100
101
102
            let discovery_cancel_token = cancel_token.child_token();
            Arc::new(KVStoreDiscovery::new(store.clone(), discovery_cancel_token))
                as Arc<dyn Discovery>
103
104
        };

105
106
107
        Self {
            manager,
            metrics: Arc::new(Metrics::default()),
108
            store,
109
            discovery_client,
110
111
112
113
            flags: StateFlags {
                chat_endpoints_enabled: AtomicBool::new(false),
                cmpl_endpoints_enabled: AtomicBool::new(false),
                embeddings_endpoints_enabled: AtomicBool::new(false),
114
                images_endpoints_enabled: AtomicBool::new(false),
115
                videos_endpoints_enabled: AtomicBool::new(false),
116
117
                responses_endpoints_enabled: AtomicBool::new(false),
            },
118
            cancel_token,
119
120
121
        }
    }

122
123
124
125
126
127
128
129
130
131
132
133
134
    /// Get the Prometheus [`Metrics`] object which tracks request counts and inflight requests
    pub fn metrics_clone(&self) -> Arc<Metrics> {
        self.metrics.clone()
    }

    pub fn manager(&self) -> &ModelManager {
        Arc::as_ref(&self.manager)
    }

    pub fn manager_clone(&self) -> Arc<ModelManager> {
        self.manager.clone()
    }

135
    pub fn store(&self) -> &kv::Manager {
136
        &self.store
137
138
    }

139
140
141
142
    pub fn discovery(&self) -> Arc<dyn Discovery> {
        self.discovery_client.clone()
    }

143
144
145
146
147
148
149
150
151
152
    /// Check if the service is shutting down
    pub fn is_cancelled(&self) -> bool {
        self.cancel_token.is_cancelled()
    }

    /// Get the cancellation token
    pub fn cancel_token(&self) -> &CancellationToken {
        &self.cancel_token
    }

153
154
155
156
157
158
    // TODO
    pub fn sse_keep_alive(&self) -> Option<Duration> {
        None
    }
}

159
160
#[derive(Clone)]
pub struct HttpService {
161
162
163
    // The state we share with every request handler
    state: Arc<State>,

164
165
    router: axum::Router,
    port: u16,
166
    host: String,
Graham King's avatar
Graham King committed
167
168
169
    enable_tls: bool,
    tls_cert_path: Option<PathBuf>,
    tls_key_path: Option<PathBuf>,
170
    route_docs: Vec<RouteDoc>,
171
172
173
}

#[derive(Clone, Builder)]
174
#[builder(pattern = "owned", build_fn(private, name = "build_internal"))]
175
176
177
178
pub struct HttpServiceConfig {
    #[builder(default = "8787")]
    port: u16,

179
180
181
    #[builder(setter(into), default = "String::from(\"0.0.0.0\")")]
    host: String,

Graham King's avatar
Graham King committed
182
183
184
185
186
187
188
189
190
    #[builder(default = "false")]
    enable_tls: bool,

    #[builder(default = "None")]
    tls_cert_path: Option<PathBuf>,

    #[builder(default = "None")]
    tls_key_path: Option<PathBuf>,

191
192
    // #[builder(default)]
    // custom: Vec<axum::Router>
193
    #[builder(default = "false")]
194
195
    enable_chat_endpoints: bool,

196
    #[builder(default = "false")]
197
    enable_cmpl_endpoints: bool,
198

199
    #[builder(default = "true")]
200
201
    enable_embeddings_endpoints: bool,

202
203
204
    #[builder(default = "true")]
    enable_responses_endpoints: bool,

205
206
    #[builder(default = "None")]
    request_template: Option<RequestTemplate>,
207

208
    #[builder(default)]
209
    store: kv::Manager,
210
211
212
213
214
215
216
}

impl HttpService {
    pub fn builder() -> HttpServiceConfigBuilder {
        HttpServiceConfigBuilder::default()
    }

217
218
219
220
221
222
223
224
    pub fn state_clone(&self) -> Arc<State> {
        self.state.clone()
    }

    pub fn state(&self) -> &State {
        Arc::as_ref(&self.state)
    }

225
    pub fn model_manager(&self) -> &ModelManager {
226
        self.state().manager()
227
228
    }

229
230
231
232
233
234
    pub async fn spawn(&self, cancel_token: CancellationToken) -> JoinHandle<Result<()>> {
        let this = self.clone();
        tokio::spawn(async move { this.run(cancel_token).await })
    }

    pub async fn run(&self, cancel_token: CancellationToken) -> Result<()> {
235
        let address = format!("{}:{}", self.host, self.port);
Graham King's avatar
Graham King committed
236
237
        let protocol = if self.enable_tls { "HTTPS" } else { "HTTP" };
        tracing::info!(protocol, address, "Starting HTTP(S) service");
238
239
240
241

        let router = self.router.clone();
        let observer = cancel_token.child_token();

242
243
        let state_cancel = self.state.cancel_token().clone();

Graham King's avatar
Graham King committed
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
        let addr: SocketAddr = address
            .parse()
            .map_err(|e| anyhow::anyhow!("Invalid address '{}': {}", address, e))?;

        if self.enable_tls {
            let cert_path = self
                .tls_cert_path
                .as_ref()
                .ok_or_else(|| anyhow::anyhow!("TLS certificate path not provided"))?;
            let key_path = self
                .tls_key_path
                .as_ref()
                .ok_or_else(|| anyhow::anyhow!("TLS private key path not provided"))?;

            // aws_lc_rs is the default but other crates pull in `ring` also,
            // so rustls doesn't know which one to use. Tell it.
            if let Err(e) = rustls::crypto::aws_lc_rs::default_provider().install_default() {
                tracing::debug!("TLS crypto provider already installed: {e:?}");
            }

            let config = RustlsConfig::from_pem_file(cert_path, key_path)
                .await
                .map_err(|e| anyhow::anyhow!("Failed to create TLS config: {}", e))?;

            let handle = axum_server::Handle::new();
            let server = axum_server::bind_rustls(addr, config)
                .handle(handle.clone())
                .serve(router.into_make_service());

            tokio::select! {
                result = server => {
                    result.map_err(|e| anyhow::anyhow!("HTTPS server error: {}", e))?;
                }
                _ = observer.cancelled() => {
278
                    state_cancel.cancel();
Graham King's avatar
Graham King committed
279
                    tracing::info!("HTTPS server shutdown requested");
280
281
282
                    // accepting requests for 5 more seconds, to allow incorrectly routed requests to arrive
                    handle.graceful_shutdown(Some(Duration::from_secs(get_graceful_shutdown_timeout() as u64)));
                    // no longer accepting requests, draining all existing connections
Graham King's avatar
Graham King committed
283
284
285
                }
            }
        } else {
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
            let listener = tokio::net::TcpListener::bind(addr).await.map_err(|e| {
                tracing::error!(
                    protocol = %protocol,
                    address = %address,
                    error = %e,
                    "Failed to bind server to address"
                );
                match e.kind() {
                    std::io::ErrorKind::AddrInUse => anyhow::anyhow!(
                        "Failed to start {} server: port {} already in use. Use --http-port to specify a different port.",
                        protocol,
                        self.port
                    ),
                    _ => anyhow::anyhow!(
                        "Failed to start {} server on {}: {}",
                        protocol,
                        address,
                        e
                    ),
                }
            })?;
Graham King's avatar
Graham King committed
307
308

            axum::serve(listener, router)
309
310
311
312
313
314
315
316
317
                .with_graceful_shutdown(async move {
                    observer.cancelled_owned().await;
                    state_cancel.cancel();
                    tracing::info!("HTTP server shutdown requested");
                    // accepting requests for 5 more seconds, to allow incorrectly routed requests to arrive
                    tokio::time::sleep(Duration::from_secs(get_graceful_shutdown_timeout() as u64))
                        .await;
                    // no longer accepting requests, draining all existing connections
                })
Graham King's avatar
Graham King committed
318
319
320
                .await
                .inspect_err(|_| cancel_token.cancel())?;
        }
321
322

        Ok(())
323
    }
324
325
326
327
328

    /// Documentation of exposed HTTP endpoints
    pub fn route_docs(&self) -> &[RouteDoc] {
        &self.route_docs
    }
329

330
    pub fn enable_model_endpoint(&self, endpoint_type: EndpointType, enable: bool) {
331
332
333
334
335
336
337
        self.state.flags.set(&endpoint_type, enable);
        tracing::info!(
            "{} endpoints {}",
            endpoint_type.as_str(),
            if enable { "enabled" } else { "disabled" }
        );
    }
338
339
}

340
341
342
343
344
345
346
fn get_graceful_shutdown_timeout() -> usize {
    std::env::var(env_llm::DYN_HTTP_GRACEFUL_SHUTDOWN_TIMEOUT_SECS)
        .ok()
        .and_then(|s| s.parse::<usize>().ok())
        .unwrap_or(5)
}

347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
/// Environment variable to set the metrics endpoint path (default: `/metrics`)
static HTTP_SVC_METRICS_PATH_ENV: &str = "DYN_HTTP_SVC_METRICS_PATH";
/// Environment variable to set the models endpoint path (default: `/v1/models`)
static HTTP_SVC_MODELS_PATH_ENV: &str = "DYN_HTTP_SVC_MODELS_PATH";
/// Environment variable to set the health endpoint path (default: `/health`)
static HTTP_SVC_HEALTH_PATH_ENV: &str = "DYN_HTTP_SVC_HEALTH_PATH";
/// Environment variable to set the live endpoint path (default: `/live`)
static HTTP_SVC_LIVE_PATH_ENV: &str = "DYN_HTTP_SVC_LIVE_PATH";
/// Environment variable to set the chat completions endpoint path (default: `/v1/chat/completions`)
static HTTP_SVC_CHAT_PATH_ENV: &str = "DYN_HTTP_SVC_CHAT_PATH";
/// Environment variable to set the completions endpoint path (default: `/v1/completions`)
static HTTP_SVC_CMP_PATH_ENV: &str = "DYN_HTTP_SVC_CMP_PATH";
/// Environment variable to set the embeddings endpoint path (default: `/v1/embeddings`)
static HTTP_SVC_EMB_PATH_ENV: &str = "DYN_HTTP_SVC_EMB_PATH";
/// Environment variable to set the responses endpoint path (default: `/v1/responses`)
static HTTP_SVC_RESPONSES_PATH_ENV: &str = "DYN_HTTP_SVC_RESPONSES_PATH";

364
365
impl HttpServiceConfigBuilder {
    pub fn build(self) -> Result<HttpService, anyhow::Error> {
366
        let config: HttpServiceConfig = self.build_internal()?;
367

368
        let model_manager = Arc::new(ModelManager::new());
369
370
371
        // Create a temporary cancel token for building - will be replaced in spawn/run
        let temp_cancel_token = CancellationToken::new();
        let state = Arc::new(State::new(model_manager, config.store, temp_cancel_token));
372
373
374
375
376
377
378
379
380
381
382
383
384
        state
            .flags
            .set(&EndpointType::Chat, config.enable_chat_endpoints);
        state
            .flags
            .set(&EndpointType::Completion, config.enable_cmpl_endpoints);
        state
            .flags
            .set(&EndpointType::Embedding, config.enable_embeddings_endpoints);
        state
            .flags
            .set(&EndpointType::Responses, config.enable_responses_endpoints);

385
386
        // enable prometheus metrics
        let registry = metrics::Registry::new();
387
        state.metrics_clone().register(&registry)?;
388

389
390
391
392
393
394
395
396
397
398
399
400
        // Register worker load metrics (active_decode_blocks, active_prefill_tokens per worker)
        // These are updated by KvWorkerMonitor when receiving ActiveLoad events
        if let Err(e) = register_worker_load_metrics(&registry) {
            tracing::warn!("Failed to register worker load metrics: {}", e);
        }

        // Register worker timing metrics (last_ttft, last_itl per worker)
        // These are updated by ResponseMetricCollector when observing TTFT/ITL
        if let Err(e) = register_worker_timing_metrics(&registry) {
            tracing::warn!("Failed to register worker timing metrics: {}", e);
        }

401
402
403
404
405
406
        // Register routing overhead metrics (block hashing, find matches, scheduling latencies)
        // These are updated by KvRouter::find_best_match on every routing decision
        if let Err(e) = register_routing_overhead_metrics(&registry) {
            tracing::warn!("Failed to register routing overhead metrics: {}", e);
        }

407
        let mut router = axum::Router::new();
408

409
410
411
        let mut all_docs = Vec::new();

        let mut routes = vec![
412
413
414
415
            metrics::router(registry, var(HTTP_SVC_METRICS_PATH_ENV).ok()),
            super::openai::list_models_router(state.clone(), var(HTTP_SVC_MODELS_PATH_ENV).ok()),
            super::health::health_check_router(state.clone(), var(HTTP_SVC_HEALTH_PATH_ENV).ok()),
            super::health::live_check_router(state.clone(), var(HTTP_SVC_LIVE_PATH_ENV).ok()),
416
            super::busy_threshold::busy_threshold_router(state.clone(), None),
417
418
        ];

419
420
421
422
        let endpoint_routes =
            HttpServiceConfigBuilder::get_endpoints_router(state.clone(), &config.request_template);
        routes.extend(endpoint_routes);
        for (route_docs, route) in routes {
423
424
425
426
            router = router.merge(route);
            all_docs.extend(route_docs);
        }

427
428
429
430
431
432
433
        // Add OpenAPI documentation routes (must be after all other routes so it can document them)
        // Note: The path parameter is currently unused as SwaggerUi requires static paths
        let (openapi_docs, openapi_route) =
            super::openapi_docs::openapi_router(all_docs.clone(), None);
        router = router.merge(openapi_route);
        all_docs.extend(openapi_docs);

434
        // Add span for tracing
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
        // Add on_response callback for logging response status code
        router = router.layer(
            TraceLayer::new_for_http()
                .make_span_with(make_request_span)
                .on_response(
                    |response: &Response<Body>, latency: Duration, _span: &tracing::Span| {
                        let status = response.status();
                        let latency_ms = latency.as_millis();

                        if status.is_server_error() {
                            tracing::error!(
                                status = %status.as_u16(),
                                latency_ms = %latency_ms,
                                "request completed with server error"
                            );
                        } else if status.is_client_error() {
                            tracing::warn!(
                                status = %status.as_u16(),
                                latency_ms = %latency_ms,
                                "request completed with client request error"
                            );
                        } else {
                            tracing::debug!(
                                status = %status.as_u16(),
                                latency_ms = %latency_ms,
                                "request completed"
                            );
                        }
                    },
                ),
        );
466

467
        Ok(HttpService {
468
            state,
469
470
            router,
            port: config.port,
471
            host: config.host,
Graham King's avatar
Graham King committed
472
473
474
            enable_tls: config.enable_tls,
            tls_cert_path: config.tls_cert_path,
            tls_key_path: config.tls_key_path,
475
            route_docs: all_docs,
476
477
        })
    }
478
479
480
481
482

    pub fn with_request_template(mut self, request_template: Option<RequestTemplate>) -> Self {
        self.request_template = Some(request_template);
        self
    }
483

484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
    fn get_endpoints_router(
        state: Arc<State>,
        request_template: &Option<RequestTemplate>,
    ) -> Vec<(Vec<RouteDoc>, axum::Router)> {
        let mut routes = Vec::new();
        // Add chat completions route with conditional middleware
        let (chat_docs, chat_route) = super::openai::chat_completions_router(
            state.clone(),
            request_template.clone(),
            var(HTTP_SVC_CHAT_PATH_ENV).ok(),
        );
        let (cmpl_docs, cmpl_route) =
            super::openai::completions_router(state.clone(), var(HTTP_SVC_CMP_PATH_ENV).ok());
        let (embed_docs, embed_route) =
            super::openai::embeddings_router(state.clone(), var(HTTP_SVC_EMB_PATH_ENV).ok());
499
        let (images_docs, images_route) = super::openai::images_router(state.clone(), None);
500
        let (videos_docs, videos_route) = super::openai::videos_router(state.clone(), None);
501
502
503
504
505
506
507
508
509
510
        let (responses_docs, responses_route) = super::openai::responses_router(
            state.clone(),
            request_template.clone(),
            var(HTTP_SVC_RESPONSES_PATH_ENV).ok(),
        );

        let mut endpoint_routes = HashMap::new();
        endpoint_routes.insert(EndpointType::Chat, (chat_docs, chat_route));
        endpoint_routes.insert(EndpointType::Completion, (cmpl_docs, cmpl_route));
        endpoint_routes.insert(EndpointType::Embedding, (embed_docs, embed_route));
511
        endpoint_routes.insert(EndpointType::Images, (images_docs, images_route));
512
        endpoint_routes.insert(EndpointType::Videos, (videos_docs, videos_route));
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
        endpoint_routes.insert(EndpointType::Responses, (responses_docs, responses_route));

        for endpoint_type in EndpointType::all() {
            let state_route = state.clone();
            if !endpoint_routes.contains_key(&endpoint_type) {
                tracing::debug!("{} endpoints are disabled", endpoint_type.as_str());
                continue;
            }
            let (docs, route) = endpoint_routes.get(&endpoint_type).cloned().unwrap();
            let route = route.route_layer(axum::middleware::from_fn(
                move |req: axum::http::Request<axum::body::Body>, next: axum::middleware::Next| {
                    let state: Arc<State> = state_route.clone();
                    async move {
                        // Check if the endpoint is enabled
                        let enabled = state.flags.get(&endpoint_type);
                        if enabled {
                            Ok(next.run(req).await)
                        } else {
                            tracing::debug!("{} endpoints are disabled", endpoint_type.as_str());
532
                            Err(axum::http::StatusCode::NOT_FOUND)
533
534
535
536
537
538
539
540
                        }
                    }
                },
            ));
            routes.push((docs, route));
        }
        routes
    }
541
}
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586

#[cfg(test)]
mod tests {
    use super::*;
    use serial_test::serial;
    use std::sync::Arc;
    use tokio_util::sync::CancellationToken;

    #[tokio::test]
    #[serial]
    async fn test_liveness_endpoint_reflects_cancellation() {
        // 1. Setup service & token
        let cancel_token = Arc::new(CancellationToken::new());
        let service = HttpService::builder().build().unwrap();
        let port = service.port;

        // 2. Spawn service with shared token
        let service_token = cancel_token.clone();
        let handle = tokio::spawn(async move {
            service.run((*service_token).clone()).await.unwrap();
        });

        tokio::time::sleep(std::time::Duration::from_millis(1)).await;

        // 3. Cancel the token
        cancel_token.cancel();

        // 4. Wait a tiny bit for propagation
        tokio::time::sleep(std::time::Duration::from_millis(20)).await;

        // 5. Hit the endpoint
        let client = reqwest::Client::new();
        let resp = client
            .get(format!("http://localhost:{}/live", port))
            .send()
            .await
            .expect("Request failed");

        // 6. ASSERTION: Should be 503 Service Unavailable
        assert_eq!(resp.status(), reqwest::StatusCode::SERVICE_UNAVAILABLE);

        // Clean up
        handle.abort();
    }
}