Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated Netdata documentation #9606

Merged
merged 8 commits into from
Jun 16, 2019
Merged
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 54 additions & 6 deletions source/_components/netdata.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -43,23 +43,71 @@ $ curl -X GET "http://[Netdata_Instance]:19999/api/v1/data?chart=[data_group]&po
- `dimension_names`: Names shown in the frontend.
- `dimension_ids`: Names to use for `element`.

Alternatively you can browse to the built in Netdata API in your browser `http://[Netdata_Instance]:19999/api/v1/allmetrics?format=json` and search for the `data_group` identified in the Netdata frontend. In the example JSON below the data group is "system.load".

```json
"system.load": {
"name":"system.load",
"context":"system.load",
"units":"load",
"last_updated": 1558446920,
"dimensions": {
"load1": {
"name": "load1",
"value": 0.1250000
},
"load5": {
"name": "load5",
"value": 0.1290000
},
"load15": {
"name": "load15",
"value": 0.1430000
}
}
},
```

Once the `data_group` "system.load" and the `element` "load15" have been identified from the JSON it can be configured in your configuration.yaml like the example below.

## {% linkable_title Configuration %}

To add this platform to your installation, add the following to your `configuration.yaml` file:
To add this component to your installation, add the following to your `configuration.yaml`.
noodlemctwoodle marked this conversation as resolved.
Show resolved Hide resolved

```yaml
# Example configuration.yaml entry
sensor:
- platform: netdata
resources:
load:
resources:
system_load:
klaasnicolaas marked this conversation as resolved.
Show resolved Hide resolved
data_group: system.load
element: load15
cpu:
data_group: system.cpu
element: system
```

Multiple `data_group` and `element` entities can be added to he sensor

```yaml
# Example configuration.yaml entry
sensor:
- platform: netdata
host: '192.168.1.2' # optional
port: '19999' # optional
name: SomeHostName # optional
resources:
system_load: # sensor name
data_group: system.load
element: load15
core0_freq:
data_group: 'cpu.cpufreq'
element: 'cpu0'
icon: mdi:chip
```
noodlemctwoodle marked this conversation as resolved.
Show resolved Hide resolved






{% configuration %}
host:
description: The IP address or hostname of your Netdata instance.
Expand Down