StatusTracker Class Reference

#include <Status.hpp>

Public Member Functions
	StatusTracker (const std::shared_ptr< prometheus::Registry > &reg, const std::string &name, uint64_t metricID=0)
void	incrementActive ()
void	decrementActive ()
void	incrementSuccess ()
void	incrementFail ()

Private Attributes
prometheus::Gauge *	_activeCtr
	Active number of events.
prometheus::Counter *	_totalCtr
	Total number of counters.
prometheus::Counter *	_successCtr
	Number of success.
prometheus::Counter *	_failedCtr
	Number of fail.

Detailed Description

Class for tracking the status of events and counting successes and failures.

Definition at line 9 of file Status.hpp.

Constructor & Destructor Documentation

StatusTracker()

StatusTracker::StatusTracker	(	const std::shared_ptr< prometheus::Registry > &	reg,
		const std::string &	name,
		uint64_t	metricID = 0 )

Construct a new Status Tracker

Parameters

[in]	reg	Registry to prometheus
[in]	name	Name of the metric
[in]	metricID	ID to append to metric names

Definition at line 6 of file Status.cpp.

{
    // Register values
    _activeCtr = &prometheus::BuildGauge()
                      .Name(name + "_active_event_ctr_" + std::to_string(metricID))
                      .Help("Currently active number of events of " + name)
                      .Register(*reg)
                      .Add({});
    _totalCtr = &prometheus::BuildCounter()
                     .Name(name + "_total_event_ctr_" + std::to_string(metricID))
                     .Help("Total occurrences of " + name)
                     .Register(*reg)
                     .Add({});
    _successCtr = &prometheus::BuildCounter()
                       .Name(name + "_success_event_ctr_" + std::to_string(metricID))
                       .Help("Successful events of " + name)
                       .Register(*reg)
                       .Add({});
    _failedCtr = &prometheus::BuildCounter()
                      .Name(name + "_fail_event_ctr_" + std::to_string(metricID))
                      .Help("Failed events of " + name)
                      .Register(*reg)
                      .Add({});
}

Member Function Documentation

decrementActive()

void StatusTracker::decrementActive

(

)

Decrement number of current events

Definition at line 34 of file Status.cpp.

{ _activeCtr->Decrement(); }

Here is the caller graph for this function:

incrementActive()

void StatusTracker::incrementActive

(

)

Increment number of current events

Definition at line 32 of file Status.cpp.

{ _activeCtr->Increment(); }

Here is the caller graph for this function:

incrementFail()

void StatusTracker::incrementFail

(

)

Increment number of fail

Definition at line 46 of file Status.cpp.

{
    _failedCtr->Increment();
    _totalCtr->Increment();
    if (_activeCtr->Value() > 0)
    {
        _activeCtr->Decrement();
    }
}

incrementSuccess()

void StatusTracker::incrementSuccess

(

)

Increment number of success

Definition at line 36 of file Status.cpp.

{
    _successCtr->Increment();
    _totalCtr->Increment();
    if (_activeCtr->Value() > 0)
    {
        _activeCtr->Decrement();
    }
}

Member Data Documentation

_activeCtr

prometheus::Gauge* StatusTracker::_activeCtr

private

Active number of events.

Definition at line 11 of file Status.hpp.

_failedCtr

prometheus::Counter* StatusTracker::_failedCtr

private

Number of fail.

Definition at line 14 of file Status.hpp.

_successCtr

prometheus::Counter* StatusTracker::_successCtr

private

Number of success.

Definition at line 13 of file Status.hpp.

_totalCtr

prometheus::Counter* StatusTracker::_totalCtr

private

Total number of counters.

Definition at line 12 of file Status.hpp.

---

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

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