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