ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
esphome::prometheus::PrometheusHandler Class Referencefinal

#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.
 
void add_label_id (EntityBase *obj, const std::string &value)
 Add the value for an entity's "id" label.
 
void add_label_name (EntityBase *obj, const std::string &value)
 Add the value for an entity's "name" label.
 
bool canHandle (AsyncWebServerRequest *request) const 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.
 
virtual void dump_config ()
 
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
void call ()
 
virtual void on_shutdown ()
 
virtual void on_safe_shutdown ()
 
virtual bool teardown ()
 Called during teardown to allow component to gracefully finish operations.
 
virtual void on_powerdown ()
 Called last before a reboot or deep sleep to power down hardware.
 
uint8_t get_component_state () const
 
void reset_to_construction_state ()
 Reset this component back to the construction state to allow setup to run again.
 
bool is_in_loop_state () const
 Check if this component has completed setup and is in the loop state.
 
bool is_idle () const
 Check if this component is idle.
 
void mark_failed ()
 Mark this component as failed.
 
void mark_failed (const LogString *message)
 
bool ESPHOME_ALWAYS_INLINE setup_check (bool ok)
 Marks the component failed with message (default "Communication failed") unless ok; returns ok.
 
bool ESPHOME_ALWAYS_INLINE setup_check (bool ok, const LogString *message)
 
void disable_loop ()
 Disable this component's loop.
 
void enable_loop ()
 Enable this component's loop.
 
void enable_loop_soon_any_context ()
 Thread and ISR-safe version of enable_loop() that can be called from any context.
 
bool is_failed () const
 
bool is_ready () const
 
virtual bool can_proceed ()
 
bool status_has_warning () const
 
bool status_has_error () const
 
void status_set_warning ()
 
void status_set_warning (const char *message)
 
void status_set_warning (const LogString *message)
 
bool status_comm_result (bool ok)
 Clears the warning when ok, else sets it with message (default "Communication failed"); returns ok.
 
bool status_comm_result (bool ok, const LogString *message)
 
void status_set_error ()
 
void status_set_error (const LogString *message)
 
void status_clear_warning ()
 
void status_clear_error ()
 
 ESPDEPRECATED ("Use status_momentary_warning() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_warning(const char *name
 
void status_momentary_warning (uint32_t length=5000)
 Set warning status flag and clear it after length ms.
 
void status_momentary_warning (const LogString *message, uint32_t length=5000)
 
 ESPDEPRECATED ("Use status_momentary_error() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_error(const char *name
 
void status_momentary_error (uint32_t length=5000)
 Set error status flag and clear it after length ms.
 
void status_momentary_error (const LogString *message, uint32_t length=5000)
 
bool has_overridden_loop () const
 
const LogString * get_component_log_str () const ESPHOME_ALWAYS_INLINE
 Get the integration where this component was declared as a LogString for logging.
 
bool should_warn_of_blocking (uint32_t blocking_time, uint32_t &threshold_ms_out)
 

Protected Member Functions

void print_relabel_id_ (AsyncResponseStream *stream, EntityBase *obj)
 
void print_relabel_name_ (AsyncResponseStream *stream, EntityBase *obj)
 
void add_area_label_ (AsyncResponseStream *stream, std::string &area)
 
void add_node_label_ (AsyncResponseStream *stream, std::string &node)
 
void add_friendly_name_label_ (AsyncResponseStream *stream, std::string &friendly_name)
 
void print_metric_labels_ (AsyncResponseStream *stream, ProgmemStr metric_name, EntityBase *obj, std::string &area, std::string &node, std::string &friendly_name)
 Print metric name and common labels (id, area, node, friendly_name, name)
 
void sensor_type_ (AsyncResponseStream *stream)
 Return the type for prometheus.
 
void sensor_row_ (AsyncResponseStream *stream, sensor::Sensor *obj, std::string &area, std::string &node, std::string &friendly_name)
 Return the sensor state as prometheus data point.
 
void binary_sensor_type_ (AsyncResponseStream *stream)
 Return the type for prometheus.
 
void binary_sensor_row_ (AsyncResponseStream *stream, binary_sensor::BinarySensor *obj, std::string &area, std::string &node, std::string &friendly_name)
 Return the binary sensor state as prometheus data point.
 
void fan_type_ (AsyncResponseStream *stream)
 Return the type for prometheus.
 
void fan_row_ (AsyncResponseStream *stream, fan::Fan *obj, std::string &area, std::string &node, std::string &friendly_name)
 Return the fan state as prometheus data point.
 
void light_type_ (AsyncResponseStream *stream)
 Return the type for prometheus.
 
void light_row_ (AsyncResponseStream *stream, light::LightState *obj, std::string &area, std::string &node, std::string &friendly_name)
 Return the light values state as prometheus data point.
 
void cover_type_ (AsyncResponseStream *stream)
 Return the type for prometheus.
 
void cover_row_ (AsyncResponseStream *stream, cover::Cover *obj, std::string &area, std::string &node, std::string &friendly_name)
 Return the cover values state as prometheus data point.
 
void switch_type_ (AsyncResponseStream *stream)
 Return the type for prometheus.
 
void switch_row_ (AsyncResponseStream *stream, switch_::Switch *obj, std::string &area, std::string &node, std::string &friendly_name)
 Return the switch values state as prometheus data point.
 
void lock_type_ (AsyncResponseStream *stream)
 Return the type for prometheus.
 
void lock_row_ (AsyncResponseStream *stream, lock::Lock *obj, std::string &area, std::string &node, std::string &friendly_name)
 Return the lock values state as prometheus data point.
 
void event_type_ (AsyncResponseStream *stream)
 Return the type for prometheus.
 
void event_row_ (AsyncResponseStream *stream, event::Event *obj, std::string &area, std::string &node, std::string &friendly_name)
 Return the event values state as prometheus data point.
 
void text_type_ (AsyncResponseStream *stream)
 Return the type for prometheus.
 
void text_row_ (AsyncResponseStream *stream, text::Text *obj, std::string &area, std::string &node, std::string &friendly_name)
 Return the text values state as prometheus data point.
 
void text_sensor_type_ (AsyncResponseStream *stream)
 Return the type for prometheus.
 
void text_sensor_row_ (AsyncResponseStream *stream, text_sensor::TextSensor *obj, std::string &area, std::string &node, std::string &friendly_name)
 Return the text sensor values state as prometheus data point.
 
void number_type_ (AsyncResponseStream *stream)
 Return the type for prometheus.
 
void number_row_ (AsyncResponseStream *stream, number::Number *obj, std::string &area, std::string &node, std::string &friendly_name)
 Return the number state as prometheus data point.
 
void select_type_ (AsyncResponseStream *stream)
 Return the type for prometheus.
 
void select_row_ (AsyncResponseStream *stream, select::Select *obj, std::string &area, std::string &node, std::string &friendly_name)
 Return the select state as prometheus data point.
 
void media_player_type_ (AsyncResponseStream *stream)
 Return the type for prometheus.
 
void media_player_row_ (AsyncResponseStream *stream, media_player::MediaPlayer *obj, std::string &area, std::string &node, std::string &friendly_name)
 Return the media player state as prometheus data point.
 
void update_entity_type_ (AsyncResponseStream *stream)
 Return the type for prometheus.
 
void update_entity_row_ (AsyncResponseStream *stream, update::UpdateEntity *obj, std::string &area, std::string &node, std::string &friendly_name)
 Return the update state and info as prometheus data point.
 
void handle_update_state_ (AsyncResponseStream *stream, update::UpdateState state)
 
void valve_type_ (AsyncResponseStream *stream)
 Return the type for prometheus.
 
void valve_row_ (AsyncResponseStream *stream, valve::Valve *obj, std::string &area, std::string &node, std::string &friendly_name)
 Return the valve state as prometheus data point.
 
void date_time_rows_ (AsyncResponseStream *stream, ProgmemStr failed_metric, ProgmemStr value_metric, EntityBase *obj, int64_t value_ms, std::string &area, std::string &node, std::string &friendly_name)
 Print the failed row and, when the entity has a state, the value row in milliseconds.
 
void date_type_ (AsyncResponseStream *stream)
 Return the type for prometheus.
 
void date_row_ (AsyncResponseStream *stream, datetime::DateEntity *obj, std::string &area, std::string &node, std::string &friendly_name)
 Return the date state as prometheus data point.
 
void time_type_ (AsyncResponseStream *stream)
 Return the type for prometheus.
 
void time_row_ (AsyncResponseStream *stream, datetime::TimeEntity *obj, std::string &area, std::string &node, std::string &friendly_name)
 Return the time state as prometheus data point.
 
void datetime_type_ (AsyncResponseStream *stream)
 Return the type for prometheus.
 
void datetime_row_ (AsyncResponseStream *stream, datetime::DateTimeEntity *obj, std::string &area, std::string &node, std::string &friendly_name)
 Return the datetime state as prometheus data point.
 
void climate_type_ (AsyncResponseStream *stream)
 Return the type for prometheus.
 
void climate_row_ (AsyncResponseStream *stream, climate::Climate *obj, std::string &area, std::string &node, std::string &friendly_name)
 Return the climate state as prometheus data point.
 
void climate_failed_row_ (AsyncResponseStream *stream, climate::Climate *obj, std::string &area, std::string &node, std::string &friendly_name, std::string &category, bool is_failed_value)
 
void climate_setting_row_ (AsyncResponseStream *stream, climate::Climate *obj, std::string &area, std::string &node, std::string &friendly_name, std::string &setting, const LogString *setting_value)
 
void climate_value_row_ (AsyncResponseStream *stream, climate::Climate *obj, std::string &area, std::string &node, std::string &friendly_name, std::string &category, const char *climate_value)
 
- Protected Member Functions inherited from esphome::Component
friend void::setup ()
 
friend void::original_setup ()
 
void set_component_source_ (uint8_t index)
 Set where this component was loaded from for some debug messages.
 
virtual void call_setup ()
 
void call_dump_config_ ()
 
void enable_loop_slow_path_ ()
 
void set_component_state_ (uint8_t state)
 Helper to set component state (clears state bits and sets new state)
 
bool set_status_flag_ (uint8_t flag)
 Helper to set a status LED flag on both this component and the app.
 
bool set_error_flag_ (const LogString *message)
 Set the error flag and log it; true when it was not set before.
 
void set_interval (const char *name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a const char* name.
 
void set_interval (uint32_t id, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a numeric ID (zero heap allocation).
 
void set_interval (InternalSchedulerID id, uint32_t interval, std::function< void()> &&f)
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const char *name)
 Cancel an interval function.
 
bool cancel_interval (uint32_t id)
 
bool cancel_interval (InternalSchedulerID id)
 
void set_timeout (const char *name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a const char* name.
 
void set_timeout (uint32_t id, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a numeric ID (zero heap allocation).
 
void set_timeout (InternalSchedulerID id, uint32_t timeout, std::function< void()> &&f)
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (const char *name)
 Cancel a timeout function.
 
bool cancel_timeout (uint32_t id)
 
bool cancel_timeout (InternalSchedulerID id)
 
void defer (const char *name, std::function< void()> &&f)
 Defer a callback to the next loop() call with a const char* name.
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call.
 
void defer (uint32_t id, std::function< void()> &&f)
 Defer a callback with a numeric ID (zero heap allocation)
 
bool cancel_defer (const char *name)
 Cancel a defer callback using the specified name, name must not be empty.
 
bool cancel_defer (uint32_t id)
 
void status_clear_warning_slow_path_ ()
 
void status_clear_error_slow_path_ ()
 

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_
 
- Protected Attributes inherited from esphome::Component
uint8_t component_source_index_ {0}
 Index into component source PROGMEM lookup table (0 = not set)
 
uint8_t warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_CS}
 Warn threshold in centiseconds (max 2550ms)
 
uint8_t component_state_ {0x00}
 State of this component - each bit has a purpose: Bits 0-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bit 5: Has overridden loop() (set at registration time) Bits 6-7: Unused - reserved for future expansion.
 
volatile bool pending_enable_loop_ {false}
 ISR-safe flag for enable_loop_soon_any_context.
 
ComponentRuntimeStats runtime_stats_
 

Additional Inherited Members

- Data Fields inherited from esphome::Component
uint32_t length = 5000)
 

Detailed Description

Definition at line 18 of file prometheus_handler.h.

Constructor & Destructor Documentation

◆ PrometheusHandler()

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

Definition at line 20 of file prometheus_handler.h.

Member Function Documentation

◆ add_area_label_()

void esphome::prometheus::PrometheusHandler::add_area_label_ ( AsyncResponseStream * stream,
std::string & area )
protected

Definition at line 150 of file prometheus_handler.cpp.

◆ add_friendly_name_label_()

void esphome::prometheus::PrometheusHandler::add_friendly_name_label_ ( AsyncResponseStream * stream,
std::string & friendly_name )
protected

Definition at line 164 of file prometheus_handler.cpp.

◆ 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 34 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 41 of file prometheus_handler.h.

◆ add_node_label_()

void esphome::prometheus::PrometheusHandler::add_node_label_ ( AsyncResponseStream * stream,
std::string & node )
protected

Definition at line 157 of file prometheus_handler.cpp.

◆ binary_sensor_row_()

void esphome::prometheus::PrometheusHandler::binary_sensor_row_ ( AsyncResponseStream * stream,
binary_sensor::BinarySensor * obj,
std::string & area,
std::string & node,
std::string & friendly_name )
protected

Return the binary sensor state as prometheus data point.

Definition at line 238 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 234 of file prometheus_handler.cpp.

◆ canHandle()

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

Definition at line 43 of file prometheus_handler.h.

◆ climate_failed_row_()

void esphome::prometheus::PrometheusHandler::climate_failed_row_ ( AsyncResponseStream * stream,
climate::Climate * obj,
std::string & area,
std::string & node,
std::string & friendly_name,
std::string & category,
bool is_failed_value )
protected

Definition at line 991 of file prometheus_handler.cpp.

◆ climate_row_()

void esphome::prometheus::PrometheusHandler::climate_row_ ( AsyncResponseStream * stream,
climate::Climate * obj,
std::string & area,
std::string & node,
std::string & friendly_name )
protected

Return the climate state as prometheus data point.

Definition at line 1012 of file prometheus_handler.cpp.

◆ climate_setting_row_()

void esphome::prometheus::PrometheusHandler::climate_setting_row_ ( AsyncResponseStream * stream,
climate::Climate * obj,
std::string & area,
std::string & node,
std::string & friendly_name,
std::string & setting,
const LogString * setting_value )
protected

Definition at line 951 of file prometheus_handler.cpp.

◆ climate_type_()

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

Return the type for prometheus.

Definition at line 945 of file prometheus_handler.cpp.

◆ climate_value_row_()

void esphome::prometheus::PrometheusHandler::climate_value_row_ ( AsyncResponseStream * stream,
climate::Climate * obj,
std::string & area,
std::string & node,
std::string & friendly_name,
std::string & category,
const char * climate_value )
protected

Definition at line 974 of file prometheus_handler.cpp.

◆ cover_row_()

void esphome::prometheus::PrometheusHandler::cover_row_ ( AsyncResponseStream * stream,
cover::Cover * obj,
std::string & area,
std::string & node,
std::string & friendly_name )
protected

Return the cover values state as prometheus data point.

Definition at line 405 of file prometheus_handler.cpp.

◆ cover_type_()

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

Return the type for prometheus.

Definition at line 401 of file prometheus_handler.cpp.

◆ date_row_()

void esphome::prometheus::PrometheusHandler::date_row_ ( AsyncResponseStream * stream,
datetime::DateEntity * obj,
std::string & area,
std::string & node,
std::string & friendly_name )
protected

Return the date state as prometheus data point.

Definition at line 1143 of file prometheus_handler.cpp.

◆ date_time_rows_()

void esphome::prometheus::PrometheusHandler::date_time_rows_ ( AsyncResponseStream * stream,
ProgmemStr failed_metric,
ProgmemStr value_metric,
EntityBase * obj,
int64_t value_ms,
std::string & area,
std::string & node,
std::string & friendly_name )
protected

Print the failed row and, when the entity has a state, the value row in milliseconds.

Definition at line 1119 of file prometheus_handler.cpp.

◆ date_type_()

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

Return the type for prometheus.

Definition at line 1139 of file prometheus_handler.cpp.

◆ datetime_row_()

void esphome::prometheus::PrometheusHandler::datetime_row_ ( AsyncResponseStream * stream,
datetime::DateTimeEntity * obj,
std::string & area,
std::string & node,
std::string & friendly_name )
protected

Return the datetime state as prometheus data point.

Definition at line 1180 of file prometheus_handler.cpp.

◆ datetime_type_()

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

Return the type for prometheus.

Definition at line 1176 of file prometheus_handler.cpp.

◆ event_row_()

void esphome::prometheus::PrometheusHandler::event_row_ ( AsyncResponseStream * stream,
event::Event * obj,
std::string & area,
std::string & node,
std::string & friendly_name )
protected

Return the event values state as prometheus data point.

Definition at line 618 of file prometheus_handler.cpp.

◆ event_type_()

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

Return the type for prometheus.

Definition at line 614 of file prometheus_handler.cpp.

◆ fan_row_()

void esphome::prometheus::PrometheusHandler::fan_row_ ( AsyncResponseStream * stream,
fan::Fan * obj,
std::string & area,
std::string & node,
std::string & friendly_name )
protected

Return the fan state as prometheus data point.

Definition at line 284 of file prometheus_handler.cpp.

◆ fan_type_()

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

Return the type for prometheus.

Definition at line 278 of file prometheus_handler.cpp.

◆ get_setup_priority()

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

Reimplemented from esphome::Component.

Definition at line 60 of file prometheus_handler.h.

◆ handle_update_state_()

void esphome::prometheus::PrometheusHandler::handle_update_state_ ( AsyncResponseStream * stream,
update::UpdateState state )
protected

Definition at line 818 of file prometheus_handler.cpp.

◆ handleRequest()

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

Definition at line 8 of file prometheus_handler.cpp.

◆ light_row_()

void esphome::prometheus::PrometheusHandler::light_row_ ( AsyncResponseStream * stream,
light::LightState * obj,
std::string & area,
std::string & node,
std::string & friendly_name )
protected

Return the light values state as prometheus data point.

Definition at line 342 of file prometheus_handler.cpp.

◆ light_type_()

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

Return the type for prometheus.

Definition at line 337 of file prometheus_handler.cpp.

◆ lock_row_()

void esphome::prometheus::PrometheusHandler::lock_row_ ( AsyncResponseStream * stream,
lock::Lock * obj,
std::string & area,
std::string & node,
std::string & friendly_name )
protected

Return the lock values state as prometheus data point.

Definition at line 492 of file prometheus_handler.cpp.

◆ lock_type_()

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

Return the type for prometheus.

Definition at line 488 of file prometheus_handler.cpp.

◆ media_player_row_()

void esphome::prometheus::PrometheusHandler::media_player_row_ ( AsyncResponseStream * stream,
media_player::MediaPlayer * obj,
std::string & area,
std::string & node,
std::string & friendly_name )
protected

Return the media player state as prometheus data point.

Definition at line 759 of file prometheus_handler.cpp.

◆ media_player_type_()

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

Return the type for prometheus.

Definition at line 753 of file prometheus_handler.cpp.

◆ number_row_()

void esphome::prometheus::PrometheusHandler::number_row_ ( AsyncResponseStream * stream,
number::Number * obj,
std::string & area,
std::string & node,
std::string & friendly_name )
protected

Return the number state as prometheus data point.

Definition at line 666 of file prometheus_handler.cpp.

◆ number_type_()

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

Return the type for prometheus.

Definition at line 662 of file prometheus_handler.cpp.

◆ print_metric_labels_()

void esphome::prometheus::PrometheusHandler::print_metric_labels_ ( AsyncResponseStream * stream,
ProgmemStr metric_name,
EntityBase * obj,
std::string & area,
std::string & node,
std::string & friendly_name )
protected

Print metric name and common labels (id, area, node, friendly_name, name)

Definition at line 171 of file prometheus_handler.cpp.

◆ print_relabel_id_()

void esphome::prometheus::PrometheusHandler::print_relabel_id_ ( AsyncResponseStream * stream,
EntityBase * obj )
protected

Definition at line 131 of file prometheus_handler.cpp.

◆ print_relabel_name_()

void esphome::prometheus::PrometheusHandler::print_relabel_name_ ( AsyncResponseStream * stream,
EntityBase * obj )
protected

Definition at line 141 of file prometheus_handler.cpp.

◆ select_row_()

void esphome::prometheus::PrometheusHandler::select_row_ ( AsyncResponseStream * stream,
select::Select * obj,
std::string & area,
std::string & node,
std::string & friendly_name )
protected

Return the select state as prometheus data point.

Definition at line 710 of file prometheus_handler.cpp.

◆ select_type_()

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

Return the type for prometheus.

Definition at line 706 of file prometheus_handler.cpp.

◆ sensor_row_()

void esphome::prometheus::PrometheusHandler::sensor_row_ ( AsyncResponseStream * stream,
sensor::Sensor * obj,
std::string & area,
std::string & node,
std::string & friendly_name )
protected

Return the sensor state as prometheus data point.

Definition at line 189 of file prometheus_handler.cpp.

◆ sensor_type_()

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

Return the type for prometheus.

Definition at line 185 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 27 of file prometheus_handler.h.

◆ setup()

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

Reimplemented from esphome::Component.

Definition at line 56 of file prometheus_handler.h.

◆ switch_row_()

void esphome::prometheus::PrometheusHandler::switch_row_ ( AsyncResponseStream * stream,
switch_::Switch * obj,
std::string & area,
std::string & node,
std::string & friendly_name )
protected

Return the switch values state as prometheus data point.

Definition at line 461 of file prometheus_handler.cpp.

◆ switch_type_()

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

Return the type for prometheus.

Definition at line 457 of file prometheus_handler.cpp.

◆ text_row_()

void esphome::prometheus::PrometheusHandler::text_row_ ( AsyncResponseStream * stream,
text::Text * obj,
std::string & area,
std::string & node,
std::string & friendly_name )
protected

Return the text values state as prometheus data point.

Definition at line 571 of file prometheus_handler.cpp.

◆ text_sensor_row_()

void esphome::prometheus::PrometheusHandler::text_sensor_row_ ( AsyncResponseStream * stream,
text_sensor::TextSensor * obj,
std::string & area,
std::string & node,
std::string & friendly_name )
protected

Return the text sensor values state as prometheus data point.

Definition at line 524 of file prometheus_handler.cpp.

◆ text_sensor_type_()

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

Return the type for prometheus.

Definition at line 520 of file prometheus_handler.cpp.

◆ text_type_()

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

Return the type for prometheus.

Definition at line 567 of file prometheus_handler.cpp.

◆ time_row_()

void esphome::prometheus::PrometheusHandler::time_row_ ( AsyncResponseStream * stream,
datetime::TimeEntity * obj,
std::string & area,
std::string & node,
std::string & friendly_name )
protected

Return the time state as prometheus data point.

Definition at line 1165 of file prometheus_handler.cpp.

◆ time_type_()

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

Return the type for prometheus.

Definition at line 1161 of file prometheus_handler.cpp.

◆ update_entity_row_()

void esphome::prometheus::PrometheusHandler::update_entity_row_ ( AsyncResponseStream * stream,
update::UpdateEntity * obj,
std::string & area,
std::string & node,
std::string & friendly_name )
protected

Return the update state and info as prometheus data point.

Definition at line 838 of file prometheus_handler.cpp.

◆ update_entity_type_()

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

Return the type for prometheus.

Definition at line 812 of file prometheus_handler.cpp.

◆ valve_row_()

void esphome::prometheus::PrometheusHandler::valve_row_ ( AsyncResponseStream * stream,
valve::Valve * obj,
std::string & area,
std::string & node,
std::string & friendly_name )
protected

Return the valve state as prometheus data point.

Definition at line 903 of file prometheus_handler.cpp.

◆ valve_type_()

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

Return the type for prometheus.

Definition at line 897 of file prometheus_handler.cpp.

Field Documentation

◆ base_

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

Definition at line 240 of file prometheus_handler.h.

◆ include_internal_

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

Definition at line 241 of file prometheus_handler.h.

◆ relabel_map_id_

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

Definition at line 242 of file prometheus_handler.h.

◆ relabel_map_name_

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

Definition at line 243 of file prometheus_handler.h.


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