Report version from git describe in metrics & CLI

Author: sandhose

Cargo.lock

@@ -8,6 +8,8 @@ homepage.workspace = true
 repository.workspace = true
 publish = false
 
+build = "build.rs"
+
 [lints]
 workspace = true
 
@@ -82,6 +84,10 @@ mas-templates.workspace = true
 mas-tower.workspace = true
 oauth2-types.workspace = true
 
+[build-dependencies]
+anyhow.workspace = true
+vergen-gitcl = { version = "1.0.2", features = ["rustc"] }
+
 [features]
 # Features used for the prebuilt binaries
 dist = ["mas-config/dist"]

crates/cli/Cargo.toml

@@ -0,0 +1,18 @@
+// Copyright 2024 New Vector Ltd.
+//
+// SPDX-License-Identifier: AGPL-3.0-only
+// Please see LICENSE in the repository root for full details.
+
+use vergen_gitcl::{Emitter, GitclBuilder, RustcBuilder};
+
+fn main() -> anyhow::Result<()> {
+    let gitcl = GitclBuilder::default().describe(true, true, None).build()?;
+    let rustc = RustcBuilder::default().semver(true).build()?;
+
+    Emitter::default()
+        .add_instructions(&gitcl)?
+        .add_instructions(&rustc)?
+        .emit()?;
+
+    Ok(())
+}

crates/cli/build.rs

@@ -51,6 +51,7 @@ enum Subcommand {
 }
 
 #[derive(Parser, Debug)]
+#[command(version = crate::VERSION)]
 pub struct Options {
     /// Path to the configuration file
     #[arg(short, long, global = true, action = clap::ArgAction::Append)]

crates/cli/src/commands/mod.rs

@@ -60,6 +60,8 @@ impl Options {
         let shutdown = ShutdownManager::new()?;
         let config = AppConfig::extract(figment)?;
 
+        info!(version = crate::VERSION, "Starting up");
+
         if self.migrate {
             warn!("The `--migrate` flag is deprecated and will be removed in a future release. Please use `--no-migrate` to disable automatic migrations on startup.");
         }

crates/cli/src/commands/server.rs

@@ -24,6 +24,9 @@ mod sync;
 mod telemetry;
 mod util;
 
+/// The application version, as reported by `git describe` at build time
+static VERSION: &str = env!("VERGEN_GIT_DESCRIBE");
+
 #[derive(Debug)]
 struct SentryTransportFactory {
     client: reqwest::Client,

crates/cli/src/main.rs

@@ -232,7 +232,12 @@ fn init_meter(config: &MetricsConfig) -> anyhow::Result<()> {
 fn resource() -> Resource {
     let resource = Resource::new([
         KeyValue::new(semcov::resource::SERVICE_NAME, env!("CARGO_PKG_NAME")),
-        KeyValue::new(semcov::resource::SERVICE_VERSION, env!("CARGO_PKG_VERSION")),
+        KeyValue::new(semcov::resource::SERVICE_VERSION, crate::VERSION),
+        KeyValue::new(semcov::resource::PROCESS_RUNTIME_NAME, "rust"),
+        KeyValue::new(
+            semcov::resource::PROCESS_RUNTIME_VERSION,
+            env!("VERGEN_RUSTC_SEMVER"),
+        ),
     ]);
 
     let detected = Resource::from_detectors(