kagome::metrics::Exposer Class Reference

an http server interface to expose metrics on request with custom request handler More...

#include <exposer.hpp>

Inheritance diagram for kagome::metrics::Exposer:

Collaboration diagram for kagome::metrics::Exposer:

Classes
struct	Configuration

Public Types
using	Context = boost::asio::io_context

Public Member Functions
void	setHandler (const std::shared_ptr< Handler > &handler)
	sets handler and takes ownership More...
virtual	~Exposer ()=default
virtual bool	prepare ()=0
	prepare interface for AppStateManager More...
virtual bool	start ()=0
	start interface for AppStateManager More...
virtual void	stop ()=0
	stop interface for AppStateManager More...

Protected Types
using	Acceptor = boost::asio::ip::tcp::acceptor
using	Endpoint = boost::asio::ip::tcp::endpoint

Protected Attributes
std::shared_ptr< Handler >	handler_

Detailed Description

an http server interface to expose metrics on request with custom request handler

Definition at line 21 of file exposer.hpp.

---

Class Documentation

struct kagome::metrics::Exposer::Configuration

Definition at line 29 of file exposer.hpp.

Collaboration diagram for kagome::metrics::Exposer::Configuration:

Class Members
Endpoint	endpoint

Member Typedef Documentation

using kagome::metrics::Exposer::Acceptor = boost::asio::ip::tcp::acceptor

protected

Definition at line 23 of file exposer.hpp.

using kagome::metrics::Exposer::Context = boost::asio::io_context

Definition at line 27 of file exposer.hpp.

using kagome::metrics::Exposer::Endpoint = boost::asio::ip::tcp::endpoint

protected

Definition at line 24 of file exposer.hpp.

Constructor & Destructor Documentation

virtual kagome::metrics::Exposer::~Exposer ( )

virtualdefault

Member Function Documentation

virtual bool kagome::metrics::Exposer::prepare ( )

pure virtual

prepare interface for AppStateManager

Implemented in kagome::metrics::ExposerImpl.

void kagome::metrics::Exposer::setHandler ( const std::shared_ptr< Handler > &  handler )

inline

sets handler and takes ownership

Definition at line 36 of file exposer.hpp.

virtual bool kagome::metrics::Exposer::start ( )

pure virtual

start interface for AppStateManager

Implemented in kagome::metrics::ExposerImpl.

virtual void kagome::metrics::Exposer::stop ( )

pure virtual

stop interface for AppStateManager

Implemented in kagome::metrics::ExposerImpl.

Member Data Documentation

std::shared_ptr<Handler> kagome::metrics::Exposer::handler_

protected

Definition at line 58 of file exposer.hpp.

---

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

• core/metrics/exposer.hpp