fix oxidecomputer#664: Generalize dtrace support to allow other traci…

…ng tools
adamchalmers · May 5, 2023 · 1cc4e3e · 1cc4e3e
1 parent 1b67aea
commit 1cc4e3e
Show file tree

Hide file tree

Showing 21 changed files with 335 additions and 179 deletions.
diff --git a/dropshot/examples/basic.rs b/dropshot/examples/basic.rs
@@ -2,6 +2,7 @@
 //! Example use of Dropshot.
 
 use dropshot::endpoint;
+use dropshot::tracing::Noop;
 use dropshot::ApiDescription;
 use dropshot::ConfigDropshot;
 use dropshot::ConfigLogging;
@@ -43,10 +44,15 @@ async fn main() -> Result<(), String> {
     let api_context = ExampleContext::new();
 
     // Set up the server.
-    let server =
-        HttpServerStarter::new(&config_dropshot, api, api_context, &log)
-            .map_err(|error| format!("failed to create server: {}", error))?
-            .start();
+    let server = HttpServerStarter::new(
+        &config_dropshot,
+        api,
+        api_context,
+        &log,
+        Noop::default(),
+    )
+    .map_err(|error| format!("failed to create server: {}", error))?
+    .start();
 
     // Wait for the server to stop.  Note that there's not any code to shut down
     // this server, so we should never get past this point.

diff --git a/dropshot/examples/file_server.rs b/dropshot/examples/file_server.rs
@@ -2,6 +2,7 @@
 
 //! Example using Dropshot to serve files
 
+use dropshot::tracing::Noop;
 use dropshot::ApiDescription;
 use dropshot::ConfigLogging;
 use dropshot::ConfigLoggingLevel;
@@ -44,9 +45,15 @@ async fn main() -> Result<(), String> {
     let context = FileServerContext { base: PathBuf::from(".") };
 
     // Set up the server.
-    let server = HttpServerStarter::new(&config_dropshot, api, context, &log)
-        .map_err(|error| format!("failed to create server: {}", error))?
-        .start();
+    let server = HttpServerStarter::new(
+        &config_dropshot,
+        api,
+        context,
+        &log,
+        Noop::default(),
+    )
+    .map_err(|error| format!("failed to create server: {}", error))?
+    .start();
 
     // Wait for the server to stop.  Note that there's not any code to shut down
     // this server, so we should never get past this point.

diff --git a/dropshot/examples/https.rs b/dropshot/examples/https.rs
@@ -3,6 +3,7 @@
 //! Example use of Dropshot with TLS enabled
 
 use dropshot::endpoint;
+use dropshot::tracing::Noop;
 use dropshot::ApiDescription;
 use dropshot::ConfigDropshot;
 use dropshot::ConfigLogging;
@@ -87,10 +88,15 @@ async fn main() -> Result<(), String> {
     let api_context = ExampleContext::new();
 
     // Set up the server.
-    let server =
-        HttpServerStarter::new(&config_dropshot, api, api_context, &log)
-            .map_err(|error| format!("failed to create server: {}", error))?
-            .start();
+    let server = HttpServerStarter::new(
+        &config_dropshot,
+        api,
+        api_context,
+        &log,
+        Noop::default(),
+    )
+    .map_err(|error| format!("failed to create server: {}", error))?
+    .start();
 
     // Wait for the server to stop.  Note that there's not any code to shut down
     // this server, so we should never get past this point.

diff --git a/dropshot/examples/index.rs b/dropshot/examples/index.rs
@@ -1,6 +1,7 @@
 // Copyright 2021 Oxide Computer Company
 //! Example use of Dropshot for matching wildcard paths to serve static content.
 
+use dropshot::tracing::Noop;
 use dropshot::ApiDescription;
 use dropshot::ConfigDropshot;
 use dropshot::ConfigLogging;
@@ -35,9 +36,15 @@ async fn main() -> Result<(), String> {
     api.register(index).unwrap();
 
     // Set up the server.
-    let server = HttpServerStarter::new(&config_dropshot, api, (), &log)
-        .map_err(|error| format!("failed to create server: {}", error))?
-        .start();
+    let server = HttpServerStarter::new(
+        &config_dropshot,
+        api,
+        (),
+        &log,
+        Noop::default(),
+    )
+    .map_err(|error| format!("failed to create server: {}", error))?
+    .start();
 
     // Wait for the server to stop.  Note that there's not any code to shut down
     // this server, so we should never get past this point.

diff --git a/dropshot/examples/module-basic.rs b/dropshot/examples/module-basic.rs
@@ -1,6 +1,7 @@
 // Copyright 2020 Oxide Computer Company
 //! Example use of Dropshot.
 
+use dropshot::tracing::Noop;
 use dropshot::ApiDescription;
 use dropshot::ConfigLogging;
 use dropshot::ConfigLoggingLevel;
@@ -35,10 +36,15 @@ async fn main() -> Result<(), String> {
     let api_context = ExampleContext::new();
 
     // Set up the server.
-    let server =
-        HttpServerStarter::new(&config_dropshot, api, api_context, &log)
-            .map_err(|error| format!("failed to create server: {}", error))?
-            .start();
+    let server = HttpServerStarter::new(
+        &config_dropshot,
+        api,
+        api_context,
+        &log,
+        Noop::default(),
+    )
+    .map_err(|error| format!("failed to create server: {}", error))?
+    .start();
 
     // Wait for the server to stop.  Note that there's not any code to shut down
     // this server, so we should never get past this point.

diff --git a/dropshot/examples/module-shared-context.rs b/dropshot/examples/module-shared-context.rs
@@ -3,6 +3,7 @@
 //! a custom context object that outlives endpoint functions.
 
 use dropshot::endpoint;
+use dropshot::tracing::Noop;
 use dropshot::ApiDescription;
 use dropshot::ConfigLogging;
 use dropshot::ConfigLoggingLevel;
@@ -47,6 +48,7 @@ async fn main() -> Result<(), String> {
         api,
         api_context.clone(),
         &log,
+        Noop::default(),
     )
     .map_err(|error| format!("failed to create server: {}", error))?
     .start();

diff --git a/dropshot/examples/multiple-servers.rs b/dropshot/examples/multiple-servers.rs
@@ -68,6 +68,7 @@
 //! process will also note the shutdown of server B.
 
 use dropshot::endpoint;
+use dropshot::tracing::Noop;
 use dropshot::ApiDescription;
 use dropshot::ConfigDropshot;
 use dropshot::ConfigLogging;
@@ -167,7 +168,7 @@ impl Drop for MultiServerContext {
 
 /// Context shared by all running servers.
 struct SharedMultiServerContext {
-    servers: Mutex<HashMap<String, HttpServer<MultiServerContext>>>,
+    servers: Mutex<HashMap<String, HttpServer<MultiServerContext, Noop>>>,
     started_server_shutdown_handles: mpsc::Sender<ServerShutdownFuture>,
 }
 
@@ -218,10 +219,15 @@ impl SharedMultiServerContext {
             name: name.to_string(),
             log: log.clone(),
         };
-        let server =
-            HttpServerStarter::new(&config_dropshot, api, context, &log)
-                .map_err(|error| format!("failed to create server: {}", error))?
-                .start();
+        let server = HttpServerStarter::new(
+            &config_dropshot,
+            api,
+            context,
+            &log,
+            Noop::default(),
+        )
+        .map_err(|error| format!("failed to create server: {}", error))?
+        .start();
         let shutdown_handle = server.wait_for_shutdown();
 
         slot.insert(server);

diff --git a/dropshot/examples/pagination-basic.rs b/dropshot/examples/pagination-basic.rs
@@ -15,6 +15,7 @@
 //! next page token from the response as a query parameter, too.
 
 use dropshot::endpoint;
+use dropshot::tracing::Noop;
 use dropshot::ApiDescription;
 use dropshot::ConfigDropshot;
 use dropshot::ConfigLogging;
@@ -128,8 +129,14 @@ async fn main() -> Result<(), String> {
         .map_err(|error| format!("failed to create logger: {}", error))?;
     let mut api = ApiDescription::new();
     api.register(example_list_projects).unwrap();
-    let server = HttpServerStarter::new(&config_dropshot, api, ctx, &log)
-        .map_err(|error| format!("failed to create server: {}", error))?
-        .start();
+    let server = HttpServerStarter::new(
+        &config_dropshot,
+        api,
+        ctx,
+        &log,
+        Noop::default(),
+    )
+    .map_err(|error| format!("failed to create server: {}", error))?
+    .start();
     server.await
 }
diff --git a/dropshot/examples/pagination-multiple-resources.rs b/dropshot/examples/pagination-multiple-resources.rs
@@ -4,6 +4,7 @@
 //! about how to run this.
 
 use dropshot::endpoint;
+use dropshot::tracing::Noop;
 use dropshot::ApiDescription;
 use dropshot::ConfigDropshot;
 use dropshot::ConfigLogging;
@@ -290,9 +291,15 @@ async fn main() -> Result<(), String> {
     api.register(example_list_projects).unwrap();
     api.register(example_list_disks).unwrap();
     api.register(example_list_instances).unwrap();
-    let server = HttpServerStarter::new(&config_dropshot, api, ctx, &log)
-        .map_err(|error| format!("failed to create server: {}", error))?
-        .start();
+    let server = HttpServerStarter::new(
+        &config_dropshot,
+        api,
+        ctx,
+        &log,
+        Noop::default(),
+    )
+    .map_err(|error| format!("failed to create server: {}", error))?
+    .start();
 
     server.await
 }

diff --git a/dropshot/examples/pagination-multiple-sorts.rs b/dropshot/examples/pagination-multiple-sorts.rs
@@ -92,6 +92,7 @@ use chrono::offset::TimeZone;
 use chrono::DateTime;
 use chrono::Utc;
 use dropshot::endpoint;
+use dropshot::tracing::Noop;
 use dropshot::ApiDescription;
 use dropshot::ConfigDropshot;
 use dropshot::ConfigLogging;
@@ -304,9 +305,15 @@ async fn main() -> Result<(), String> {
         .map_err(|error| format!("failed to create logger: {}", error))?;
     let mut api = ApiDescription::new();
     api.register(example_list_projects).unwrap();
-    let server = HttpServerStarter::new(&config_dropshot, api, ctx, &log)
-        .map_err(|error| format!("failed to create server: {}", error))?
-        .start();
+    let server = HttpServerStarter::new(
+        &config_dropshot,
+        api,
+        ctx,
+        &log,
+        Noop::default(),
+    )
+    .map_err(|error| format!("failed to create server: {}", error))?
+    .start();
 
     // Print out some example requests to start with.
     print_example_requests(log, &server.local_addr());

diff --git a/dropshot/examples/request-headers.rs b/dropshot/examples/request-headers.rs
@@ -11,6 +11,7 @@
 //! comments on the common code.
 
 use dropshot::endpoint;
+use dropshot::tracing::Noop;
 use dropshot::ApiDescription;
 use dropshot::ConfigDropshot;
 use dropshot::ConfigLogging;
@@ -32,10 +33,15 @@ async fn main() -> Result<(), String> {
     api.register(example_api_get_header_generic).unwrap();
 
     let api_context = ();
-    let server =
-        HttpServerStarter::new(&config_dropshot, api, api_context, &log)
-            .map_err(|error| format!("failed to create server: {}", error))?
-            .start();
+    let server = HttpServerStarter::new(
+        &config_dropshot,
+        api,
+        api_context,
+        &log,
+        Noop::default(),
+    )
+    .map_err(|error| format!("failed to create server: {}", error))?
+    .start();
     server.await
 }
 

diff --git a/dropshot/examples/self-referential.rs b/dropshot/examples/self-referential.rs
@@ -3,6 +3,7 @@
 //! An example that demonstrates server shutdown (and waiting for shutdown).
 
 use dropshot::endpoint;
+use dropshot::tracing::Noop;
 use dropshot::ApiDescription;
 use dropshot::ConfigDropshot;
 use dropshot::ConfigLogging;
@@ -33,10 +34,15 @@ async fn main() -> Result<(), String> {
     let api_context = Arc::new(ExampleContext::new());
 
     // Set up the server.
-    let server =
-        HttpServerStarter::new(&config_dropshot, api, api_context, &log)
-            .map_err(|error| format!("failed to create server: {}", error))?
-            .start();
+    let server = HttpServerStarter::new(
+        &config_dropshot,
+        api,
+        api_context,
+        &log,
+        Noop::default(),
+    )
+    .map_err(|error| format!("failed to create server: {}", error))?
+    .start();
     let shutdown = server.wait_for_shutdown();
 
     tokio::task::spawn(async move {

diff --git a/dropshot/examples/websocket.rs b/dropshot/examples/websocket.rs
@@ -2,6 +2,7 @@
 //! Example use of Dropshot with a websocket endpoint.
 
 use dropshot::channel;
+use dropshot::tracing::Noop;
 use dropshot::ApiDescription;
 use dropshot::ConfigDropshot;
 use dropshot::ConfigLogging;
@@ -37,9 +38,15 @@ async fn main() -> Result<(), String> {
     api.register(example_api_websocket_counter).unwrap();
 
     // Set up the server.
-    let server = HttpServerStarter::new(&config_dropshot, api, (), &log)
-        .map_err(|error| format!("failed to create server: {}", error))?
-        .start();
+    let server = HttpServerStarter::new(
+        &config_dropshot,
+        api,
+        (),
+        &log,
+        Noop::default(),
+    )
+    .map_err(|error| format!("failed to create server: {}", error))?
+    .start();
 
     // Wait for the server to stop.  Note that there's not any code to shut down
     // this server, so we should never get past this point.

diff --git a/dropshot/examples/well-tagged.rs b/dropshot/examples/well-tagged.rs
@@ -6,7 +6,7 @@
 //! proper tagging innate.
 
 use dropshot::{
-    endpoint, ApiDescription, ConfigLogging, ConfigLoggingLevel,
+    endpoint, tracing::Noop, ApiDescription, ConfigLogging, ConfigLoggingLevel,
     EndpointTagPolicy, HttpError, HttpResponseOk, HttpServerStarter,
     RequestContext, TagConfig, TagDetails, TagExternalDocs,
 };
@@ -99,9 +99,15 @@ async fn main() -> Result<(), String> {
     api.register(get_fryism).unwrap();
 
     // Set up the server.
-    let server = HttpServerStarter::new(&config_dropshot, api, (), &log)
-        .map_err(|error| format!("failed to create server: {}", error))?
-        .start();
+    let server = HttpServerStarter::new(
+        &config_dropshot,
+        api,
+        (),
+        &log,
+        Noop::default(),
+    )
+    .map_err(|error| format!("failed to create server: {}", error))?
+    .start();
 
     // Wait for the server to stop.  Note that there's not any code to shut down
     // this server, so we should never get past this point.

diff --git a/dropshot/src/dtrace.rs b/dropshot/src/dtrace.rs
@@ -2,7 +2,7 @@
 //! DTrace probes and support
 
 #[derive(Debug, Clone, serde::Serialize)]
-pub(crate) struct RequestInfo {
+pub struct RequestInfo {
     pub id: String,
     pub local_addr: std::net::SocketAddr,
     pub remote_addr: std::net::SocketAddr,
@@ -12,7 +12,7 @@ pub(crate) struct RequestInfo {
 }
 
 #[derive(Debug, Clone, serde::Serialize)]
-pub(crate) struct ResponseInfo {
+pub struct ResponseInfo {
     pub id: String,
     pub local_addr: std::net::SocketAddr,
     pub remote_addr: std::net::SocketAddr,