add compulsory description for metrics

7 files changed, 21 insertions, 15 deletions

diff --git a/configd/src/apps/sentinel/metrics.cpp b/configd/src/apps/sentinel/metrics.cpp
index bc9d87d0e73..df1b0076001 100644
--- a/configd/src/apps/sentinel/metrics.cpp
+++ b/configd/src/apps/sentinel/metrics.cpp
@@ -20,11 +20,16 @@ StartMetrics::StartMetrics()
       totalRestartsLastPeriod(1),
       startedTime(time(nullptr)),
       lastLoggedTime(startedTime - 55),
-      sentinel_restarts(metrics->counter("sentinel.restarts")),
-      sentinel_totalRestarts(metrics->gauge("sentinel.totalRestarts")),
-      sentinel_running(metrics->gauge("sentinel.running")),
-      sentinel_uptime(metrics->gauge("sentinel.uptime"))
+      sentinel_restarts(metrics->counter("sentinel.restarts",
+              "how many times sentinel restarted a service")),
+      sentinel_totalRestarts(metrics->gauge("sentinel.totalRestarts",
+              "how many times sentinel restarted a service since sentinel start")),
+      sentinel_running(metrics->gauge("sentinel.running",
+              "how many services the sentinel has running currently")),
+      sentinel_uptime(metrics->gauge("sentinel.uptime",
+              "how many seconds has the sentinel been running"))
 {
+    // account for the sentinel itself restarting
     sentinel_restarts.add();
 }
 
diff --git a/logd/src/logd/metrics.h b/logd/src/logd/metrics.h
index d0c34e0534f..b5bc5a7dcd7 100644
--- a/logd/src/logd/metrics.h
+++ b/logd/src/logd/metrics.h
@@ -20,7 +20,8 @@ struct Metrics {
         : metrics(m),
           loglevel(metrics->dimension("loglevel")),
           servicename(metrics->dimension("service")),
-          loglines(metrics->counter("logd.processed.lines"))
+          loglines(metrics->counter("logd.processed.lines",
+                  "how many log lines have been processed"))
     {}
 
     ~Metrics() {}
diff --git a/staging_vespalib/src/tests/metrics/simple_metrics_test.cpp b/staging_vespalib/src/tests/metrics/simple_metrics_test.cpp
index ce518474a7f..da2502f7ed7 100644
--- a/staging_vespalib/src/tests/metrics/simple_metrics_test.cpp
+++ b/staging_vespalib/src/tests/metrics/simple_metrics_test.cpp
@@ -122,11 +122,11 @@ TEST("use simple_metrics_collector")
     std::shared_ptr<MockTick> ticker = std::make_shared<MockTick>(TimeStamp(1.0));
     auto manager = SimpleMetricsManager::createForTest(cf, std::make_unique<TickProxy>(ticker));
 
-    Counter myCounter = manager->counter("foo");
+    Counter myCounter = manager->counter("foo", "no description");
     myCounter.add();
     myCounter.add(16);
 
-    Gauge myGauge = manager->gauge("bar");
+    Gauge myGauge = manager->gauge("bar", "dummy description");
     myGauge.sample(42.0);
     myGauge.sample(41.0);
     myGauge.sample(43.0);
diff --git a/staging_vespalib/src/vespa/vespalib/metrics/dummy_metrics_manager.h b/staging_vespalib/src/vespa/vespalib/metrics/dummy_metrics_manager.h
index 59e23e6ea84..52e9c6a608c 100644
--- a/staging_vespalib/src/vespa/vespalib/metrics/dummy_metrics_manager.h
+++ b/staging_vespalib/src/vespa/vespalib/metrics/dummy_metrics_manager.h
@@ -29,10 +29,10 @@ public:
         return std::shared_ptr<MetricsManager>(new DummyMetricsManager());
     }
 
-    Counter counter(const vespalib::string &) override {
+    Counter counter(const vespalib::string &, const vespalib::string &) override {
         return Counter(shared_from_this(), MetricName(0));
     }
-    Gauge gauge(const vespalib::string &) override {
+    Gauge gauge(const vespalib::string &, const vespalib::string &) override {
         return Gauge(shared_from_this(), MetricName(0));
     }
 
diff --git a/staging_vespalib/src/vespa/vespalib/metrics/metrics_manager.h b/staging_vespalib/src/vespa/vespalib/metrics/metrics_manager.h
index c86e5a315dc..14f11fa4ab2 100644
--- a/staging_vespalib/src/vespa/vespalib/metrics/metrics_manager.h
+++ b/staging_vespalib/src/vespa/vespalib/metrics/metrics_manager.h
@@ -31,13 +31,13 @@ public:
      * Get or create a counter metric.
      * @param name the name of the metric.
      **/
-    virtual Counter counter(const vespalib::string &name) = 0;
+    virtual Counter counter(const vespalib::string &name, const vespalib::string &description) = 0;
 
     /**
      * Get or create a gauge metric.
      * @param name the name of the metric.
      **/
-    virtual Gauge gauge(const vespalib::string &name) = 0;
+    virtual Gauge gauge(const vespalib::string &name, const vespalib::string &description) = 0;
 
     /**
      * Get or create a dimension for labeling metrics.
diff --git a/staging_vespalib/src/vespa/vespalib/metrics/simple_metrics_manager.cpp b/staging_vespalib/src/vespa/vespalib/metrics/simple_metrics_manager.cpp
index b9b3415a0e3..049be4fd328 100644
--- a/staging_vespalib/src/vespa/vespalib/metrics/simple_metrics_manager.cpp
+++ b/staging_vespalib/src/vespa/vespalib/metrics/simple_metrics_manager.cpp
@@ -53,7 +53,7 @@ SimpleMetricsManager::createForTest(const SimpleManagerConfig &config,
 }
 
 Counter
-SimpleMetricsManager::counter(const vespalib::string &name)
+SimpleMetricsManager::counter(const vespalib::string &name, const vespalib::string &)
 {
     size_t id = _metricNames.resolve(name);
     _metricTypes.check(id, name, MetricTypes::MetricType::COUNTER);
@@ -62,7 +62,7 @@ SimpleMetricsManager::counter(const vespalib::string &name)
 }
 
 Gauge
-SimpleMetricsManager::gauge(const vespalib::string &name)
+SimpleMetricsManager::gauge(const vespalib::string &name, const vespalib::string &)
 {
     size_t id = _metricNames.resolve(name);
     _metricTypes.check(id, name, MetricTypes::MetricType::GAUGE);
diff --git a/staging_vespalib/src/vespa/vespalib/metrics/simple_metrics_manager.h b/staging_vespalib/src/vespa/vespalib/metrics/simple_metrics_manager.h
index 693b3f65ec6..01725bb1739 100644
--- a/staging_vespalib/src/vespa/vespalib/metrics/simple_metrics_manager.h
+++ b/staging_vespalib/src/vespa/vespalib/metrics/simple_metrics_manager.h
@@ -74,8 +74,8 @@ public:
     static std::shared_ptr<MetricsManager> create(const SimpleManagerConfig &config);
     static std::shared_ptr<MetricsManager> createForTest(const SimpleManagerConfig &config,
                                                          Tick::UP tick_supplier);
-    Counter counter(const vespalib::string &name) override;
-    Gauge gauge(const vespalib::string &name) override;
+    Counter counter(const vespalib::string &name, const vespalib::string &description) override;
+    Gauge gauge(const vespalib::string &name, const vespalib::string &description) override;
     Dimension dimension(const vespalib::string &name) override;
     Label label(const vespalib::string &value) override;
     PointBuilder pointBuilder(Point from) override;