feat: /ping API contains versioning headers (#26433)

* feat: `/ping` API contains versioning headers

Further, the product version can be modified by updating the metadata in
the `influxdb3_process` `Cargo.toml`.

* chore: PR feedback

* chore: placate linter

Author: stuartcarnie

Cargo.lock

@@ -68,6 +68,7 @@ bimap = "0.6.3"
 bitcode = { version = "0.6.3", features = ["serde"] }
 byteorder = "1.3.4"
 bytes = "1.9"
+cargo_metadata = "0.19.2"
 chrono = "0.4"
 cron = "0.15"
 clap = { version = "4", features = ["derive", "env", "string"] }

Cargo.toml

@@ -1,4 +1,5 @@
 use hyper::Method;
+use influxdb3_process::{INFLUXDB3_BUILD, INFLUXDB3_VERSION};
 use serde_json::Value;
 
 use crate::server::TestServer;
@@ -32,6 +33,27 @@ async fn test_ping() {
             .send()
             .await
             .unwrap();
+        // Verify we have a request id
+        assert!(resp.headers().contains_key("Request-Id"));
+        assert!(resp.headers().contains_key("X-Request-Id"));
+
+        assert_eq!(
+            resp.headers()
+                .get("X-Influxdb-Version")
+                .unwrap()
+                .to_str()
+                .unwrap(),
+            &INFLUXDB3_VERSION[..]
+        );
+        assert_eq!(
+            resp.headers()
+                .get("X-Influxdb-Build")
+                .unwrap()
+                .to_str()
+                .unwrap(),
+            &INFLUXDB3_BUILD[..]
+        );
+
         let json = resp.json::<Value>().await.unwrap();
         println!("Method: {}, URL: {}", t.method, t.url);
         println!("{json:#}");

influxdb3/tests/server/ping.rs

@@ -5,6 +5,9 @@ authors.workspace = true
 edition.workspace = true
 license.workspace = true
 
+[package.metadata.influxdb3]
+build = "Core"
+
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
@@ -17,6 +20,9 @@ tokio_metrics_bridge.workspace = true
 tokio.workspace = true
 uuid.workspace = true
 
+[build-dependencies]
+cargo_metadata.workspace = true
+
 # Optional Dependencies
 [target.'cfg(not(target_env = "msvc"))'.dependencies]
 tikv-jemalloc-ctl = { version = "0.5.4", optional = true }

influxdb3_process/Cargo.toml

@@ -2,6 +2,7 @@
 // time, panic'ing if it can not be found
 //
 // https://stackoverflow.com/questions/43753491/include-git-commit-hash-as-string-into-rust-program
+use cargo_metadata::MetadataCommand;
 use std::process::Command;
 
 fn main() -> Result<(), Box<dyn std::error::Error>> {
@@ -11,6 +12,20 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
     // Populate env!(GIT_HASH_SHORT) with the current git commit
     println!("cargo:rustc-env=GIT_HASH_SHORT={}", get_git_hash_short());
 
+    let path = std::env::var("CARGO_MANIFEST_DIR").unwrap();
+    let meta = MetadataCommand::new()
+        .manifest_path("./Cargo.toml")
+        .current_dir(&path)
+        .exec()
+        .unwrap();
+
+    let root = meta.root_package().unwrap();
+    let build = root.metadata["influxdb3"]["build"]
+        .as_str()
+        .unwrap_or("Core");
+    println!("cargo:rerun-if-env-changed=INFLUXDB3_BUILD_VERSION");
+    println!("cargo:rustc-env=INFLUXDB3_BUILD_VERSION={}", build);
+
     Ok(())
 }
 

influxdb3_process/build.rs

@@ -34,6 +34,10 @@ pub fn build_malloc_conf() -> String {
 pub static INFLUXDB3_VERSION: LazyLock<&'static str> =
     LazyLock::new(|| option_env!("CARGO_PKG_VERSION").unwrap_or("UNKNOWN"));
 
+/// Build information.
+pub static INFLUXDB3_BUILD: LazyLock<&'static str> =
+    LazyLock::new(|| env!("INFLUXDB3_BUILD_VERSION"));
+
 /// Build-time GIT revision hash.
 pub static INFLUXDB3_GIT_HASH: &str = env!(
     "GIT_HASH",

influxdb3_process/src/lib.rs

@@ -93,6 +93,7 @@ tonic.workspace = true
 tower.workspace = true
 unicode-segmentation.workspace = true
 url.workspace = true
+uuid.workspace = true
 
 [dev-dependencies]
 # Core Crates

influxdb3_server/Cargo.toml

@@ -29,7 +29,9 @@ use influxdb3_cache::last_cache;
 use influxdb3_catalog::CatalogError;
 use influxdb3_catalog::log::FieldDataType;
 use influxdb3_internal_api::query_executor::{QueryExecutor, QueryExecutorError};
-use influxdb3_process::{INFLUXDB3_GIT_HASH_SHORT, INFLUXDB3_VERSION, PROCESS_UUID};
+use influxdb3_process::{
+    INFLUXDB3_BUILD, INFLUXDB3_GIT_HASH_SHORT, INFLUXDB3_VERSION, PROCESS_UUID,
+};
 use influxdb3_processing_engine::ProcessingEngineManagerImpl;
 use influxdb3_processing_engine::manager::ProcessingEngineError;
 use influxdb3_types::http::*;
@@ -59,6 +61,7 @@ use std::task::Poll;
 use thiserror::Error;
 use trace::ctx::SpanContext;
 use unicode_segmentation::UnicodeSegmentation;
+use uuid::Uuid;
 
 mod v1;
 
@@ -690,7 +693,18 @@ impl HttpApi {
             process_id: *PROCESS_UUID,
         })?;
 
-        Ok(Response::new(Body::from(body)))
+        // InfluxDB 1.x used time-based UUIDs.
+        let request_id = Uuid::now_v7().as_hyphenated().to_string();
+
+        Response::builder()
+            .status(StatusCode::OK)
+            .header(CONTENT_TYPE, "application/json")
+            .header("Request-Id", request_id.clone())
+            .header("X-Influxdb-Build", INFLUXDB3_BUILD.to_string())
+            .header("X-Influxdb-Version", INFLUXDB3_VERSION.to_string())
+            .header("X-Request-Id", request_id)
+            .body(Body::from(body))
+            .map_err(Into::into)
     }
 
     fn handle_metrics(&self) -> Result<Response<Body>> {