Seastar
High performance C++ framework for concurrent servers
metrics_types.hh
1/*
2 * This file is open source software, licensed to you under the terms
3 * of the Apache License, Version 2.0 (the "License"). See the NOTICE file
4 * distributed with this work for additional information regarding copyright
5 * ownership. You may not use this file except in compliance with the License.
6 *
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing,
12 * software distributed under the License is distributed on an
13 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14 * KIND, either express or implied. See the License for the
15 * specific language governing permissions and limitations
16 * under the License.
17 */
18/*
19 * Copyright (C) 2016 ScyllaDB
20 */
21
22#pragma once
23
24#ifndef SEASTAR_MODULE
25#include <cstdint>
26#include <vector>
27#include <seastar/util/modules.hh>
28#include <optional>
29#endif
30
31namespace seastar {
32namespace metrics {
33
34SEASTAR_MODULE_EXPORT_BEGIN
35
43 uint64_t count = 0; // number of events.
44 double upper_bound = 0; // Inclusive.
45};
52 // schema defines the bucket schema. Currently, valid numbers are -4 <= n <= 8.
53 // They are all for base-2 bucket schemas, where 1 is a bucket boundary in each case, and
54 // then each power of two is divided into 2^n logarithmic buckets.
55 // Or in other words, each bucket boundary is the previous boundary times 2^(2^-n).
56 // In the future, more bucket schemas may be added using numbers < -4 or > 8.
57 int32_t schema;
58 // min_id is the first bucket id of a given schema.
59 int32_t min_id;
60};
61
69struct histogram {
70 uint64_t sample_count = 0;
71 double sample_sum = 0;
72 std::vector<histogram_bucket> buckets; // Ordered in increasing order of upper_bound, +Inf bucket is optional.
73
81
89 histogram operator+(const histogram& h) const;
90
99
100 // Native histograms are an experimental Prometheus feature.
101 std::optional<native_histogram_info> native_histogram;
102};
103
104SEASTAR_MODULE_EXPORT_END
105
106}
107
108}
Histogram bucket type.
Definition: metrics_types.hh:42
native histogram specific information
Definition: metrics_types.hh:51
Seastar API namespace.
Definition: abort_on_ebadf.hh:26
Histogram data type.
Definition: metrics_types.hh:69
histogram operator+(histogram &&h) const
Addition historgrams.
histogram operator+(const histogram &h) const
Addition historgrams.
histogram & operator+=(const histogram &h)
Addition assigning a historgram.