CUPS yaml update (#15594)
thiagoftsm committed
Jul 27, 2023 at 21:20 UTC
333ba3b3e55f68b16c56fc500ca5bd499d78a034
1 file changed
+29
-16
collectors/cups.plugin/metadata.yaml
+29
-16
@@ -1,53 +1,66 @@
1
+# yamllint disable rule:line-length
2
+---
3
meta:
4
plugin_name: cups.plugin
5
module_name: cups.plugin
6
monitored_instance:
7
name: CUPS
6
- link: ''
8
+ link: "https://www.cups.org/"
9
categories:
10
- data-collection.hardware-devices-and-sensors
9
- icon_filename: 'cups.png'
11
+ icon_filename: "cups.png"
12
related_resources:
13
integrations:
14
list: []
15
info_provided_to_referring_integrations:
14
- description: ''
16
+ description: ""
17
keywords: []
18
most_popular: false
19
overview:
20
data_collection:
19
- metrics_description: 'Monitor CUPS performance for achieving optimal printing system operations. Monitor job statuses, queue lengths, and error rates to ensure smooth printing tasks.'
20
- method_description: ''
21
+ metrics_description: "Monitor CUPS performance for achieving optimal printing system operations. Monitor job statuses, queue lengths, and error rates to ensure smooth printing tasks."
22
+ method_description: "The plugin uses CUPS shared library to connect and monitor the server."
23
supported_platforms:
24
include: []
25
exclude: []
26
multi_instance: true
27
additional_permissions:
26
- description: ''
28
+ description: "The plugin needs to access the server. Netdata sets permissions during installation time to reach the server through its library."
29
default_behavior:
30
auto_detection:
29
- description: ''
31
+ description: "The plugin detects when CUPS server is running and tries to connect to it."
32
limits:
31
- description: ''
33
+ description: ""
34
performance_impact:
33
- description: ''
35
+ description: ""
36
setup:
37
prerequisites:
36
- list: []
38
+ list:
39
+ - title: Minimum setup
40
+ description: "The CUPS server must be installed and running."
41
configuration:
42
file:
39
- name: ''
40
- description: ''
43
+ name: "netdata.conf"
44
+ section_name: "[plugin:cups]"
45
+ description: "The netdata main configuration file."
46
options:
42
- description: ''
47
+ description: ""
48
folding:
44
- title: ''
49
+ title: "Config options"
50
enabled: true
46
- list: []
51
+ list:
52
+ - name: update every
53
+ description: Data collection frequency.
54
+ default_value: 1
55
+ required: false
56
+ - name: command options
57
+ description: Additional parameters for the collector
58
+ default_value: ""
59
+ required: false
60
examples:
61
folding:
62
enabled: true
50
- title: ''
63
+ title: ""
64
list: []
65
troubleshooting:
66
problems: