Add MetricsBackend with prometheus counter support

src/util/CMakeLists.txt

@@ -5,6 +5,7 @@ set(UTIL_SRCS
 	${CMAKE_CURRENT_SOURCE_DIR}/directiontables.cpp
 	${CMAKE_CURRENT_SOURCE_DIR}/enriched_string.cpp
 	${CMAKE_CURRENT_SOURCE_DIR}/ieee_float.cpp
+	${CMAKE_CURRENT_SOURCE_DIR}/metricsbackend.cpp
 	${CMAKE_CURRENT_SOURCE_DIR}/numeric.cpp
 	${CMAKE_CURRENT_SOURCE_DIR}/pointedthing.cpp
 	${CMAKE_CURRENT_SOURCE_DIR}/quicktune.cpp

src/util/metricsbackend.cpp

@@ -0,0 +1,140 @@
+/*
+Minetest
+Copyright (C) 2013-2020 Minetest core developers team
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation; either version 2.1 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License along
+with this program; if not, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+*/
+
+#include "metricsbackend.h"
+#if USE_PROMETHEUS
+#include <prometheus/exposer.h>
+#include <prometheus/registry.h>
+#include <prometheus/counter.h>
+#include <prometheus/gauge.h>
+#include "log.h"
+#include "settings.h"
+#endif
+
+MetricCounterPtr MetricsBackend::addCounter(
+		const std::string &name, const std::string &help_str)
+{
+	return std::make_shared<SimpleMetricCounter>(name, help_str);
+}
+
+MetricGaugePtr MetricsBackend::addGauge(
+		const std::string &name, const std::string &help_str)
+{
+	return std::make_shared<SimpleMetricGauge>(name, help_str);
+}
+
+#if USE_PROMETHEUS
+
+class PrometheusMetricCounter : public MetricCounter
+{
+public:
+	PrometheusMetricCounter() = delete;
+
+	PrometheusMetricCounter(const std::string &name, const std::string &help_str,
+			std::shared_ptr<prometheus::Registry> registry) :
+			MetricCounter(),
+			m_family(prometheus::BuildCounter()
+							.Name(name)
+							.Help(help_str)
+							.Register(*registry)),
+			m_counter(m_family.Add({}))
+	{
+	}
+
+	virtual ~PrometheusMetricCounter() {}
+
+	virtual void increment(double number) { m_counter.Increment(number); }
+	virtual double get() const { return m_counter.Value(); }
+
+private:
+	prometheus::Family<prometheus::Counter> &m_family;
+	prometheus::Counter &m_counter;
+};
+
+class PrometheusMetricGauge : public MetricGauge
+{
+public:
+	PrometheusMetricGauge() = delete;
+
+	PrometheusMetricGauge(const std::string &name, const std::string &help_str,
+			std::shared_ptr<prometheus::Registry> registry) :
+			MetricGauge(),
+			m_family(prometheus::BuildGauge()
+							.Name(name)
+							.Help(help_str)
+							.Register(*registry)),
+			m_gauge(m_family.Add({}))
+	{
+	}
+
+	virtual ~PrometheusMetricGauge() {}
+
+	virtual void increment(double number) { m_gauge.Increment(number); }
+	virtual void decrement(double number) { m_gauge.Decrement(number); }
+	virtual void set(double number) { m_gauge.Set(number); }
+	virtual double get() const { return m_gauge.Value(); }
+
+private:
+	prometheus::Family<prometheus::Gauge> &m_family;
+	prometheus::Gauge &m_gauge;
+};
+
+class PrometheusMetricsBackend : public MetricsBackend
+{
+public:
+	PrometheusMetricsBackend(const std::string &addr) :
+			MetricsBackend(), m_exposer(std::unique_ptr<prometheus::Exposer>(
+							  new prometheus::Exposer(addr))),
+			m_registry(std::make_shared<prometheus::Registry>())
+	{
+		m_exposer->RegisterCollectable(m_registry);
+	}
+
+	virtual ~PrometheusMetricsBackend() {}
+
+	virtual MetricCounterPtr addCounter(
+			const std::string &name, const std::string &help_str);
+	virtual MetricGaugePtr addGauge(
+			const std::string &name, const std::string &help_str);
+
+private:
+	std::unique_ptr<prometheus::Exposer> m_exposer;
+	std::shared_ptr<prometheus::Registry> m_registry;
+};
+
+MetricCounterPtr PrometheusMetricsBackend::addCounter(
+		const std::string &name, const std::string &help_str)
+{
+	return std::make_shared<PrometheusMetricCounter>(name, help_str, m_registry);
+}
+
+MetricGaugePtr PrometheusMetricsBackend::addGauge(
+		const std::string &name, const std::string &help_str)
+{
+	return std::make_shared<PrometheusMetricGauge>(name, help_str, m_registry);
+}
+
+MetricsBackend *createPrometheusMetricsBackend()
+{
+	std::string addr;
+	g_settings->getNoEx("prometheus_listener_address", addr);
+	return new PrometheusMetricsBackend(addr);
+}
+
+#endif

src/util/metricsbackend.h

@@ -0,0 +1,140 @@
+/*
+Minetest
+Copyright (C) 2013-2020 Minetest core developers team
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation; either version 2.1 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License along
+with this program; if not, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+*/
+
+#pragma once
+#include <memory>
+#include "config.h"
+#include "util/thread.h"
+
+class MetricCounter
+{
+public:
+	MetricCounter() = default;
+
+	virtual ~MetricCounter() {}
+
+	virtual void increment(double number = 1.0) = 0;
+	virtual double get() const = 0;
+};
+
+typedef std::shared_ptr<MetricCounter> MetricCounterPtr;
+
+class SimpleMetricCounter : public MetricCounter
+{
+public:
+	SimpleMetricCounter() = delete;
+
+	virtual ~SimpleMetricCounter() {}
+
+	SimpleMetricCounter(const std::string &name, const std::string &help_str) :
+			MetricCounter(), m_name(name), m_help_str(help_str),
+			m_counter(0.0)
+	{
+	}
+
+	virtual void increment(double number)
+	{
+		MutexAutoLock lock(m_mutex);
+		m_counter += number;
+	}
+	virtual double get() const
+	{
+		MutexAutoLock lock(m_mutex);
+		return m_counter;
+	}
+
+private:
+	std::string m_name;
+	std::string m_help_str;
+
+	mutable std::mutex m_mutex;
+	double m_counter;
+};
+
+class MetricGauge
+{
+public:
+	MetricGauge() = default;
+	virtual ~MetricGauge() {}
+
+	virtual void increment(double number = 1.0) = 0;
+	virtual void decrement(double number = 1.0) = 0;
+	virtual void set(double number) = 0;
+	virtual double get() const = 0;
+};
+
+typedef std::shared_ptr<MetricGauge> MetricGaugePtr;
+
+class SimpleMetricGauge : public MetricGauge
+{
+public:
+	SimpleMetricGauge() = delete;
+
+	SimpleMetricGauge(const std::string &name, const std::string &help_str) :
+			MetricGauge(), m_name(name), m_help_str(help_str), m_gauge(0.0)
+	{
+	}
+
+	virtual ~SimpleMetricGauge() {}
+
+	virtual void increment(double number)
+	{
+		MutexAutoLock lock(m_mutex);
+		m_gauge += number;
+	}
+	virtual void decrement(double number)
+	{
+		MutexAutoLock lock(m_mutex);
+		m_gauge -= number;
+	}
+	virtual void set(double number)
+	{
+		MutexAutoLock lock(m_mutex);
+		m_gauge = number;
+	}
+	virtual double get() const
+	{
+		MutexAutoLock lock(m_mutex);
+		return m_gauge;
+	}
+
+private:
+	std::string m_name;
+	std::string m_help_str;
+
+	mutable std::mutex m_mutex;
+	double m_gauge;
+};
+
+class MetricsBackend
+{
+public:
+	MetricsBackend() = default;
+
+	virtual ~MetricsBackend() {}
+
+	virtual MetricCounterPtr addCounter(
+			const std::string &name, const std::string &help_str);
+	virtual MetricGaugePtr addGauge(
+			const std::string &name, const std::string &help_str);
+};
+
+#if USE_PROMETHEUS
+MetricsBackend *createPrometheusMetricsBackend();
+#endif