summaryrefslogtreecommitdiffstats
path: root/dnsdist-prometheus.hh
blob: 011053d32e29958d10a047f74f7e882c21141af6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
/*
 * This file is part of PowerDNS or dnsdist.
 * Copyright -- PowerDNS.COM B.V. and its contributors
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of version 2 of the GNU General Public License as
 * published by the Free Software Foundation.
 *
 * In addition, for the avoidance of any doubt, permission is granted to
 * link this program with OpenSSL and to (re)distribute the binaries
 * produced as the result of such linking.
 *
 * 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 General Public License for more details.
 *
 * You should have received a copy of the GNU 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

namespace dnsdist::prometheus
{
struct PrometheusMetricDefinition
{
  const std::string& name;
  const std::string& type;
  const std::string& description;
  const std::string& customName;
};
}

#ifndef DISABLE_PROMETHEUS
// Metric types for Prometheus
enum class PrometheusMetricType: uint8_t {
    counter = 1,
    gauge = 2
};

// Keeps additional information about metrics
struct MetricDefinition {
  MetricDefinition(PrometheusMetricType _prometheusType, const std::string& _description, const std::string& customName_ = ""): description(_description), customName(customName_), prometheusType(_prometheusType) {
  }

  MetricDefinition() = default;

  // Metric description
  std::string description;
  // Custom name, if any
  std::string customName;
  // Metric type for Prometheus
  PrometheusMetricType prometheusType{PrometheusMetricType::counter};
};

struct MetricDefinitionStorage {
  // Return metric definition by name
  bool getMetricDetails(const std::string& metricName, MetricDefinition& metric) const {
    const auto& metricDetailsIter = metrics.find(metricName);

    if (metricDetailsIter == metrics.end()) {
      return false;
    }

    metric = metricDetailsIter->second;
    return true;
  };

  static bool addMetricDefinition(const dnsdist::prometheus::PrometheusMetricDefinition& def) {
    static const std::map<std::string, PrometheusMetricType> namesToTypes = {
      {"counter", PrometheusMetricType::counter},
      {"gauge",   PrometheusMetricType::gauge},
    };
    auto realtype = namesToTypes.find(def.type);
    if (realtype == namesToTypes.end()) {
      return false;
    }
    metrics.emplace(def.name, MetricDefinition{realtype->second, def.description, def.customName});
    return true;
  }

  // Return string representation of Prometheus metric type
  std::string getPrometheusStringMetricType(PrometheusMetricType metricType) const {
    switch (metricType) {
      case PrometheusMetricType::counter:
        return "counter";
        break;
      case PrometheusMetricType::gauge:
        return "gauge";
        break;
      default:
        return "";
        break;
    }
  };

  static std::map<std::string, MetricDefinition> metrics;
};
#endif /* DISABLE_PROMETHEUS */