| 1 | # netdata python.d.plugin configuration for go_expvar |
| 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 | # penalty indicates whether to apply penalty to update_every in case of failures. |
| 31 | # Penalty will increase every 5 failed updates in a row. Maximum penalty is 10 minutes. |
| 32 | # penalty: yes |
| 33 | |
| 34 | # autodetection_retry sets the job re-check interval in seconds. |
| 35 | # The job is not deleted if check fails. |
| 36 | # Attempts to start the job are made once every autodetection_retry. |
| 37 | # This feature is disabled by default. |
| 38 | # autodetection_retry: 0 |
| 39 | |
| 40 | # ---------------------------------------------------------------------- |
| 41 | # JOBS (data collection sources) |
| 42 | # |
| 43 | # Any number of jobs is supported. |
| 44 | # |
| 45 | # All python.d.plugin JOBS (for all its modules) support a set of |
| 46 | # predefined parameters. These are: |
| 47 | # |
| 48 | # job_name: |
| 49 | # name: myname # the JOB's name as it will appear at the |
| 50 | # # dashboard (by default is the job_name) |
| 51 | # # JOBs sharing a name are mutually exclusive |
| 52 | # update_every: 1 # the JOB's data collection frequency |
| 53 | # priority: 60000 # the JOB's order on the dashboard |
| 54 | # penalty: yes # the JOB's penalty |
| 55 | # autodetection_retry: 0 # the JOB's re-check interval in seconds |
| 56 | # |
| 57 | # Additionally to the above, this plugin also supports the following: |
| 58 | # |
| 59 | # url: 'http://127.0.0.1/debug/vars' # the URL of the expvar endpoint |
| 60 | # |
| 61 | # As the plugin cannot possibly know the port your application listens on, there is no default value. Please include |
| 62 | # the whole path of the endpoint, as the expvar handler can be installed in a non-standard location. |
| 63 | # |
| 64 | # if the URL is password protected, the following are supported: |
| 65 | # |
| 66 | # user: 'username' |
| 67 | # pass: 'password' |
| 68 | # |
| 69 | # collect_memstats: true # enables charts for Go runtime's memory statistics |
| 70 | # extra_charts: {} # defines extra data/charts to monitor, please see the example below |
| 71 | # |
| 72 | # If collect_memstats is disabled and no extra charts are defined, this module will disable itself, as it has no data to |
| 73 | # collect. |
| 74 | # |
| 75 | # Please visit the module wiki page for more information on how to use the extra_charts variable: |
| 76 | # |
| 77 | # https://github.com/netdata/netdata/tree/master/src/collectors/python.d.plugin/go_expvar |
| 78 | # |
| 79 | # Configuration example |
| 80 | # --------------------- |
| 81 | |
| 82 | #app1: |
| 83 | # name : 'app1' |
| 84 | # url : 'http://127.0.0.1:8080/debug/vars' |
| 85 | # collect_memstats: true |
| 86 | # extra_charts: |
| 87 | # - id: "runtime_goroutines" |
| 88 | # options: |
| 89 | # name: num_goroutines |
| 90 | # title: "runtime: number of goroutines" |
| 91 | # units: goroutines |
| 92 | # family: runtime |
| 93 | # context: expvar.runtime.goroutines |
| 94 | # chart_type: line |
| 95 | # lines: |
| 96 | # - {expvar_key: 'runtime.goroutines', expvar_type: int, id: runtime_goroutines} |
| 97 | # - id: "foo_counters" |
| 98 | # options: |
| 99 | # name: counters |
| 100 | # title: "some random counters" |
| 101 | # units: awesomeness |
| 102 | # family: counters |
| 103 | # context: expvar.foo.counters |
| 104 | # chart_type: line |
| 105 | # lines: |
| 106 | # - {expvar_key: 'counters.cnt1', expvar_type: int, id: counters_cnt1} |
| 107 | # - {expvar_key: 'counters.cnt2', expvar_type: float, id: counters_cnt2} |
| 108 |