conf.d/stream.conf

   1 # netdata configuration for aggregating data from remote hosts
   2 #
   3 # API keys authorize a pair of sending-receiving netdata servers.
   4 # Once their communication is authorized, they can exchange metrics for any
   5 # number of hosts.
   6 #
   7 # You can generate API keys, with the linux command: uuidgen
   8 #
   9 # -----------------------------------------------------------------------------
  10 # 1. SLAVE NETDATA - THE ONE THAT WILL BE SENDING METRICS
  11
  12 [stream]
  13         enabled = no
  14
  15         # where to send metrics to?
  16         # A space separated list of [PROTOCOL:]HOST[%INTERFACE][:PORT] is accepted.
  17         # The first available will get the metrics.
  18         # PROTOCOL = tcp or udp (only tcp is supported by masters)
  19         # HOST = an IPv4, IPv6 IP, or a hostname.
  20         #        IPv6 IPs should be given with brackets [ip:address]
  21         # INTERFACE = the network interface to use
  22         # PORT = the port number or service name (/etc/services)
  23         # This communication is not HTTP (cannot be proxied).
  24         destination =
  25
  26         # The API_KEY to use (as the sender)
  27         api key =
  28
  29         # other options (uncomment and set)
  30
  31         # timeout seconds = 60
  32         # default port = 19999
  33         # buffer size bytes = 1048576
  34         # reconnect delay seconds = 5
  35         # initial clock resync iterations = 60
  36         # free orphan hosts after seconds = 3600
  37
  38
  39 # -----------------------------------------------------------------------------
  40 # 2. MASTER NETDATA - THE ONE THAT WILL BE RECEIVING METRICS
  41 #
  42 #    You can have one API key per slave, or the same API key for all slaves.
  43 #
  44 #    All options below are used in this order:
  45 #
  46 #    a) MACHINE_GUID (settings for each machine)
  47 #    b) API_KEY      (settings for the API key)
  48 #    c) this netdata defaults (as in netdata.conf)
  49 #
  50 #    You can combine the above (the more specific setting will be used).
  51
  52 # API key authentication
  53 # If the key is not listed here, it will not be able to connect.
  54
  55 [API_KEY]
  56     # Default settings for the API key
  57
  58     # You can disable the API key, by setting this to: no
  59     # The default (for unknown API keys) is also: no
  60     enabled = no
  61
  62     # The default history in entries, for all hosts using this API key.
  63     # You can also set it per host below.
  64     # If you don't set it here, the history size of the central netdata
  65     # will be used
  66     default history = 3600
  67
  68     # The default memory mode to be used for all hosts using this API key.
  69     # You can also set it per host below.
  70     # If you don't set it here, the memory mode of netdata.conf will be used.
  71     # Valid modes:
  72     #    save    save on exit, load on start
  73     #    map     like swap (continuously syncing to disks)
  74     #    ram     keep it in RAM, don't touch the disk
  75     #    none    no database (passing through this netdata)
  76     default memory mode = ram
  77
  78     # Shall we enable health monitoring for the hosts using this API key?
  79     # 3 values:
  80     #    yes     enable alarms
  81     #    no      do not enable alarms
  82     #    auto    enable alarms, only when the sending netdata is connected
  83     # You can also set it per host, below.
  84     # The default is the same as to netdata.conf
  85     health enabled by default = auto
  86
  87     # postpone alarms for a short period after the sender is connected
  88     default postpone alarms on connect seconds = 60
  89
  90     # need to route metrics differently? set these.
  91     # the defaults are the ones at the [stream] section
  92     #default proxy enabled = yes | no
  93     #default proxy destination = IP:PORT IP:PORT ...
  94     #default proxy api key = API_KEY
  95
  96
  97 # -----------------------------------------------------------------------------
  98 # Each netdata has a unique GUID - generated the first time netdata starts.
  99 # You can find it at /var/lib/netdata/registry/netdata.public.unique.id
 100 # The host sending data will have one. If it is static and you can find it,
 101 # you can give settings for each specific host here.
 102
 103 [MACHINE_GUID]
 104     # enable this host: yes | no
 105     # THIS IS NOT A SECURITY MECHANISM - AN ATTACKER CAN SET ANY OTHER GUID.
 106     # Use only the API key for security.
 107     enabled = no
 108
 109     # The number of entries in the database
 110     history = 3600
 111
 112     # The memory mode of the database: save | map | ram | none
 113     memory mode = save
 114
 115     # Health / alarms control: yes | no | auto
 116     health enabled = yes
 117
 118     # postpone alarms when the sender connects
 119     postpone alarms on connect seconds = 60
 120
 121     # need to route metrics differently?
 122     #proxy enabled = yes | no
 123     #proxy destination = IP:PORT IP:PORT ...
 124     #proxy api key = API_KEY