kcenon::monitoring::metric_exporter_interface Class Reference

Abstract interface for metric exporters. More...

#include <metric_exporters.h>

Inheritance diagram for kcenon::monitoring::metric_exporter_interface:

Collaboration diagram for kcenon::monitoring::metric_exporter_interface:

Public Member Functions
virtual	~metric_exporter_interface ()=default
virtual common::VoidResult	export_metrics (const std::vector< monitoring_data > &metrics)=0
	Export a batch of metrics.
virtual common::VoidResult	export_snapshot (const metrics_snapshot &snapshot)=0
	Export a single metrics snapshot.
virtual common::VoidResult	flush ()=0
	Flush any pending metrics.
virtual common::VoidResult	shutdown ()=0
	Shutdown the exporter.
virtual std::unordered_map< std::string, std::size_t >	get_stats () const =0
	Get exporter statistics.
virtual common::VoidResult	start ()
	Start the exporter (for pull-based systems)
virtual common::VoidResult	stop ()
	Stop the exporter.

Detailed Description

Abstract interface for metric exporters.

Definition at line 242 of file metric_exporters.h.

Constructor & Destructor Documentation

~metric_exporter_interface()

virtual kcenon::monitoring::metric_exporter_interface::~metric_exporter_interface ( )

virtualdefault

Member Function Documentation

export_metrics()

virtual common::VoidResult kcenon::monitoring::metric_exporter_interface::export_metrics ( const std::vector< monitoring_data > & metrics )

pure virtual

Export a batch of metrics.

Implemented in kcenon::monitoring::otlp_metrics_exporter, kcenon::monitoring::prometheus_exporter, and kcenon::monitoring::statsd_exporter.

export_snapshot()

virtual common::VoidResult kcenon::monitoring::metric_exporter_interface::export_snapshot ( const metrics_snapshot & snapshot )

pure virtual

Export a single metrics snapshot.

Implemented in kcenon::monitoring::otlp_metrics_exporter, kcenon::monitoring::prometheus_exporter, and kcenon::monitoring::statsd_exporter.

flush()

virtual common::VoidResult kcenon::monitoring::metric_exporter_interface::flush ( )

pure virtual

Flush any pending metrics.

Implemented in kcenon::monitoring::otlp_metrics_exporter, kcenon::monitoring::prometheus_exporter, and kcenon::monitoring::statsd_exporter.

get_stats()

virtual std::unordered_map< std::string, std::size_t > kcenon::monitoring::metric_exporter_interface::get_stats ( ) const

pure virtual

Get exporter statistics.

Implemented in kcenon::monitoring::otlp_metrics_exporter, kcenon::monitoring::prometheus_exporter, and kcenon::monitoring::statsd_exporter.

shutdown()

virtual common::VoidResult kcenon::monitoring::metric_exporter_interface::shutdown ( )

pure virtual

Shutdown the exporter.

Implemented in kcenon::monitoring::otlp_metrics_exporter, kcenon::monitoring::prometheus_exporter, and kcenon::monitoring::statsd_exporter.

start()

virtual common::VoidResult kcenon::monitoring::metric_exporter_interface::start ( )

inlinevirtual

Start the exporter (for pull-based systems)

Reimplemented in kcenon::monitoring::otlp_metrics_exporter, and kcenon::monitoring::statsd_exporter.

Definition at line 274 of file metric_exporters.h.

{ return common::ok(); }

stop()

virtual common::VoidResult kcenon::monitoring::metric_exporter_interface::stop ( )

inlinevirtual

Stop the exporter.

Reimplemented in kcenon::monitoring::otlp_metrics_exporter, and kcenon::monitoring::statsd_exporter.

Definition at line 279 of file metric_exporters.h.

{ return common::ok(); }

---

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

• include/kcenon/monitoring/exporters/metric_exporters.h