conf.d/python.d/bind_rndc.conf

   1 # netdata python.d.plugin configuration for bind_rndc
   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 # update_every: 1
  24
  25 # priority controls the order of charts at the netdata dashboard.
  26 # Lower numbers move the charts towards the top of the page.
  27 # If unset, the default for python.d.plugin is used.
  28 # priority: 60000
  29
  30 # retries sets the number of retries to be made in case of failures.
  31 # If unset, the default for python.d.plugin is used.
  32 # Attempts to restore the service are made once every update_every
  33 # and only if the module has collected values in the past.
  34 # retries: 5
  35
  36 # ----------------------------------------------------------------------
  37 # JOBS (data collection sources)
  38 #
  39 # The default JOBS share the same *name*. JOBS with the same name
  40 # are mutually exclusive. Only one of them will be allowed running at
  41 # any time. This allows autodetection to try several alternatives and
  42 # pick the one that works.
  43 #
  44 # Any number of jobs is supported.
  45 #
  46 # All python.d.plugin JOBS (for all its modules) support a set of
  47 # predefined parameters. These are:
  48 #
  49 # job_name:
  50 #     name: myname     # the JOB's name as it will appear at the
  51 #                      # dashboard (by default is the job_name)
  52 #                      # JOBs sharing a name are mutually exclusive
  53 #     update_every: 1  # the JOB's data collection frequency
  54 #     priority: 60000  # the JOB's order on the dashboard
  55 #     retries: 5       # the JOB's number of restoration attempts
  56 #
  57 # Additionally to the above, bind_rndc also supports the following:
  58 #
  59 #     named_stats_path: 'path to named.stats'           # Default: '/var/log/bind/named.stats'
  60 #------------------------------------------------------------------------------------------------------------------
  61 # IMPORTANT Information
  62 #
  63 # BIND APPEND logs at EVERY RUN. Its NOT RECOMMENDED to set update_every below 30 sec.
  64 # STRONGLY RECOMMENDED to create a bind-rndc conf file for logrotate
  65 #
  66 # To set up your BIND to dump stats do the following:
  67 #
  68 # 1. add to 'named.conf.options' options {}:
  69 # statistics-file "/var/log/bind/named.stats";
  70 #
  71 # 2. Create bind/ directory in /var/log
  72 # cd /var/log/ && mkdir bind
  73 #
  74 # 3. Change owner of directory to 'bind' user
  75 # chown bind bind/
  76 #
  77 # 4. RELOAD (NOT restart) BIND
  78 # systemctl reload bind9.serice
  79 #
  80 # 5. Run as a root 'rndc stats' to dump (BIND will create named.stats in new directory)
  81 #
  82 #
  83 # To ALLOW NETDATA TO RUN 'rndc stats' change '/etc/bind/rndc.key' group to netdata
  84 # chown :netdata rndc.key
  85 #
  86 # The last BUT NOT least is to create bind-rndc.conf in logrotate.d/
  87 # The working one
  88 #  /var/log/bind/named.stats {
  89 #
  90 #     daily
  91 #     rotate 4
  92 #     compress
  93 #     delaycompress
  94 #     create 0644 bind bind
  95 #     missingok
  96 #     postrotate
  97 #         rndc reload > /dev/null
  98 #     endscript
  99 # }
 100 #
 101 # To test your logrotate conf file run as root:
 102 #
 103 # logrotate /etc/logrotate.d/bind-rndc -d (debug dry-run mode)
 104 # ------------------------------------------------------------------------------------------------------------------
 105 # AUTO-DETECTION JOBS
 106 # only one of them will run (they have the same name)
 107 #
 108 #local:
 109 # named_stats_path: '/var/log/bind/named.stats'