Update python d varnish metadata (#15528)
* Update collectors/python.d.plugin/varnish/metadata.yaml --------- Co-authored-by: Fotis Voutsas <fotis@netdata.cloud>
Andrew Maguire committed
Jul 26, 2023 at 12:27 UTC
ec145b04333ecd1ddd736bd93e8de68f1aab4147
1 file changed
+76
-15
collectors/python.d.plugin/varnish/metadata.yaml
+76
-15
@@ -1,9 +1,11 @@
1
+# yamllint disable rule:line-length
2
+---
3
meta:
4
plugin_name: python.d.plugin
5
module_name: varnish
6
monitored_instance:
7
name: Varnish
6
- link: ''
8
+ link: https://varnish-cache.org/
9
categories:
10
- data-collection.web-servers-and-web-proxies
11
icon_filename: 'varnish.png'
@@ -12,43 +14,102 @@ meta:
14
list: []
15
info_provided_to_referring_integrations:
16
description: ''
15
- keywords: []
17
+ keywords:
18
+ - varnish
19
+ - varnishstat
20
+ - varnishd
21
+ - cache
22
+ - web server
23
+ - web cache
24
most_popular: false
25
overview:
26
data_collection:
19
- metrics_description: 'Monitor Varnish metrics with Netdata for efficient HTTP accelerator performance. Enhance your web performance with real-time Varnish metrics.'
20
- method_description: ''
27
+ metrics_description: |
28
+ This collector monitors Varnish metrics about HTTP accelerator global, Backends (VBE) and Storages (SMF, SMA, MSE) statistics.
29
+
30
+ Note that both, Varnish-Cache (free and open source) and Varnish-Plus (Commercial/Enterprise version), are supported.
31
+ method_description: |
32
+ It uses the `varnishstat` tool in order to collect the metrics.
33
supported_platforms:
34
include: []
35
exclude: []
24
- multi_instance: true
36
+ multi_instance: false
37
additional_permissions:
26
- description: ''
38
+ description: |
39
+ `netdata` user must be a member of the `varnish` group.
40
default_behavior:
41
auto_detection:
29
- description: ''
42
+ description: By default, if the permissions are satisfied, the `varnishstat` tool will be executed on the host.
43
limits:
44
description: ''
45
performance_impact:
46
description: ''
47
setup:
48
prerequisites:
36
- list: []
49
+ list:
50
+ - title: Provide the necessary permissions
51
+ description: |
52
+ In order for the collector to work, you need to add the `netdata` user to the `varnish` user group, so that it can execute the `varnishstat` tool:
53
+
54
+ ```
55
+ usermod -aG varnish netdata
56
+ ```
57
configuration:
58
file:
39
- name: ''
59
+ name: python.d/varnish.conf
60
description: ''
61
options:
42
- description: ''
62
+ description: |
63
+ There are 2 sections:
64
+
65
+ * Global variables
66
+ * One or more JOBS that can define multiple different instances to monitor.
67
+
68
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
69
+
70
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
71
+
72
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
73
folding:
44
- title: ''
74
+ title: Config options
75
enabled: true
46
- list: []
76
+ list:
77
+ - name: instance_name
78
+ description: the name of the varnishd instance to get logs from. If not specified, the host name is used.
79
+ default_value: '<host name>'
80
+ required: true
81
+ - name: update_every
82
+ description: Sets the default data collection frequency.
83
+ default_value: 10
84
+ required: false
85
+ - name: priority
86
+ description: Controls the order of charts at the netdata dashboard.
87
+ default_value: 60000
88
+ required: false
89
+ - name: autodetection_retry
90
+ description: Sets the job re-check interval in seconds.
91
+ default_value: 0
92
+ required: false
93
+ - name: penalty
94
+ description: Indicates whether to apply penalty to update_every in case of failures.
95
+ default_value: yes
96
+ required: false
97
+ - name: name
98
+ description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
99
+ default_value: ''
100
+ required: false
101
examples:
102
folding:
103
enabled: true
50
- title: ''
51
- list: []
104
+ title: 'Config'
105
+ list:
106
+ - name: Basic
107
+ description: An example configuration.
108
+ folding:
109
+ enabled: false
110
+ config: |
111
+ job_name:
112
+ instance_name: '<name-of-varnishd-instance>'
113
troubleshooting:
114
problems:
115
list: []
@@ -61,7 +122,7 @@ metrics:
122
availability: []
123
scopes:
124
- name: global
64
- description: ""
125
+ description: "These metrics refer to the entire monitored application."
126
labels: []
127
metrics:
128
- name: varnish.session_connection