RMQ - RabbitMQ C++ Library
Public Member Functions | List of all members
BloombergLP::rmqp::MetricPublisher Class Referenceabstract

An interface for publishing rmqcpp metrics. More...

#include <rmqp_metricpublisher.h>

Inheritance diagram for BloombergLP::rmqp::MetricPublisher:
Inheritance graph
[legend]

Public Member Functions

virtual void publishGauge (const bsl::string &name, double value, const bsl::vector< bsl::pair< bsl::string, bsl::string > > &tags)=0
 Publish a gauge - the most recently observed value of a variable. More...
 
virtual void publishCounter (const bsl::string &name, double value, const bsl::vector< bsl::pair< bsl::string, bsl::string > > &tags)=0
 Publish an increment to a counter variable. More...
 
virtual void publishSummary (const bsl::string &name, double value, const bsl::vector< bsl::pair< bsl::string, bsl::string > > &tags)=0
 Publish a value for basic summary statistics. More...
 
virtual void publishDistribution (const bsl::string &name, double value, const bsl::vector< bsl::pair< bsl::string, bsl::string > > &tags)=0
 

Detailed Description

An interface for publishing rmqcpp metrics.

The rmqcpp implementation uses MetricPublisher interface to publish various runtime metrics. The users of rmqcpp can provide their own implementation of this interface to receive the published metrics.

Every published metric consists of name, value and associated tags (e.g. vhost name).

Implementation must be thread-safe.

Member Function Documentation

◆ publishCounter()

virtual void BloombergLP::rmqp::MetricPublisher::publishCounter ( const bsl::string &  name,
double  value,
const bsl::vector< bsl::pair< bsl::string, bsl::string > > &  tags 
)
pure virtual

Publish an increment to a counter variable.

Implemented in BloombergLP::rmqa::NoOpMetricPublisher.

◆ publishDistribution()

virtual void BloombergLP::rmqp::MetricPublisher::publishDistribution ( const bsl::string &  name,
double  value,
const bsl::vector< bsl::pair< bsl::string, bsl::string > > &  tags 
)
pure virtual

Publish a value for distribution statistics. A distribution is similar to a summary but also includes quantile statistics.

Implemented in BloombergLP::rmqa::NoOpMetricPublisher.

◆ publishGauge()

virtual void BloombergLP::rmqp::MetricPublisher::publishGauge ( const bsl::string &  name,
double  value,
const bsl::vector< bsl::pair< bsl::string, bsl::string > > &  tags 
)
pure virtual

Publish a gauge - the most recently observed value of a variable.

Implemented in BloombergLP::rmqa::NoOpMetricPublisher.

◆ publishSummary()

virtual void BloombergLP::rmqp::MetricPublisher::publishSummary ( const bsl::string &  name,
double  value,
const bsl::vector< bsl::pair< bsl::string, bsl::string > > &  tags 
)
pure virtual

Publish a value for basic summary statistics.

Implemented in BloombergLP::rmqa::NoOpMetricPublisher.


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