Prometheus Component

The prometheus component enables an HTTP endpoint for the Web Server Component in order to integrate a Prometheus installation.

This can be used to scrape data directly into your Prometheus-based monitoring and alerting-system, without the need of any other software.

The list of available metrics can be found by directly browsing your node under <ip or node_name.local>/metrics, and may be increased in the future.

# Example configuration entry

# Activates prometheus /metrics endpoint

Configuration variables:

  • id (Optional, ID): Manually specify the ID used for code generation.

  • include_internal (Optional, boolean): Whether internal entities should be displayed on the web interface. Defaults to false.


Example integration into the configuration of your prometheus:

  - job_name: esphome
      - targets: [<ip or node_name.local>]

See Also