Usage

#include<prometheus/counter.h>#include<prometheus/exposer.h>#include<prometheus/registry.h>#include<array>#include<chrono>#include<cstdlib>#include<memory>#include<string>#include<thread>intmain() {usingnamespaceprometheus;// create an http server running on port 8080  Exposer exposer{"127.0.0.1:8080"};// create a metrics registry// @note it's the users responsibility to keep the object aliveauto registry = std::make_shared<Registry>();// add a new counter family to the registry (families combine values with the// same name, but distinct label dimensions)//// @note please follow the metric-naming best-practices:// https://prometheus.io/docs/practices/naming/auto& packet_counter =BuildCounter()                             .Name("observed_packets_total")                             .Help("Number of observed packets")                             .Register(*registry);// add and remember dimensional data, incrementing those is very cheapauto& tcp_rx_counter =      packet_counter.Add({{"protocol","tcp"}, {"direction","rx"}});auto& tcp_tx_counter =      packet_counter.Add({{"protocol","tcp"}, {"direction","tx"}});auto& udp_rx_counter =      packet_counter.Add({{"protocol","udp"}, {"direction","rx"}});auto& udp_tx_counter =      packet_counter.Add({{"protocol","udp"}, {"direction","tx"}});// add a counter whose dimensional data is not known at compile time// nevertheless dimensional values should only occur in low cardinality:// https://prometheus.io/docs/practices/naming/#labelsauto& http_requests_counter =BuildCounter()                                    .Name("http_requests_total")                                    .Help("Number of HTTP requests")                                    .Register(*registry);// ask the exposer to scrape the registry on incoming HTTP requests  exposer.RegisterCollectable(registry);for (;;) {std::this_thread::sleep_for(std::chrono::seconds(1));constauto random_value =std::rand();if (random_value &1) tcp_rx_counter.Increment();if (random_value &2) tcp_tx_counter.Increment();if (random_value &4) udp_rx_counter.Increment();if (random_value &8) udp_tx_counter.Increment();const std::array<std::string,4> methods = {"GET","PUT","POST","HEAD"};auto method = methods.at(random_value % methods.size());// dynamically calling Family<T>.Add() works but is slow and should be// avoided    http_requests_counter.Add({{"method", method}}).Increment();  }return0;}

Requirements

Building

via CMake

# fetch third-party dependenciesgit submodule initgit submodule updatemkdir _buildcd _build# run cmakecmake .. -DBUILD_SHARED_LIBS=ON -DENABLE_PUSH=OFF -DENABLE_COMPRESSION=OFF# buildcmake --build. --parallel 4# run testsctest -V# install the libraries and headerscmake --install.

via Bazel

load("@bazel_tools//tools/build_defs/repo:http.bzl","http_archive","http_file")http_archive(name="com_github_jupp0r_prometheus_cpp",strip_prefix="prometheus-cpp-master",urls= ["https://github.com/jupp0r/prometheus-cpp/archive/master.zip"],)load("@com_github_jupp0r_prometheus_cpp//bazel:repositories.bzl","prometheus_cpp_repositories")prometheus_cpp_repositories()

cc_binary(name="sample_server",srcs= ["sample_server.cc"],deps= ["@com_github_jupp0r_prometheus_cpp//pull"],)

Packaging

# fetch third-party dependenciesgit submodule update --init# run cmakecmake -B_build -DCPACK_GENERATOR=DEB -DBUILD_SHARED_LIBS=ON# or OFF for static libraries# build and packagecmake --build _build --target package --parallel$(nproc)

Consuming the installed project

CMake

vcpkg

Conan

Plain Makefiles

-lprometheus-cpp-pull -lprometheus-cpp-core -lz

-lprometheus-cpp-push -lprometheus-cpp-core -lcurl -lz

Contributing

bazel build //...# build everythingbazel build //core //pull# build just the libraries

bazel test //...

bazel test //pull/tests/integration:scrape-test

Benchmarks

bazel run -c opt //core/benchmarksINFO: Analysed target //core/benchmarks:benchmarks (0 packages loaded, 0 targets configured).INFO: Found 1 target...Target //core/benchmarks:benchmarks up-to-date:  bazel-bin/core/benchmarks/benchmarksINFO: Elapsed time: 0.356s, Critical Path: 0.01s, Remote (0.00% of the time): [queue: 0.00%, setup: 0.00%, process: 0.00%]INFO: 0 processes.INFO: Build completed successfully, 1 total actionINFO: Build completed successfully, 1 total action2018-11-30 15:13:14Run on (4 X 2200 MHz CPU s)CPU Caches:  L1 Data 32K (x2)  L1 Instruction 32K (x2)  L2 Unified 262K (x2)  L3 Unified 4194K (x1)-----------------------------------------------------------------------------------Benchmark                                            Time           CPU Iterations-----------------------------------------------------------------------------------BM_Counter_Increment                                13 ns         12 ns   55616469BM_Counter_Collect                                   7 ns          7 ns   99823170BM_Gauge_Increment                                  12 ns         12 ns   51511873BM_Gauge_Decrement                                  12 ns         12 ns   56831098BM_Gauge_SetToCurrentTime                          184 ns        183 ns    3928964BM_Gauge_Collect                                     6 ns          6 ns  117223478BM_Histogram_Observe/0                             134 ns        124 ns    5665310BM_Histogram_Observe/1                             122 ns        120 ns    5937185BM_Histogram_Observe/8                             137 ns        135 ns    4652863BM_Histogram_Observe/64                            143 ns        143 ns    4835957BM_Histogram_Observe/512                           259 ns        257 ns    2334750BM_Histogram_Observe/4096                         1545 ns       1393 ns     620754BM_Histogram_Collect/0                             103 ns        102 ns    5654829BM_Histogram_Collect/1                             100 ns        100 ns    7015153BM_Histogram_Collect/8                             608 ns        601 ns    1149652BM_Histogram_Collect/64                           1438 ns       1427 ns     515236BM_Histogram_Collect/512                          5178 ns       5159 ns     114619BM_Histogram_Collect/4096                        33527 ns      33280 ns      20785BM_Registry_CreateFamily                           320 ns        316 ns    2021567BM_Registry_CreateCounter/0                        128 ns        128 ns    5487140BM_Registry_CreateCounter/1                       2066 ns       2058 ns     386002BM_Registry_CreateCounter/8                       7672 ns       7634 ns      91328BM_Registry_CreateCounter/64                     63270 ns      62761 ns      10780BM_Registry_CreateCounter/512                   560714 ns     558328 ns       1176BM_Registry_CreateCounter/4096                18672798 ns   18383000 ns         35BM_Summary_Observe/0/iterations:262144            9351 ns       9305 ns     262144BM_Summary_Observe/1/iterations:262144            9242 ns       9169 ns     262144BM_Summary_Observe/8/iterations:262144           14344 ns      14195 ns     262144BM_Summary_Observe/64/iterations:262144          19176 ns      18950 ns     262144BM_Summary_Collect/0/0                              31 ns         30 ns   24873766BM_Summary_Collect/1/0                             166 ns        166 ns    4266706BM_Summary_Collect/8/0                            1040 ns       1036 ns     660527BM_Summary_Collect/64/0                           4529 ns       4489 ns     155600BM_Summary_Collect/0/1                              28 ns         28 ns   24866697BM_Summary_Collect/1/1                             190 ns        188 ns    3930354BM_Summary_Collect/8/1                            1372 ns       1355 ns     535779BM_Summary_Collect/64/1                           9901 ns       9822 ns      64632BM_Summary_Collect/0/8                              29 ns         29 ns   24922651BM_Summary_Collect/1/8                             217 ns        215 ns    3278381BM_Summary_Collect/8/8                            2275 ns       2256 ns     282503BM_Summary_Collect/64/8                          56790 ns      55804 ns      13878BM_Summary_Collect/0/64                             32 ns         31 ns   22548350BM_Summary_Collect/1/64                            395 ns        389 ns    1817073BM_Summary_Collect/8/64                          10187 ns      10064 ns      71928BM_Summary_Collect/64/64                        374835 ns     373560 ns       1812BM_Summary_Collect/0/512                            28 ns         28 ns   25234228BM_Summary_Collect/1/512                          1710 ns       1639 ns     802285BM_Summary_Collect/8/512                         50355 ns      49335 ns      15975BM_Summary_Collect/64/512                      2520972 ns    2493417 ns        295BM_Summary_Collect/0/4096                           31 ns         31 ns   24059034BM_Summary_Collect/1/4096                         2719 ns       2698 ns     286186BM_Summary_Collect/8/4096                       121689 ns     119995 ns       5647BM_Summary_Collect/64/4096                     5660131 ns    5587634 ns        134BM_Summary_Collect/0/32768                          29 ns         29 ns   22217567BM_Summary_Collect/1/32768                        4344 ns       4294 ns     138135BM_Summary_Collect/8/32768                      331563 ns     326403 ns       2017BM_Summary_Collect/64/32768                   16363553 ns   16038182 ns         44BM_Summary_Collect/0/262144                         27 ns         27 ns   23923036BM_Summary_Collect/1/262144                      10457 ns      10332 ns      67690BM_Summary_Collect/8/262144                     930434 ns     869234 ns        792BM_Summary_Collect/64/262144                  39217069 ns   39054846 ns         13BM_Summary_Observe_Common/iterations:262144       5587 ns       5557 ns     262144BM_Summary_Collect_Common/0                        676 ns        673 ns    1054630BM_Summary_Collect_Common/1                        709 ns        705 ns     990659BM_Summary_Collect_Common/8                       1030 ns       1025 ns     685649BM_Summary_Collect_Common/64                      2066 ns       2055 ns     339969BM_Summary_Collect_Common/512                     5754 ns       5248 ns     156895BM_Summary_Collect_Common/4096                   23894 ns      23292 ns      31096BM_Summary_Collect_Common/32768                  49831 ns      49292 ns      13492BM_Summary_Collect_Common/262144                128723 ns     126987 ns       5579

Project Status

FAQ

What scrape formats do you support

License