#include <prometheus_handler.h>

Inheritance diagram for esphome::prometheus::PrometheusHandler:

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)

virtual float	get_loop_priority () const
	priority of loop().

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 after teardown is complete 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.

virtual void	mark_failed ()
	Mark this component as failed.

	ESPDEPRECATED ("Use mark_failed(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void mark_failed(const char *message)

void	mark_failed (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 (const char *message=nullptr)

void	status_set_warning (const LogString *message)

void	status_set_error ()

	ESPDEPRECATED ("Use status_set_error(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void status_set_error(const char *message)

void	status_set_error (const LogString *message)

void	status_clear_warning ()

void	status_clear_error ()

void	status_momentary_warning (const char *name, uint32_t length=5000)
	Set warning status flag and automatically clear it after a timeout.

void	status_momentary_error (const char *name, uint32_t length=5000)
	Set error status flag and automatically clear it after a timeout.

bool	has_overridden_loop () const

void	set_component_source (const LogString *source)
	Set where this component was loaded from for some debug messages.

const LogString *	get_component_log_str () const
	Get the integration where this component was declared as a LogString for logging.

bool	should_warn_of_blocking (uint32_t blocking_time)

Protected Member Functions
std::string	relabel_id_ (EntityBase *obj)

std::string	relabel_name_ (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, const __FlashStringHelper 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	print_metric_labels_ (AsyncResponseStream stream, const char metric_name, EntityBase *obj, std::string &area, std::string &node, std::string &friendly_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	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
virtual void	call_loop ()

virtual void	call_setup ()

virtual void	call_dump_config ()

void	set_component_state_ (uint8_t state)
	Helper to set component state (clears state bits and sets new state)

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 (uint32_t id)

bool	cancel_interval (InternalSchedulerID id)

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std	ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const char *name

	ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(uint32_t id

	ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(uint32_t initial_wait_time

ESPDEPRECATED("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(const std	ESPDEPRECATED ("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(const char *name)

	ESPDEPRECATED ("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(uint32_t id)

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 (uint32_t id)

bool	cancel_timeout (InternalSchedulerID id)

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 (uint32_t id)

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
ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_interval(const std voi	set_interval )(const char *name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a unique name.

ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_interval(const std boo	cancel_interval )(const char *name)
	Cancel an interval function.

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t	initial_wait_time

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t	max_attempts

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t std::function< RetryResult(uint8_t)> &&	f

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t std::function< RetryResult(uint8_t)> float	backoff_increase_factor = 1.0f)

uint32_t	initial_wait_time

uint32_t uint8_t	max_attempts

uint32_t uint8_t std::function< RetryResult(uint8_t)> &&	f

uint32_t uint8_t std::function< RetryResult(uint8_t)> float	backoff_increase_factor = 1.0f)

uint8_t	max_attempts

uint8_t std::function< RetryResult(uint8_t)> &&	f

uint8_t std::function< RetryResult(uint8_t)> float	backoff_increase_factor = 1.0f)

ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_timeout(const std voi	set_timeout )(const char *name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a unique name.

ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_timeout(const std boo	cancel_timeout )(const char *name)
	Cancel a timeout function.

ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") void defer(const std voi	defer )(const char *name, std::function< void()> &&f)
	Defer a callback to the next loop() call.

ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_defer(const std boo	cancel_defer )(const char *name)
	Cancel a defer callback using the specified name, name must not be empty.

const LogString *	component_source_ {nullptr}

uint16_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS}
	Warn if blocked for this many ms (max 65.5s)

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 Bits 5-7: Unused - reserved for future expansion.

volatile bool	pending_enable_loop_ {false}
	ISR-safe flag for enable_loop_soon_any_context.

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

◆ add_friendly_name_label_()

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

protected

◆ 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

obj	The entity for which to set the "id" label
value	The 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

obj	The entity for which to set the "name" label
value	The 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

◆ 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.

◆ binary_sensor_type_()

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

protected

Return the type for prometheus.

◆ 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

◆ 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.

◆ 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

◆ climate_type_()

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

protected

Return the type for prometheus.

◆ 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

◆ 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.

◆ cover_type_()

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

protected

Return the type for prometheus.

◆ 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.

◆ event_type_()

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

protected

Return the type for prometheus.

◆ 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.

◆ fan_type_()

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

protected

Return the type for prometheus.

◆ 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

◆ handleRequest()

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

override

◆ 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.

◆ light_type_()

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

protected

Return the type for prometheus.

◆ 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.

◆ lock_type_()

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

protected

Return the type for prometheus.

◆ 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.

◆ media_player_type_()

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

protected

Return the type for prometheus.

◆ 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.

◆ number_type_()

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

protected

Return the type for prometheus.

◆ print_metric_labels_() [1/2]

void esphome::prometheus::PrometheusHandler::print_metric_labels_	(	AsyncResponseStream *	stream,
		const __FlashStringHelper *	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)

◆ print_metric_labels_() [2/2]

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

protected

◆ relabel_id_()

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

protected

◆ relabel_name_()

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

protected

◆ 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.

◆ select_type_()

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

protected

Return the type for prometheus.

◆ 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.

◆ sensor_type_()

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

protected

Return the type for prometheus.

◆ 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_internal Whether 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.

◆ switch_type_()

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

protected

Return the type for prometheus.

◆ 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.

◆ 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.

◆ text_sensor_type_()

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

protected

Return the type for prometheus.

◆ text_type_()

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

protected

Return the type for prometheus.

◆ 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.

◆ update_entity_type_()

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

protected

Return the type for prometheus.

◆ 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.

◆ valve_type_()

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

protected

Return the type for prometheus.

Field Documentation

◆ base_

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

protected

Definition at line 215 of file prometheus_handler.h.

◆ include_internal_

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

protected

Definition at line 216 of file prometheus_handler.h.

◆ relabel_map_id_

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

protected

Definition at line 217 of file prometheus_handler.h.

◆ relabel_map_name_

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

protected

Definition at line 218 of file prometheus_handler.h.

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

esphome/components/prometheus/prometheus_handler.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PrometheusHandler()

Member Function Documentation

◆ add_area_label_()

◆ add_friendly_name_label_()

◆ add_label_id()

◆ add_label_name()

◆ add_node_label_()

◆ binary_sensor_row_()

◆ binary_sensor_type_()

◆ canHandle()

◆ climate_failed_row_()

◆ climate_row_()

◆ climate_setting_row_()

◆ climate_type_()

◆ climate_value_row_()

◆ cover_row_()

◆ cover_type_()

◆ event_row_()

◆ event_type_()

◆ fan_row_()

◆ fan_type_()

◆ get_setup_priority()

◆ handle_update_state_()

◆ handleRequest()

◆ light_row_()

◆ light_type_()

◆ lock_row_()

◆ lock_type_()

◆ media_player_row_()

◆ media_player_type_()

◆ number_row_()

◆ number_type_()

◆ print_metric_labels_() [1/2]

◆ print_metric_labels_() [2/2]

◆ relabel_id_()

◆ relabel_name_()

◆ select_row_()

◆ select_type_()

◆ sensor_row_()

◆ sensor_type_()

◆ set_include_internal()

◆ setup()

◆ switch_row_()

◆ switch_type_()

◆ text_row_()

◆ text_sensor_row_()

◆ text_sensor_type_()

◆ text_type_()

◆ update_entity_row_()

◆ update_entity_type_()

◆ valve_row_()

◆ valve_type_()

Field Documentation

◆ base_

◆ include_internal_

◆ relabel_map_id_

◆ relabel_map_name_