conf.d/python.d/elasticsearch.conf

   1 # netdata python.d.plugin configuration for elasticsearch stats
   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, elasticsearch plugin also supports the following:
  58 #
  59 #     host: 'ipaddress'                # Server ip address or hostname.
  60 #     port: 'port'                     # Port on which elasticsearch  listen.
  61 #     cluster_health: False/True       # Calls to cluster health elasticsearch API. Enabled by default.
  62 #     cluster_stats: False/True        # Calls to cluster stats elasticsearch API. Enabled by default.
  63 #
  64 # ----------------------------------------------------------------------
  65 # IMPORTANT Information
  66 #
  67 # Module uses python `requests` package
  68 #
  69 # You need to install it manually. (python-requests or python3-requests depending on the version of python).
  70 #
  71 #
  72 # AUTO-DETECTION JOBS
  73 # only one of them will run (they have the same name)
  74 #
  75 #local:
  76 # host: '127.0.0.1'
  77 # port: '9200'
  78 # cluster_health: True
  79 # cluster_stats: True