From 3ad73c721facf6804695a9b55574c66feea5147c Mon Sep 17 00:00:00 2001
From: Benjamin Naecker <ben@oxide.computer>
Date: Fri, 5 Jul 2024 22:26:51 +0000
Subject: [PATCH] Define virtual resource provisioning timeseries in TOML

---
 nexus/db-queries/src/provisioning.rs          | 41 ++++---------------
 .../oximeter/schema/collection-target.toml    | 40 ++++++++++++++++++
 2 files changed, 49 insertions(+), 32 deletions(-)
 create mode 100644 oximeter/oximeter/schema/collection-target.toml

diff --git a/nexus/db-queries/src/provisioning.rs b/nexus/db-queries/src/provisioning.rs
index 014b6bf473..d686eaa32b 100644
--- a/nexus/db-queries/src/provisioning.rs
+++ b/nexus/db-queries/src/provisioning.rs
@@ -5,35 +5,14 @@
 //! Types to export metrics about provisioning information.
 
 use crate::db::model::VirtualProvisioningCollection;
-use oximeter::{types::Sample, Metric, MetricsError, Target};
+use oximeter::{types::Sample, MetricsError};
 use std::sync::{Arc, Mutex};
-use uuid::Uuid;
 
-/// Describes a collection that holds other resources.
-///
-/// Example targets might include projects, silos or fleets.
-#[derive(Debug, Clone, Target)]
-struct CollectionTarget {
-    id: Uuid,
-}
-
-#[derive(Debug, Clone, Metric)]
-struct VirtualDiskSpaceProvisioned {
-    #[datum]
-    bytes_used: i64,
-}
-
-#[derive(Debug, Clone, Metric)]
-struct CpusProvisioned {
-    #[datum]
-    cpus: i64,
-}
-
-#[derive(Debug, Clone, Metric)]
-struct RamProvisioned {
-    #[datum]
-    bytes: i64,
-}
+oximeter::use_timeseries!("collection-target.toml");
+use collection_target::CollectionTarget;
+use collection_target::CpusProvisioned;
+use collection_target::RamProvisioned;
+use collection_target::VirtualDiskSpaceProvisioned;
 
 /// An oximeter producer for reporting [`VirtualProvisioningCollection`] information to Clickhouse.
 ///
@@ -72,9 +51,7 @@ impl Producer {
                         .expect("Should always have default value"),
                     &CollectionTarget { id: provision.id },
                     &VirtualDiskSpaceProvisioned {
-                        bytes_used: provision
-                            .virtual_disk_bytes_provisioned
-                            .into(),
+                        datum: provision.virtual_disk_bytes_provisioned.into(),
                     },
                 )
             })
@@ -96,7 +73,7 @@ impl Producer {
                         .time_modified
                         .expect("Should always have default value"),
                     &CollectionTarget { id: provision.id },
-                    &CpusProvisioned { cpus: provision.cpus_provisioned },
+                    &CpusProvisioned { datum: provision.cpus_provisioned },
                 )
             })
             .chain(provisions.iter().map(|provision| {
@@ -105,7 +82,7 @@ impl Producer {
                         .time_modified
                         .expect("Should always have default value"),
                     &CollectionTarget { id: provision.id },
-                    &RamProvisioned { bytes: provision.ram_provisioned.into() },
+                    &RamProvisioned { datum: provision.ram_provisioned.into() },
                 )
             }))
             .collect::<Result<Vec<_>, _>>()?;
diff --git a/oximeter/oximeter/schema/collection-target.toml b/oximeter/oximeter/schema/collection-target.toml
new file mode 100644
index 0000000000..c63f05abbc
--- /dev/null
+++ b/oximeter/oximeter/schema/collection-target.toml
@@ -0,0 +1,40 @@
+format_version = 1
+
+[target]
+name = "collection_target"
+description = "A collection such as project or silo, whose provisioned virtual resources are tracked"
+authz_scope = "fleet"
+versions = [
+    { version = 1, fields = [ "id" ] },
+]
+
+[fields.id]
+type = "uuid"
+description = "UUID of the tracked collection"
+
+[[metrics]]
+name = "virtual_disk_space_provisioned"
+description = "Total virtual disk space provisioned in the collection"
+units = "bytes"
+datum_type = "i64"
+versions = [
+    { added_in = 1, fields = [] }
+]
+
+[[metrics]]
+name = "ram_provisioned"
+description = "Total memory provisioned in the collection"
+units = "bytes"
+datum_type = "i64"
+versions = [
+    { added_in = 1, fields = [] }
+]
+
+[[metrics]]
+name = "cpus_provisioned"
+description = "Total number of vCPUs provisioned in the collection"
+units = "count"
+datum_type = "i64"
+versions = [
+    { added_in = 1, fields = [] }
+]