export prom metrics from the printer (#121)

add in prom metrics to export machine information where available

Author: paultag

Cargo.lock

@@ -41,6 +41,7 @@ multer = { version = "3.1.0", features = ["json"] }
 opentelemetry = "0.25.0"
 opentelemetry-otlp = "0.25.0"
 opentelemetry_sdk = { version = "0.25.0", features = ["rt-tokio"] }
+prometheus-client = "0.22.3"
 reqwest = { version = "0.12", default-features = false, features = ["json", "rustls-tls"] }
 schemars = { version = "0.8", features = ["chrono", "uuid1", "bigdecimal"] }
 serde = { version = "1.0", features = ["derive"] }

Cargo.toml

@@ -21,6 +21,7 @@ pub use print::InfoResponse;
 pub use upload::{DeleteResponse, DeleteResponseItem, UploadResponse, UploadResponseItem};
 
 /// Client is a moonraker instance which can accept gcode for printing.
+#[derive(Clone, Debug, PartialEq)]
 pub struct Client {
     pub(crate) url_base: String,
 }

moonraker/src/lib.rs

@@ -1,3 +1,7 @@
+API operations found with tag "hidden"
+OPERATION ID                             URL PATH
+get_metrics                              /metrics
+
 API operations found with tag "machines"
 OPERATION ID                             URL PATH
 get_machine                              /machines/{id}

openapi/api-tags.txt

@@ -425,6 +425,34 @@
         ]
       }
     },
+    "/metrics": {
+      "get": {
+        "operationId": "get_metrics",
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "title": "String",
+                  "type": "string"
+                }
+              }
+            },
+            "description": "successful operation"
+          },
+          "4XX": {
+            "$ref": "#/components/responses/Error"
+          },
+          "5XX": {
+            "$ref": "#/components/responses/Error"
+          }
+        },
+        "summary": "List available machines and their statuses",
+        "tags": [
+          "hidden"
+        ]
+      }
+    },
     "/ping": {
       "get": {
         "operationId": "ping",
@@ -492,6 +520,13 @@
     }
   },
   "tags": [
+    {
+      "description": "Hidden API endpoints that should not show up in the docs.",
+      "externalDocs": {
+        "url": "https://docs.zoo.dev/api/machines"
+      },
+      "name": "hidden"
+    },
     {
       "description": "Utilities for making parts and discovering machines.",
       "externalDocs": {

openapi/api.json

@@ -13,6 +13,12 @@
       "external_docs": {
         "url": "https://docs.zoo.dev/api/machines"
       }
+    },
+    "hidden": {
+      "description": "Hidden API endpoints that should not show up in the docs.",
+      "external_docs": {
+        "url": "https://docs.zoo.dev/api/machines"
+      }
     }
   }
 }