summaryrefslogtreecommitdiffstats
path: root/conf.d/python.d/go_expvar.conf
blob: c352b1674ee040cfc60de3b018cb4dd2df6fae92 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# netdata python.d.plugin configuration for go_expvar
#
# This file is in YaML format. Generally the format is:
#
# name: value
#
# There are 2 sections:
#  - global variables
#  - one or more JOBS
#
# JOBS allow you to collect values from multiple sources.
# Each source will have its own set of charts.
#
# JOB parameters have to be indented (using spaces only, example below).

# ----------------------------------------------------------------------
# Global Variables
# These variables set the defaults for all JOBs, however each JOB
# may define its own, overriding the defaults.

# update_every sets the default data collection frequency.
# If unset, the python.d.plugin default is used.
# update_every: 1

# priority controls the order of charts at the netdata dashboard.
# Lower numbers move the charts towards the top of the page.
# If unset, the default for python.d.plugin is used.
# priority: 60000

# retries sets the number of retries to be made in case of failures.
# If unset, the default for python.d.plugin is used.
# Attempts to restore the service are made once every update_every
# and only if the module has collected values in the past.
# retries: 60

# autodetection_retry sets the job re-check interval in seconds.
# The job is not deleted if check fails.
# Attempts to start the job are made once every autodetection_retry.
# This feature is disabled by default.
# autodetection_retry: 0

# ----------------------------------------------------------------------
# JOBS (data collection sources)
#
# Any number of jobs is supported.
#
# All python.d.plugin JOBS (for all its modules) support a set of
# predefined parameters. These are:
#
# job_name:
#     name: myname            # the JOB's name as it will appear at the
#                             # dashboard (by default is the job_name)
#                             # JOBs sharing a name are mutually exclusive
#     update_every: 1         # the JOB's data collection frequency
#     priority: 60000         # the JOB's order on the dashboard
#     retries: 60             # the JOB's number of restoration attempts
#     autodetection_retry: 0  # the JOB's re-check interval in seconds
#
# Additionally to the above, this plugin also supports the following:
#
#     url: 'http://127.0.0.1/debug/vars'       # the URL of the expvar endpoint
#
# As the plugin cannot possibly know the port your application listens on, there is no default value. Please include
# the whole path of the endpoint, as the expvar handler can be installed in a non-standard location.
#
# if the URL is password protected, the following are supported:
#
#     user: 'username'
#     pass: 'password'
#
#     collect_memstats: true        # enables charts for Go runtime's memory statistics
#     extra_charts: {}              # defines extra data/charts to monitor, please see the example below
#
# If collect_memstats is disabled and no extra charts are defined, this module will disable itself, as it has no data to
# collect.
#
# Please visit the module wiki page for more information on how to use the extra_charts variable:
#
# https://github.com/firehol/netdata/wiki/Monitoring-Go-Applications#monitoring-custom-vars-with-go_expvar
#
# Configuration example
# ---------------------

#app1:
#  name : 'app1'
#  url  : 'http://127.0.0.1:8080/debug/vars'
#  collect_memstats: true
#  extra_charts:
#    - id: "runtime_goroutines"
#      options:
#        name: num_goroutines
#        title: "runtime: number of goroutines"
#        units: goroutines
#        family: runtime
#        context: expvar.runtime.goroutines
#        chart_type: line
#      lines:
#        - {expvar_key: 'runtime.goroutines', expvar_type: int, id: runtime_goroutines}
#    - id: "foo_counters"
#      options:
#        name: counters
#        title: "some random counters"
#        units: awesomeness
#        family: counters
#        context: expvar.foo.counters
#        chart_type: line
#      lines:
#        - {expvar_key: 'counters.cnt1', expvar_type: int, id: counters_cnt1}
#        - {expvar_key: 'counters.cnt2', expvar_type: float, id: counters_cnt2}