ceph/src/seastar/include/seastar/core/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 #include <seastar/http/httpd.hh>
  25 #include <seastar/core/metrics.hh>
  26 #include <seastar/util/std-compat.hh>
  27
  28 namespace seastar {
  29
  30 namespace prometheus {
  31
  32 /*!
  33  * Holds prometheus related configuration
  34  */
  35 struct config {
  36     sstring metric_help; //!< Default help message for the returned metrics
  37     sstring hostname; //!< hostname is deprecated, use label instead
  38     compat::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 server
  39     sstring prefix = "seastar"; //!< a prefix that will be added to metric names
  40 };
  41
  42 future<> start(httpd::http_server_control& http_server, config ctx);
  43
  44 /// \defgroup add_prometheus_routes adds a /metrics endpoint that returns prometheus metrics
  45 ///    both in txt format and in protobuf according to the prometheus spec
  46 /// @{
  47 future<> add_prometheus_routes(distributed<http_server>& server, config ctx);
  48 future<> add_prometheus_routes(http_server& server, config ctx);
  49 /// @}
  50 }
  51 }