home-assistant.io/source/_components/netdata.markdown

layout	title	description	date	sidebar	comments	sharing	footer	logo	ha_category	ha_release	ha_iot_class	redirect_from
page	Netdata	Instructions on how to integrate Netdata within Home Assistant.	2016-12-05 07:00	true	false	true	true	netdata.png	System Monitor	0.35	Local Polling	/components/sensor.netdata/

The netdata sensor platform allows you to display information collected by Netdata.

{% linkable_title Setup %}

Getting the details to configure the sensors is a bit tricky as Netdata uses different name for the element: value that is required. To get the value for the data_group: use Netdata's web interface. 1. marks the name for the data_group:. 2. are the names for the element to show in Home Assistant. The name that is shown can be different than the name under which the metrics are available.

To check if the element: name matches the name in the Netdata frontend, use curl with the IP address of your Netdata instance, its port and the data_group:

$ curl -X GET "http://[Netdata_Instance]:19999/api/v1/data?chart=[data_group]&points=2&options=jsonwrap"
{
   "api": 1,
   "id": "system.ipv4",
   "name": "system.ipv4",
[...]
   "dimension_names": ["received", "sent"],
   "dimension_ids": ["InOctets", "OutOctets"],
[...]

• dimension_names: Names shown in the frontend.
• dimension_ids: Names to use for element.

{% linkable_title Configuration %}

To add this platform to your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
sensor:
  - platform: netdata
    resources:
      load:
        data_group: system.load
        element: load15
      cpu:
        data_group: system.cpu
        element: system

{% configuration %} host: description: The IP address or hostname of your Netdata instance. required: false type: string default: localhost port: description: The port that the Netdata instance is running on. required: false type: integer default: 19999 name: description: Name of the monitored Netdata instance. required: false type: number default: Netdata resources: description: List of details to monitor. required: true type: map keys: name: description: Name to use for the sensor in the frontend. required: true type: string keys: data_group: description: "Name of the data group to monitor, e.g., system.cpu." required: true type: string element: description: The element of the group to monitor. required: true type: string icon: description: Icon to use for the sensor. required: false type: icon default: "mdi:desktop-classic" invert: description: Invert the sensor values. required: false type: boolean default: false {% endconfiguration %}