ESPHome  2022.11.4
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::prometheus::PrometheusHandler Class Reference

#include <prometheus_handler.h>

Inheritance diagram for esphome::prometheus::PrometheusHandler:
esphome::Component

Public Member Functions

 PrometheusHandler (web_server_base::WebServerBase *base)
 
void set_include_internal (bool include_internal)
 Determine whether internal components should be exported as metrics. More...
 
void add_label_id (EntityBase *obj, const std::string &value)
 Add the value for an entity's "id" label. More...
 
void add_label_name (EntityBase *obj, const std::string &value)
 Add the value for an entity's "name" label. More...
 
bool canHandle (AsyncWebServerRequest *request) override
 
void handleRequest (AsyncWebServerRequest *req) override
 
void setup () override
 
float get_setup_priority () const override
 
- Public Member Functions inherited from esphome::Component
virtual void loop ()
 This method will be called repeatedly. More...
 
virtual void dump_config ()
 
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
virtual float get_loop_priority () const
 priority of loop(). More...
 
void call ()
 
virtual void on_shutdown ()
 
virtual void on_safe_shutdown ()
 
uint32_t get_component_state () const
 
virtual void mark_failed ()
 Mark this component as failed. More...
 
bool is_failed ()
 
virtual bool can_proceed ()
 
bool status_has_warning ()
 
bool status_has_error ()
 
void status_set_warning ()
 
void status_set_error ()
 
void status_clear_warning ()
 
void status_clear_error ()
 
void status_momentary_warning (const std::string &name, uint32_t length=5000)
 
void status_momentary_error (const std::string &name, uint32_t length=5000)
 
bool has_overridden_loop () const
 
void set_component_source (const char *source)
 Set where this component was loaded from for some debug messages. More...
 
const char * get_component_source () const
 Get the integration where this component was declared as a string. More...
 

Protected Member Functions

std::string relabel_id_ (EntityBase *obj)
 
std::string relabel_name_ (EntityBase *obj)
 
void sensor_type_ (AsyncResponseStream *stream)
 Return the type for prometheus. More...
 
void sensor_row_ (AsyncResponseStream *stream, sensor::Sensor *obj)
 Return the sensor state as prometheus data point. More...
 
void binary_sensor_type_ (AsyncResponseStream *stream)
 Return the type for prometheus. More...
 
void binary_sensor_row_ (AsyncResponseStream *stream, binary_sensor::BinarySensor *obj)
 Return the sensor state as prometheus data point. More...
 
void fan_type_ (AsyncResponseStream *stream)
 Return the type for prometheus. More...
 
void fan_row_ (AsyncResponseStream *stream, fan::Fan *obj)
 Return the sensor state as prometheus data point. More...
 
void light_type_ (AsyncResponseStream *stream)
 Return the type for prometheus. More...
 
void light_row_ (AsyncResponseStream *stream, light::LightState *obj)
 Return the Light Values state as prometheus data point. More...
 
void cover_type_ (AsyncResponseStream *stream)
 Return the type for prometheus. More...
 
void cover_row_ (AsyncResponseStream *stream, cover::Cover *obj)
 Return the switch Values state as prometheus data point. More...
 
void switch_type_ (AsyncResponseStream *stream)
 Return the type for prometheus. More...
 
void switch_row_ (AsyncResponseStream *stream, switch_::Switch *obj)
 Return the switch Values state as prometheus data point. More...
 
void lock_type_ (AsyncResponseStream *stream)
 Return the type for prometheus. More...
 
void lock_row_ (AsyncResponseStream *stream, lock::Lock *obj)
 Return the lock Values state as prometheus data point. More...
 
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
virtual void call_setup ()
 
virtual void call_dump_config ()
 
void set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a unique name. More...
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const std::string &name)
 Cancel an interval function. More...
 
void set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult()> &&f, float backoff_increase_factor=1.0f)
 Set an retry function with a unique name. More...
 
void set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult()> &&f, float backoff_increase_factor=1.0f)
 
bool cancel_retry (const std::string &name)
 Cancel a retry function. More...
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name. More...
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (const std::string &name)
 Cancel a timeout function. More...
 
void defer (const std::string &name, std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
bool cancel_defer (const std::string &name)
 Cancel a defer callback using the specified name, name must not be empty. More...
 

Protected Attributes

web_server_base::WebServerBasebase_
 
bool include_internal_ {false}
 
std::map< EntityBase *, std::string > relabel_map_id_
 
std::map< EntityBase *, std::string > relabel_map_name_
 
- Protected Attributes inherited from esphome::Component
uint32_t component_state_ {0x0000}
 State of this component. More...
 
float setup_priority_override_ {NAN}
 
const char * component_source_ {nullptr}
 

Detailed Description

Definition at line 15 of file prometheus_handler.h.

Constructor & Destructor Documentation

◆ PrometheusHandler()

esphome::prometheus::PrometheusHandler::PrometheusHandler ( web_server_base::WebServerBase base)
inline

Definition at line 17 of file prometheus_handler.h.

Member Function Documentation

◆ add_label_id()

void esphome::prometheus::PrometheusHandler::add_label_id ( EntityBase obj,
const std::string &  value 
)
inline

Add the value for an entity's "id" label.

Parameters
objThe entity for which to set the "id" label
valueThe value for the "id" label

Definition at line 31 of file prometheus_handler.h.

◆ add_label_name()

void esphome::prometheus::PrometheusHandler::add_label_name ( EntityBase obj,
const std::string &  value 
)
inline

Add the value for an entity's "name" label.

Parameters
objThe entity for which to set the "name" label
valueThe value for the "name" label

Definition at line 38 of file prometheus_handler.h.

◆ binary_sensor_row_()

void esphome::prometheus::PrometheusHandler::binary_sensor_row_ ( AsyncResponseStream *  stream,
binary_sensor::BinarySensor obj 
)
protected

Return the sensor state as prometheus data point.

Definition at line 110 of file prometheus_handler.cpp.

◆ binary_sensor_type_()

void esphome::prometheus::PrometheusHandler::binary_sensor_type_ ( AsyncResponseStream *  stream)
protected

Return the type for prometheus.

Definition at line 106 of file prometheus_handler.cpp.

◆ canHandle()

bool esphome::prometheus::PrometheusHandler::canHandle ( AsyncWebServerRequest *  request)
inlineoverride

Definition at line 40 of file prometheus_handler.h.

◆ cover_row_()

void esphome::prometheus::PrometheusHandler::cover_row_ ( AsyncResponseStream *  stream,
cover::Cover obj 
)
protected

Return the switch Values state as prometheus data point.

Definition at line 267 of file prometheus_handler.cpp.

◆ cover_type_()

void esphome::prometheus::PrometheusHandler::cover_type_ ( AsyncResponseStream *  stream)
protected

Return the type for prometheus.

Definition at line 263 of file prometheus_handler.cpp.

◆ fan_row_()

void esphome::prometheus::PrometheusHandler::fan_row_ ( AsyncResponseStream *  stream,
fan::Fan obj 
)
protected

Return the sensor state as prometheus data point.

Definition at line 146 of file prometheus_handler.cpp.

◆ fan_type_()

void esphome::prometheus::PrometheusHandler::fan_type_ ( AsyncResponseStream *  stream)
protected

Return the type for prometheus.

Definition at line 140 of file prometheus_handler.cpp.

◆ get_setup_priority()

float esphome::prometheus::PrometheusHandler::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 55 of file prometheus_handler.h.

◆ handleRequest()

void esphome::prometheus::PrometheusHandler::handleRequest ( AsyncWebServerRequest *  req)
override

Definition at line 9 of file prometheus_handler.cpp.

◆ light_row_()

void esphome::prometheus::PrometheusHandler::light_row_ ( AsyncResponseStream *  stream,
light::LightState obj 
)
protected

Return the Light Values state as prometheus data point.

Definition at line 191 of file prometheus_handler.cpp.

◆ light_type_()

void esphome::prometheus::PrometheusHandler::light_type_ ( AsyncResponseStream *  stream)
protected

Return the type for prometheus.

Definition at line 186 of file prometheus_handler.cpp.

◆ lock_row_()

void esphome::prometheus::PrometheusHandler::lock_row_ ( AsyncResponseStream *  stream,
lock::Lock obj 
)
protected

Return the lock Values state as prometheus data point.

Definition at line 334 of file prometheus_handler.cpp.

◆ lock_type_()

void esphome::prometheus::PrometheusHandler::lock_type_ ( AsyncResponseStream *  stream)
protected

Return the type for prometheus.

Definition at line 330 of file prometheus_handler.cpp.

◆ relabel_id_()

std::string esphome::prometheus::PrometheusHandler::relabel_id_ ( EntityBase obj)
protected

Definition at line 57 of file prometheus_handler.cpp.

◆ relabel_name_()

std::string esphome::prometheus::PrometheusHandler::relabel_name_ ( EntityBase obj)
protected

Definition at line 62 of file prometheus_handler.cpp.

◆ sensor_row_()

void esphome::prometheus::PrometheusHandler::sensor_row_ ( AsyncResponseStream *  stream,
sensor::Sensor obj 
)
protected

Return the sensor state as prometheus data point.

Definition at line 73 of file prometheus_handler.cpp.

◆ sensor_type_()

void esphome::prometheus::PrometheusHandler::sensor_type_ ( AsyncResponseStream *  stream)
protected

Return the type for prometheus.

Definition at line 69 of file prometheus_handler.cpp.

◆ set_include_internal()

void esphome::prometheus::PrometheusHandler::set_include_internal ( bool  include_internal)
inline

Determine whether internal components should be exported as metrics.

Defaults to false.

Parameters
include_internalWhether internal components should be exported.

Definition at line 24 of file prometheus_handler.h.

◆ setup()

void esphome::prometheus::PrometheusHandler::setup ( )
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 51 of file prometheus_handler.h.

◆ switch_row_()

void esphome::prometheus::PrometheusHandler::switch_row_ ( AsyncResponseStream *  stream,
switch_::Switch obj 
)
protected

Return the switch Values state as prometheus data point.

Definition at line 310 of file prometheus_handler.cpp.

◆ switch_type_()

void esphome::prometheus::PrometheusHandler::switch_type_ ( AsyncResponseStream *  stream)
protected

Return the type for prometheus.

Definition at line 306 of file prometheus_handler.cpp.

Field Documentation

◆ base_

web_server_base::WebServerBase* esphome::prometheus::PrometheusHandler::base_
protected

Definition at line 113 of file prometheus_handler.h.

◆ include_internal_

bool esphome::prometheus::PrometheusHandler::include_internal_ {false}
protected

Definition at line 114 of file prometheus_handler.h.

◆ relabel_map_id_

std::map<EntityBase *, std::string> esphome::prometheus::PrometheusHandler::relabel_map_id_
protected

Definition at line 115 of file prometheus_handler.h.

◆ relabel_map_name_

std::map<EntityBase *, std::string> esphome::prometheus::PrometheusHandler::relabel_map_name_
protected

Definition at line 116 of file prometheus_handler.h.


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