PrometheusServer Class Reference

#include <PrometheusServer.hpp>

Public Member Functions
	PrometheusServer (const std::string &serverAddr)
std::shared_ptr< prometheus::Registry >	getRegistry (uint64_t regId)
std::shared_ptr< prometheus::Registry >	createNewRegistry ()
std::shared_ptr< prometheus::Registry >	createNewRegistry (uint64_t &regId)
bool	deleteRegistry (uint64_t regId)

Private Attributes
std::mutex	_guardLock
	Mutex for concurrent add tracker calls.
std::unique_ptr< prometheus::Exposer >	_mainExposer
	Main HTTP Server.
std::vector< std::pair< uint64_t, std::shared_ptr< prometheus::Registry > > >	_vRegister
	All tracker registries.
prometheus::Family< prometheus::Info > *	_infoFamily
	General application information.

Detailed Description

Class representing a Prometheus server for collecting and exposing metrics.

Definition at line 10 of file PrometheusServer.hpp.

Constructor & Destructor Documentation

PrometheusServer()

PrometheusServer::PrometheusServer ( const std::string & serverAddr )

explicit

Construct a new Prometheus Server

Parameters

[in]

serverAddr

Server address in <IP>:<Port> format

Definition at line 12 of file PrometheusServer.cpp.

    : _mainExposer(std::make_unique<prometheus::Exposer>(serverAddr, 1))
{
    auto reg = std::make_shared<prometheus::Registry>();
 
    // Basic information
    _infoFamily =
        &prometheus::BuildInfo().Name(PROJECT_NAME).Help(std::string(PROJECT_NAME) + " information").Register(*reg);
 
    _infoFamily->Add({{"init_time", date::format("%FT%TZ", date::floor<std::chrono::nanoseconds>(
                                                               std::chrono::high_resolution_clock::now()))}});
    _infoFamily->Add({{"version", PROJECT_FULL_REVISION}});
 
    _vRegister.emplace_back(std::numeric_limits<uint64_t>::max(), reg);
    _mainExposer->RegisterCollectable(reg);
}

Member Function Documentation

createNewRegistry() [1/2]

std::shared_ptr< prometheus::Registry > PrometheusServer::createNewRegistry

(

)

Create a registry for prometheus

Returns

std::shared_ptr<prometheus::Registry> Registry pointer

Definition at line 45 of file PrometheusServer.cpp.

{
    uint64_t regId = 0;
    return createNewRegistry(regId);
}

Here is the call graph for this function:

Here is the caller graph for this function:

createNewRegistry() [2/2]

std::shared_ptr< prometheus::Registry > PrometheusServer::createNewRegistry

(

uint64_t &

regId

)

Create a registry for prometheus and returns id of the registry

Parameters

[out]

regId

Registry id

Returns

std::shared_ptr<prometheus::Registry> Registry pointer

Definition at line 51 of file PrometheusServer.cpp.

{
    const std::scoped_lock guard(_guardLock);
 
    // Create registry
    auto reg = std::make_shared<prometheus::Registry>();
    _mainExposer->RegisterCollectable(reg);
 
    // Push to vector (At least information registry always exist so back is valid)
    regId = _vRegister.back().first + 1;
    _vRegister.emplace_back(_vRegister.back().first + 1, reg);
    return reg;
}

deleteRegistry()

bool PrometheusServer::deleteRegistry

(

uint64_t

regId

)

Deletes the registry with id

Parameters

[in]

regId

Registry id

Returns

true If successfully removed

false otherwise

Definition at line 65 of file PrometheusServer.cpp.

{
    if (regId == std::numeric_limits<uint64_t>::max())
    {
        return false;
    }
 
    const std::scoped_lock guard(_guardLock);
    std::erase_if(_vRegister, [regId](const std::pair<uint64_t, std::shared_ptr<prometheus::Registry>> &val) {
        return regId == val.first;
    });
 
    return true;
}

getRegistry()

std::shared_ptr< prometheus::Registry > PrometheusServer::getRegistry

(

uint64_t

regId

)

Get the registry with id

Parameters

[in]

regId

Registry id

Returns

std::shared_ptr<prometheus::Registry> Registry pointer if found, nullptr otherwise

Definition at line 29 of file PrometheusServer.cpp.

{
    const std::scoped_lock guard(_guardLock);
 
    if (auto iter =
            std::ranges::find_if(_vRegister,
                                 [regId](const std::pair<uint64_t, std::shared_ptr<prometheus::Registry>> &val) {
                                     return regId == val.first;
                                 });
        iter != _vRegister.end())
    {
        return iter->second;
    }
    return nullptr;
}

Member Data Documentation

_guardLock

std::mutex PrometheusServer::_guardLock

private

Mutex for concurrent add tracker calls.

Definition at line 13 of file PrometheusServer.hpp.

_infoFamily

prometheus::Family<prometheus::Info>* PrometheusServer::_infoFamily

private

General application information.

Definition at line 20 of file PrometheusServer.hpp.

_mainExposer

std::unique_ptr<prometheus::Exposer> PrometheusServer::_mainExposer

private

Main HTTP Server.

Definition at line 15 of file PrometheusServer.hpp.

_vRegister

std::vector<std::pair<uint64_t, std::shared_ptr<prometheus::Registry> > > PrometheusServer::_vRegister

private

All tracker registries.

Definition at line 17 of file PrometheusServer.hpp.

---

The documentation for this class was generated from the following files:

• /__w/Repo-Init/Repo-Init/include/metrics/PrometheusServer.hpp
• /__w/Repo-Init/Repo-Init/src/metrics/PrometheusServer.cpp