Add missing documentation

Author: sfauvel

internal/mithril-metric/Makefile

@@ -16,4 +16,4 @@ check:
 	${CARGO} fmt --check
 
 doc:
-	${CARGO} doc --no-deps --open --features full
+	${CARGO} doc --no-deps --open

internal/mithril-metric/src/helper.rs

@@ -1,3 +1,5 @@
+//! Helper to create a metric service.
+
 /// Create a MetricService.
 ///
 /// To build the service you need to provide the structure name and a list of metrics.
@@ -28,17 +30,17 @@ macro_rules! build_metrics_service {
         paste::item! {
             /// Metrics service which is responsible for recording and exposing metrics.
             pub struct $service {
-                registry: Registry,
+                registry: prometheus::Registry,
                 $(
                     $metric_attribute: $metric_type,
                 )*
             }
 
             impl $service {
                 /// Create a new MetricsService instance.
-                pub fn new(logger: Logger) -> StdResult<Self> {
+                pub fn new(logger: slog::Logger) -> mithril_common::StdResult<Self> {
 
-                    let registry = Registry::new();
+                    let registry = prometheus::Registry::new();
 
                     $(
                         let $metric_attribute = $metric_type::new(
@@ -65,7 +67,7 @@ macro_rules! build_metrics_service {
             }
 
             impl MetricsServiceExporter for $service {
-                fn export_metrics(&self) -> StdResult<String> {
+                fn export_metrics(&self) -> mithril_common::StdResult<String> {
                     Ok(prometheus::TextEncoder::new().encode_to_string(&self.registry.gather())?)
                 }
             }

internal/mithril-metric/src/lib.rs

@@ -1,3 +1,5 @@
+#![warn(missing_docs)]
+
 //! metrics module.
 //! This module contains the tools to create a metrics service and a metrics server.
 

internal/mithril-metric/src/metric.rs

@@ -1,3 +1,5 @@
+//! This module contains wrapper to prometheus metrics for use in a metrics service.
+
 use prometheus::{core::Collector, Counter, Gauge, Opts};
 use slog::{debug, Logger};
 
@@ -26,6 +28,7 @@ pub struct MetricCounter {
 }
 
 impl MetricCounter {
+    /// Create a new metric counter.
     pub fn new(logger: Logger, name: &str, help: &str) -> StdResult<Self> {
         let counter = MetricCounter::create_metric_counter(name, help)?;
         Ok(Self {
@@ -35,11 +38,13 @@ impl MetricCounter {
         })
     }
 
+    /// Increment the counter.
     pub fn increment(&self) {
         debug!(self.logger, "Incrementing '{}' counter", self.name);
         self.counter.inc();
     }
 
+    /// Get the counter value.
     pub fn get(&self) -> CounterValue {
         self.counter.get().round() as CounterValue
     }
@@ -70,6 +75,7 @@ pub struct MetricGauge {
 }
 
 impl MetricGauge {
+    /// Create a new metric gauge.
     pub fn new(logger: Logger, name: &str, help: &str) -> StdResult<Self> {
         let gauge = MetricGauge::create_metric_gauge(name, help)?;
         Ok(Self {
@@ -79,6 +85,7 @@ impl MetricGauge {
         })
     }
 
+    /// Record a value in the gauge.
     pub fn record<T: Into<f64> + Copy>(&self, value: T) {
         debug!(
             self.logger,
@@ -89,6 +96,7 @@ impl MetricGauge {
         self.gauge.set(value.into());
     }
 
+    /// Get the gauge value.
     pub fn get(&self) -> f64 {
         self.gauge.get().round()
     }

internal/mithril-metric/src/server.rs

@@ -13,7 +13,9 @@ use tokio::sync::oneshot::Receiver;
 use mithril_common::logging::LoggerExtensions;
 use mithril_common::StdResult;
 
+/// Metrics service exporter gives the possibility of exporting metrics.
 pub trait MetricsServiceExporter {
+    /// Export metrics.
     fn export_metrics(&self) -> StdResult<String>;
 }
 

mithril-signer/src/metrics/service.rs

@@ -1,8 +1,6 @@
 use mithril_metric::{build_metrics_service, MetricsServiceExporter};
-use prometheus::Registry;
-use slog::Logger;
 
-use mithril_common::{entities::Epoch, StdResult};
+use mithril_common::entities::Epoch;
 
 use mithril_metric::metric::{CounterValue, MetricCollector, MetricCounter, MetricGauge};
 
@@ -147,6 +145,7 @@ impl MetricsService {
 
 #[cfg(test)]
 mod tests {
+    use mithril_common::StdResult;
     use prometheus_parse::Value;
     use std::collections::BTreeMap;