Seastar
High performance C++ framework for concurrent servers
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
prometheus.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 <seastar/http/httpd.hh>
27#include <seastar/util/std-compat.hh>
28#include <seastar/util/modules.hh>
29#include <optional>
30#endif
31
32namespace seastar {
33
34namespace prometheus {
35
36SEASTAR_MODULE_EXPORT_BEGIN
37
41struct config {
42 sstring metric_help;
43 sstring hostname;
44 std::optional<metrics::label_instance> label;
45 sstring prefix = "seastar";
46 bool allow_protobuf = false; // protobuf support is experimental and off by default
47};
48
49future<> start(httpd::http_server_control& http_server, config ctx);
50
54future<> add_prometheus_routes(distributed<httpd::http_server>& server, config ctx);
55future<> add_prometheus_routes(httpd::http_server& server, config ctx);
57SEASTAR_MODULE_EXPORT_END
58}
59}
A representation of a possibly not-yet-computed value.
Definition: future.hh:1240
Definition: httpd.hh:236
Definition: httpd.hh:134
Definition: sharded.hh:182
header for metrics creation.
Seastar API namespace.
Definition: abort_on_ebadf.hh:26
Definition: prometheus.hh:41
std::optional< metrics::label_instance > label
A label that will be added to all metrics, we advice not to use it and set it on the prometheus serve...
Definition: prometheus.hh:44
sstring metric_help
Default help message for the returned metrics.
Definition: prometheus.hh:42
sstring prefix
a prefix that will be added to metric names
Definition: prometheus.hh:45
sstring hostname
hostname is deprecated, use label instead
Definition: prometheus.hh:43