Skip to content

Commit be8af2b

Browse files
authored
Add more details for the setup (home-assistant#5528)
* Add more details for the setup * Rephrase
1 parent fdaa434 commit be8af2b

File tree

2 files changed

+25
-1
lines changed

2 files changed

+25
-1
lines changed

source/_components/sensor.netdata.markdown

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,34 @@ ha_iot_class: "Local Polling"
1616

1717
The `netdata` sensor platform allows you to display information collected by [Netdata](http://my-netdata.io/).
1818

19-
## {% linkable_title Configuration %}
19+
## {% linkable_title Setup %}
20+
21+
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.
22+
23+
<p class='img'>
24+
<img src='{{site_root}}/images/components/netdata/details.png' />
25+
</p>
26+
27+
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`:
2028

29+
```bash
30+
$ curl -X GET "http://[Netdata_Instance]:19999/api/v1/data?chart=[data_group]&points=2&options=jsonwrap"
31+
{
32+
"api": 1,
33+
"id": "system.ipv4",
34+
"name": "system.ipv4",
35+
[...]
36+
"dimension_names": ["received", "sent"],
37+
"dimension_ids": ["InOctets", "OutOctets"],
38+
[...]
39+
```
40+
41+
- `dimension_names`: Names shown in the frontend.
42+
- `dimension_ids`: Names to use for `element`.
2143
2244
45+
## {% linkable_title Configuration %}
46+
2347
To add this platform to your installation, add the following to your `configuration.yaml` file:
2448
2549
```yaml
35 KB
Loading

0 commit comments

Comments
 (0)