beast::insight::StatsDCollector Class Reference

A Collector that reports metrics to a StatsD server. More...

#include <StatsDCollector.h>

Inheritance diagram for beast::insight::StatsDCollector:

Collaboration diagram for beast::insight::StatsDCollector:

Public Types
using	ptr = std::shared_ptr<Collector>

Public Member Functions
	StatsDCollector ()=default
template<class Handler>
Hook	makeHook (Handler handler)
	Create a hook.
virtual Hook	makeHook (HookImpl::HandlerType const &handler)=0
virtual Counter	makeCounter (std::string const &name)=0
	Create a counter with the specified name.
Counter	makeCounter (std::string const &prefix, std::string const &name)
virtual Event	makeEvent (std::string const &name)=0
	Create an event with the specified name.
Event	makeEvent (std::string const &prefix, std::string const &name)
virtual Gauge	makeGauge (std::string const &name)=0
	Create a gauge with the specified name.
Gauge	makeGauge (std::string const &prefix, std::string const &name)
virtual Meter	makeMeter (std::string const &name)=0
	Create a meter with the specified name.
Meter	makeMeter (std::string const &prefix, std::string const &name)

Static Public Member Functions
static std::shared_ptr< StatsDCollector >	make (IP::Endpoint const &address, std::string const &prefix, Journal journal)
	Create a StatsD collector.

Detailed Description

A Collector that reports metrics to a StatsD server.

Reference: https://github.com/b/statsd_spec

Definition at line 13 of file StatsDCollector.h.

Member Typedef Documentation

ptr

using beast::insight::Collector::ptr = std::shared_ptr<Collector>

inherited

Definition at line 26 of file Collector.h.

Constructor & Destructor Documentation

StatsDCollector()

beast::insight::StatsDCollector::StatsDCollector ( )

explicitdefault

Member Function Documentation

make()

std::shared_ptr< StatsDCollector > beast::insight::StatsDCollector::make ( IP::Endpoint const & address, std::string const & prefix, Journal journal )

static

Create a StatsD collector.

Parameters

address	The IP address and port of the StatsD server.
prefix	A string pre-pended before each metric name.
journal	Destination for logging output.

Definition at line 719 of file StatsDCollector.cpp.

makeHook() [1/2]

template<class Handler>

Hook beast::insight::Collector::makeHook ( Handler handler )

inherited

Create a hook.

A hook is called at each collection interval, on an implementation defined thread. This is a convenience facility for gathering metrics in the polling style. The typical usage is to update all the metrics of interest in the handler.

Handler will be called with this signature: void handler (void)

See also

Hook

Definition at line 45 of file Collector.h.

makeHook() [2/2]

virtual Hook beast::insight::Collector::makeHook ( HookImpl::HandlerType const & handler )

pure virtualinherited

Implemented in beast::insight::detail::GroupImp, beast::insight::detail::NullCollectorImp, and beast::insight::detail::StatsDCollectorImp.

makeCounter() [1/2]

virtual Counter beast::insight::Collector::makeCounter ( std::string const & name )

pure virtualinherited

Create a counter with the specified name.

See also

Counter

Implemented in beast::insight::detail::GroupImp, beast::insight::detail::NullCollectorImp, and beast::insight::detail::StatsDCollectorImp.

makeCounter() [2/2]

Counter beast::insight::Collector::makeCounter ( std::string const & prefix, std::string const & name )

inherited

Definition at line 62 of file Collector.h.

makeEvent() [1/2]

virtual Event beast::insight::Collector::makeEvent ( std::string const & name )

pure virtualinherited

Create an event with the specified name.

See also

Event

Implemented in beast::insight::detail::GroupImp, beast::insight::detail::NullCollectorImp, and beast::insight::detail::StatsDCollectorImp.

makeEvent() [2/2]

Event beast::insight::Collector::makeEvent ( std::string const & prefix, std::string const & name )

inherited

Definition at line 78 of file Collector.h.

makeGauge() [1/2]

virtual Gauge beast::insight::Collector::makeGauge ( std::string const & name )

pure virtualinherited

Create a gauge with the specified name.

See also

Gauge

Implemented in beast::insight::detail::GroupImp, beast::insight::detail::NullCollectorImp, and beast::insight::detail::StatsDCollectorImp.

makeGauge() [2/2]

Gauge beast::insight::Collector::makeGauge ( std::string const & prefix, std::string const & name )

inherited

Definition at line 94 of file Collector.h.

makeMeter() [1/2]

virtual Meter beast::insight::Collector::makeMeter ( std::string const & name )

pure virtualinherited

Create a meter with the specified name.

See also

Meter

Implemented in beast::insight::detail::GroupImp, beast::insight::detail::NullCollectorImp, and beast::insight::detail::StatsDCollectorImp.

makeMeter() [2/2]

Meter beast::insight::Collector::makeMeter ( std::string const & prefix, std::string const & name )

inherited

Definition at line 110 of file Collector.h.