4 // A simple global class to keep track of metrics export in Prometheus format.
5 // It would be better to use a more full-featured Prometheus client library for this,
6 // but it would introduce a dependency that is not commonly packaged in distributions,
7 // which makes it quite unwieldy. Thus, we'll package our own for the time being.
22 // Prometheus recommends the use of timestamps instead of “time since event”,
23 // so you can use this to get the number of seconds since the epoch.
24 // Note that this will be wrong if your clock changes, so for non-metric use,
25 // you should use std::chrono::steady_clock instead.
26 double get_timestamp_for_metrics();
33 TYPE_HISTOGRAM, // Internal use only.
34 TYPE_SUMMARY, // Internal use only.
41 void add(const std::string &name, std::atomic<int64_t> *location, Type type = TYPE_COUNTER)
43 add(name, {}, location, type);
46 void add(const std::string &name, std::atomic<double> *location, Type type = TYPE_COUNTER)
48 add(name, {}, location, type);
51 void add(const std::string &name, Histogram *location)
53 add(name, {}, location);
56 void add(const std::string &name, Summary *location)
58 add(name, {}, location);
61 void add(const std::string &name, const std::vector<std::pair<std::string, std::string>> &labels, std::atomic<int64_t> *location, Type type = TYPE_COUNTER);
62 void add(const std::string &name, const std::vector<std::pair<std::string, std::string>> &labels, std::atomic<double> *location, Type type = TYPE_COUNTER);
63 void add(const std::string &name, const std::vector<std::pair<std::string, std::string>> &labels, Histogram *location, Laziness laziness = PRINT_ALWAYS);
64 void add(const std::string &name, const std::vector<std::pair<std::string, std::string>> &labels, Summary *location, Laziness laziness = PRINT_ALWAYS);
66 void remove(const std::string &name)
71 void remove(const std::string &name, const std::vector<std::pair<std::string, std::string>> &labels);
73 std::string serialize() const;
76 static std::string serialize_name(const std::string &name, const std::vector<std::pair<std::string, std::string>> &labels);
77 static std::string serialize_labels(const std::vector<std::pair<std::string, std::string>> &labels);
86 MetricKey(const std::string &name, const std::vector<std::pair<std::string, std::string>> labels)
87 : name(name), labels(labels), serialized_labels(serialize_labels(labels))
91 bool operator< (const MetricKey &other) const
93 if (name != other.name)
94 return name < other.name;
95 return serialized_labels < other.serialized_labels;
98 const std::string name;
99 const std::vector<std::pair<std::string, std::string>> labels;
100 const std::string serialized_labels;
104 Laziness laziness; // Only for TYPE_HISTOGRAM.
106 std::atomic<int64_t> *location_int64;
107 std::atomic<double> *location_double;
108 Histogram *location_histogram;
109 Summary *location_summary;
113 mutable std::mutex mu;
114 std::map<std::string, Type> types; // Ordered the same as metrics.
115 std::map<MetricKey, Metric> metrics;
117 friend class Histogram;
118 friend class Summary;
123 void init(const std::vector<double> &bucket_vals);
124 void init_uniform(size_t num_buckets); // Sets up buckets 0..(N-1).
125 void init_geometric(double min, double max, size_t num_buckets);
126 void count_event(double val);
127 std::string serialize(Metrics::Laziness laziness, const std::string &name, const std::vector<std::pair<std::string, std::string>> &labels) const;
130 // Bucket <i> counts number of events where val[i - 1] < x <= val[i].
131 // The end histogram ends up being made into a cumulative one,
132 // but that's not how we store it here.
135 std::atomic<int64_t> count{0};
137 std::unique_ptr<Bucket[]> buckets;
139 std::atomic<double> sum{0.0};
140 std::atomic<int64_t> count_after_last_bucket{0};
143 // This is a pretty dumb streaming quantile class, but it's exact, and we don't have
144 // too many values (typically one per frame, and one-minute interval), so we don't
145 // need anything fancy.
148 void init(const std::vector<double> &quantiles, double window_seconds);
149 void count_event(double val);
150 std::string serialize(Metrics::Laziness laziness, const std::string &name, const std::vector<std::pair<std::string, std::string>> &labels);
153 std::vector<double> quantiles;
154 std::chrono::duration<double> window;
156 mutable std::mutex mu;
157 std::deque<std::pair<std::chrono::steady_clock::time_point, double>> values;
158 std::atomic<double> sum{0.0};
159 std::atomic<int64_t> count{0};
162 extern Metrics global_metrics;
164 #endif // !defined(_METRICS_H)