conf.d/python.d/nsd.conf

   1 # netdata python.d.plugin configuration for nsd
   2 #
   3 # This file is in YaML format. Generally the format is:
   4 #
   5 # name: value
   6 #
   7 # There are 2 sections:
   8 #  - global variables
   9 #  - one or more JOBS
  10 #
  11 # JOBS allow you to collect values from multiple sources.
  12 # Each source will have its own set of charts.
  13 #
  14 # JOB parameters have to be indented (using spaces only, example below).
  15
  16 # ----------------------------------------------------------------------
  17 # Global Variables
  18 # These variables set the defaults for all JOBs, however each JOB
  19 # may define its own, overriding the defaults.
  20
  21 # update_every sets the default data collection frequency.
  22 # If unset, the python.d.plugin default is used.
  23 # nsd-control is slow, so once every 30 seconds
  24 # update_every: 30
  25
  26 # priority controls the order of charts at the netdata dashboard.
  27 # Lower numbers move the charts towards the top of the page.
  28 # If unset, the default for python.d.plugin is used.
  29 # priority: 60000
  30
  31 # retries sets the number of retries to be made in case of failures.
  32 # If unset, the default for python.d.plugin is used.
  33 # Attempts to restore the service are made once every update_every
  34 # and only if the module has collected values in the past.
  35 # retries: 5
  36
  37 # ----------------------------------------------------------------------
  38 # JOBS (data collection sources)
  39 #
  40 # The default JOBS share the same *name*. JOBS with the same name
  41 # are mutually exclusive. Only one of them will be allowed running at
  42 # any time. This allows autodetection to try several alternatives and
  43 # pick the one that works.
  44 #
  45 # Any number of jobs is supported.
  46 #
  47 # All python.d.plugin JOBS (for all its modules) support a set of
  48 # predefined parameters. These are:
  49 #
  50 # job_name:
  51 #     name: myname     # the JOB's name as it will appear at the
  52 #                      # dashboard (by default is the job_name)
  53 #                      # JOBs sharing a name are mutually exclusive
  54 #     update_every: 1  # the JOB's data collection frequency
  55 #     priority: 60000  # the JOB's order on the dashboard
  56 #     retries: 5       # the JOB's number of restoration attempts
  57 #
  58 # Additionally to the above, nsd also supports the following:
  59 #
  60 #     command: 'nsd-control stats_noreset' # the command to run
  61 #
  62
  63 # ----------------------------------------------------------------------
  64 # IMPORTANT Information
  65 #
  66 # Netdata must have permissions to run `nsd-control stats_noreset` command
  67 #
  68 # - Example-1 (use "sudo")
  69 # 1. sudoers (e.g. visudo -f /etc/sudoers.d/netdata)
  70 #       Defaults:netdata   !requiretty
  71 #       netdata ALL=(ALL)  NOPASSWD: /usr/sbin/nsd-control stats_noreset
  72 # 2. etc/netdata/python.d/nsd.conf
  73 #       local:
  74 #         update_every: 30
  75 #         command: 'sudo /usr/sbin/nsd-control stats_noreset'
  76 #
  77 # - Example-2 (add "netdata" user to "nsd" group)
  78 # usermod -aG nsd netdata
  79 #
  80
  81 # ----------------------------------------------------------------------
  82 # AUTO-DETECTION JOBS
  83
  84 local:
  85   update_every: 30
  86   command: 'nsd-control stats_noreset'