feat: Instrumentation tooling

Adds a crate (`log-instrument`) with an instrumentation macro.
Adds a binary (`clippy-tracing`) to add, remove and check for
instrumentation.

Signed-off-by: Jonathan Woollett-Light <[email protected]>

Author: Jonathan Woollett-Light

Cargo.lock

@@ -1,5 +1,5 @@
 [workspace]
-members = ["src/cpu-template-helper", "src/firecracker", "src/jailer", "src/rebase-snap", "src/seccompiler", "src/snapshot-editor"]
+members = ["src/clippy-tracing", "src/cpu-template-helper", "src/firecracker", "src/jailer", "src/log-instrument", "src/log-instrument-macros", "src/rebase-snap", "src/seccompiler", "src/snapshot-editor"]
 default-members = ["src/firecracker"]
 resolver = "2"
 

Cargo.toml

@@ -15,6 +15,7 @@ serde_derive = "1.0.136"
 serde_json = "1.0.78"
 thiserror = "1.0.32"
 displaydoc = "0.2.4"
+log-instrument = { path = "../log-instrument", optional = true }
 
 micro_http = { git = "https://github.com/firecracker-microvm/micro-http" }
 seccompiler = { path = "../seccompiler" }
@@ -23,3 +24,6 @@ vmm = { path = "../vmm" }
 
 [dev-dependencies]
 libc = "0.2.117"
+
+[features]
+tracing = ["log-instrument"]

src/api_server/Cargo.toml

@@ -997,6 +997,7 @@ definitions:
       module:
         type: string
         description: The module path to filter log messages by.
+        example: api_server::request
 
   MachineConfiguration:
     type: object

src/api_server/swagger/firecracker.yaml

@@ -0,0 +1,21 @@
+[package]
+name = "clippy-tracing"
+version = "0.1.0"
+authors = ["Amazon Firecracker team <[email protected]>"]
+edition = "2021"
+license = "Apache-2.0"
+
+[[bin]]
+name = "clippy-tracing"
+bench = false
+
+[dependencies]
+clap = { version = "4.3.2", features = ["derive"] }
+itertools = "0.11.0"
+proc-macro2 = { version = "1.0.63", features = ["span-locations"] }
+quote = "1.0.28"
+syn = { version = "2.0.17", features = ["full", "extra-traits", "visit", "visit-mut", "printing"] } 
+walkdir = "2.3.3"
+
+[dev-dependencies]
+uuid = { version = "1.4.1", features = ["v4"] }