8.9.1. Configuring the Netdata polling interface

8.9.1.1. Introduction

This procedure describes the configuration of the Netdata interface to allow a remote server (for example NAGIOS) to read the selected metrics via the netdata API.

User Authentication:

Authenticated users can search the Netadata API, available on Gstats.
For simple automation, it is possible to allow an unauthenticated user to probe the API.
In this case, the API endpoint is redirected to http on the port specified below http://gcenter_fqdn:redirection_port

List of authorized IP addresses

A restricted access list is the client subnets for which this redirection is available.
Depending on the IP/mask pair, it is therefore possible to allow an IP or a range of IP addresses per line entered.
It is possible to add multiple rows.

List of accessible metrics

For a remote PC defined in the list of allowed IPs, it is possible to view the available metrics.
To do this, you must enter the following URL in a web browser http://IP-gcenter:8001/host/fqdn-gcenter/api/v1/allmetrics

Below, an extract of the metrics is displayed.

# chart: net_drops.vnet0 (name: net_drops.vnet0)
NETDATA_NET_DROPS_VNET0_INBOUND="0"      # drops/s
NETDATA_NET_DROPS_VNET0_OUTBOUND="-0"      # drops/s
NETDATA_NET_DROPS_VNET0_VISIBLETOTAL="0"      # drops/s

# chart: net_errors.vnet0 (name: net_errors.vnet0)
NETDATA_NET_ERRORS_VNET0_INBOUND="0"      # errors/s
NETDATA_NET_ERRORS_VNET0_OUTBOUND="-0"      # errors/s
NETDATA_NET_ERRORS_VNET0_VISIBLETOTAL="0"      # errors/s

# chart: net.vnet0 (name: net.vnet0)
NETDATA_NET_VNET0_RECEIVED="8"      # kilobits/s
NETDATA_NET_VNET0_SENT="1"      # kilobits/s
NETDATA_NET_VNET0_VISIBLETOTAL="9"      # kilobits/s

# chart: elasticsearch_gesmaster.cluster_stats_shards_total (name: elasticsearch_gesmaster.cluster_stats_shards_total)
NETDATA_ELASTICSEARCH_GESMASTER_CLUSTER_STATS_SHARDS_TOTAL_SHARDS="114"      # shards
NETDATA_ELASTICSEARCH_GESMASTER_CLUSTER_STATS_SHARDS_TOTAL_VISIBLETOTAL="114"      # shards

# chart: elasticsearch_gesmaster.cluster_stats_indices (name: elasticsearch_gesmaster.cluster_stats_indices)
NETDATA_ELASTICSEARCH_GESMASTER_CLUSTER_STATS_INDICES_INDICES="114"      # indices
NETDATA_ELASTICSEARCH_GESMASTER_CLUSTER_STATS_INDICES_VISIBLETOTAL="114"      # indices

Note

For more information, see the Interconnection with external systems.
The graphical interface is described in `Admin-GCenter-Configuration` screen of the legacy web UI.

8.9.1.2. Prerequisites

  • User : member of Administrator group

8.9.1.3. Preliminary operations

8.9.1.4. Procedure to access to the `Netdata polling` screen of the legacy web UI

  • In the navigation bar, click successively on:

  • The `Admin`

  • The `Admin` sub menu

  • The `Configuration` command
    The `Configuration` window is displayed.
    ../../_images/CONFIGUR-01.PNG

  • Click on the `Netdata polling` button (1).

8.9.1.5. Procedure to configure

The following screen is displayed:

../../_images/CONFIGUR-02.PNG

  • Use the selector (2) `Allow unauthenticated users to poll netdata API`.

  • Select forwarding port (3): default 8001

  • Select the GCenter input interface in field (4) `Intput interface`.

  • To add an IP address or subnet:

  • Press on the `Add subnet` button

  • In the `ADD IP/MASK` window, enter the IP address then `/` then the mask

  • Press on the `ADD` button
    The address entered is displayed in field (7) `Authorized subnets`
  • Press on the `Save` button (5).
    If all is ok then the message `The Netdata polling configuration was successfully updated` is displayed.