@cryptotaxi247 / netdata
Code Commits Issues Pulls Sessions CI/CD
master
master
md 146 lines 3.69 KB
Rendered Raw
1 <!--startmeta
2 custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/cups.plugin/README.md"
3 meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/cups.plugin/metadata.yaml"
4 sidebar_label: "CUPS"
5 learn_status: "Published"
6 learn_rel_path: "Collecting Metrics/Collectors/Applications"
7 message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
8 endmeta-->
9
10 # CUPS
11
12
13 <img src="https://netdata.cloud/img/cups.png" width="150"/>
14
15
16 Plugin: cups.plugin
17 Module: cups.plugin
18
19 <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
20
21 ## Overview
22
23 Monitor CUPS performance for achieving optimal printing system operations. Monitor job statuses, queue lengths, and error rates to ensure smooth printing tasks.
24
25 The plugin uses CUPS shared library to connect and monitor the server.
26
27 This collector is supported on all platforms.
28
29 This collector supports collecting metrics from multiple instances of this integration, including remote instances.
30
31 The plugin needs to access the server. Netdata sets permissions during installation time to reach the server through its library.
32
33 ### Default Behavior
34
35 #### Auto-Detection
36
37 The plugin detects when CUPS server is running and tries to connect to it.
38
39 #### Limits
40
41 The default configuration for this integration does not impose any limits on data collection.
42
43 #### Performance Impact
44
45 The default configuration for this integration is not expected to impose a significant performance impact on the system.
46
47 ## Setup
48
49
50 ### Prerequisites
51
52 #### Minimum setup
53
54 The CUPS server must be installed and running. If you installed `netdata` using a package manager, it is also necessary to install the package `netdata-plugin-cups`.
55
56
57 ### Configuration
58
59 #### Options
60
61
62
63 <details open><summary>Config options</summary>
64
65
66
67 | Option | Description | Default | Required |
68 |:-----|:------------|:--------|:---------:|
69 | update every | Data collection frequency. | 1 | no |
70 | command options | Additional parameters for the collector | | no |
71
72
73 </details>
74
75
76
77 #### via File
78
79 The configuration file name for this integration is `netdata.conf`.
80 Configuration for this specific integration is located in the `[plugin:cups]` section within that file.
81
82 The file format is a modified INI syntax. The general structure is:
83
84 ```ini
85 [section1]
86 option1 = some value
87 option2 = some other value
88
89 [section2]
90 option3 = some third value
91 ```
92 You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
93 Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
94
95 ```bash
96 cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
97 sudo ./edit-config netdata.conf
98 ```
99
100 ##### Examples
101 There are no configuration examples.
102
103
104
105 ## Alerts
106
107 There are no alerts configured by default for this integration.
108
109
110 ## Metrics
111
112 Metrics grouped by *scope*.
113
114 The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
115
116
117
118 ### Per CUPS instance
119
120
121
122 This scope has no labels.
123
124 Metrics:
125
126 | Metric | Dimensions | Unit |
127 |:------|:----------|:----|
128 | cups.dests_state | idle, printing, stopped | dests |
129 | cups.dests_option | total, acceptingjobs, shared | dests |
130 | cups.job_num | pending, held, processing | jobs |
131 | cups.job_size | pending, held, processing | KB |
132
133 ### Per destination
134
135
136
137 This scope has no labels.
138
139 Metrics:
140
141 | Metric | Dimensions | Unit |
142 |:------|:----------|:----|
143 | cups.destination_job_num | pending, held, processing | jobs |
144 | cups.destination_job_size | pending, held, processing | KB |
145
146