ESPHome
2023.8.3
|
#include <prometheus_handler.h>
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 |
![]() | |
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 () |
bool | is_ready () |
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... | |
![]() | |
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(uint8_t)> &&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(uint8_t)> &&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::WebServerBase * | base_ |
bool | include_internal_ {false} |
std::map< EntityBase *, std::string > | relabel_map_id_ |
std::map< EntityBase *, std::string > | relabel_map_name_ |
![]() | |
uint32_t | component_state_ {0x0000} |
State of this component. More... | |
float | setup_priority_override_ {NAN} |
const char * | component_source_ {nullptr} |
Definition at line 16 of file prometheus_handler.h.
|
inline |
Definition at line 18 of file prometheus_handler.h.
|
inline |
Add the value for an entity's "id" label.
obj | The entity for which to set the "id" label |
value | The value for the "id" label |
Definition at line 32 of file prometheus_handler.h.
|
inline |
Add the value for an entity's "name" label.
obj | The entity for which to set the "name" label |
value | The value for the "name" label |
Definition at line 39 of file prometheus_handler.h.
|
protected |
Return the sensor state as prometheus data point.
Definition at line 110 of file prometheus_handler.cpp.
|
protected |
Return the type for prometheus.
Definition at line 106 of file prometheus_handler.cpp.
|
inlineoverride |
Definition at line 41 of file prometheus_handler.h.
|
protected |
Return the switch Values state as prometheus data point.
Definition at line 267 of file prometheus_handler.cpp.
|
protected |
Return the type for prometheus.
Definition at line 263 of file prometheus_handler.cpp.
|
protected |
Return the sensor state as prometheus data point.
Definition at line 146 of file prometheus_handler.cpp.
|
protected |
Return the type for prometheus.
Definition at line 140 of file prometheus_handler.cpp.
|
inlineoverridevirtual |
Reimplemented from esphome::Component.
Definition at line 56 of file prometheus_handler.h.
|
override |
Definition at line 9 of file prometheus_handler.cpp.
|
protected |
Return the Light Values state as prometheus data point.
Definition at line 191 of file prometheus_handler.cpp.
|
protected |
Return the type for prometheus.
Definition at line 186 of file prometheus_handler.cpp.
|
protected |
Return the lock Values state as prometheus data point.
Definition at line 334 of file prometheus_handler.cpp.
|
protected |
Return the type for prometheus.
Definition at line 330 of file prometheus_handler.cpp.
|
protected |
Definition at line 57 of file prometheus_handler.cpp.
|
protected |
Definition at line 62 of file prometheus_handler.cpp.
|
protected |
Return the sensor state as prometheus data point.
Definition at line 73 of file prometheus_handler.cpp.
|
protected |
Return the type for prometheus.
Definition at line 69 of file prometheus_handler.cpp.
|
inline |
Determine whether internal components should be exported as metrics.
Defaults to false.
include_internal | Whether internal components should be exported. |
Definition at line 25 of file prometheus_handler.h.
|
inlineoverridevirtual |
Reimplemented from esphome::Component.
Definition at line 52 of file prometheus_handler.h.
|
protected |
Return the switch Values state as prometheus data point.
Definition at line 310 of file prometheus_handler.cpp.
|
protected |
Return the type for prometheus.
Definition at line 306 of file prometheus_handler.cpp.
|
protected |
Definition at line 114 of file prometheus_handler.h.
|
protected |
Definition at line 115 of file prometheus_handler.h.
|
protected |
Definition at line 116 of file prometheus_handler.h.
|
protected |
Definition at line 117 of file prometheus_handler.h.