Prometheus Metrics

oxanus/Cargo.toml

@@ -19,6 +19,7 @@ sentry = ["sentry-core"]
 tracing-instrument = []
 macros = ["oxanus-macros"]
 registry = ["inventory", "oxanus-macros?/registry"]
+prometheus = ["prometheus-client"]
 
 [dependencies]
 async-trait = "0.1"
@@ -29,6 +30,7 @@ redis = { version = "^1.0", features = ["aio", "tokio-comp"] }
 futures = { version = "^0.3" }
 gethostname = "^1.0"
 inventory = { version = "0.3", optional = true }
+prometheus-client = { version = "0.24", optional = true }
 sentry-core = { version = "^0.46", optional = true }
 serde = { version = "^1.0.218", features = ["derive"] }
 serde_json = { version = "^1.0", features = ["preserve_order"] }

oxanus/README.md

@@ -149,3 +149,13 @@ Configuration is done through the [`Config`] builder, which allows you to:
 Oxanus uses a custom error type [`OxanusError`] that covers all possible error cases in the library.
 Workers can define their own error type that implements `std::error::Error`.
 
+### Prometheus Metrics
+
+Enable the `prometheus` feature to expose metrics:
+
+```rust
+let metrics = storage.metrics().await?;
+let output = metrics.encode_to_string()?;
+// Serve `output` on your metrics endpoint
+```
+

oxanus/src/lib.rs

@@ -87,6 +87,7 @@ mod launcher;
 mod queue;
 mod result_collector;
 mod semaphores_map;
+mod stats;
 mod storage;
 mod storage_builder;
 mod storage_internal;
@@ -99,6 +100,9 @@ mod worker_registry;
 #[cfg(feature = "registry")]
 mod registry;
 
+#[cfg(feature = "prometheus")]
+pub mod prometheus;
+
 #[cfg(test)]
 mod test_helper;