summaryrefslogtreecommitdiffstats
path: root/collectors/cups.plugin/README.md
blob: 7baf8855975862d5a3cb805be88414db1c80fcce (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
# cups.plugin

`cups.plugin` collects Common Unix Printing System (CUPS) metrics.

## Prerequisites

This plugin needs a running local CUPS daemon (`cupsd`). This plugin does not need any configuration.

## Charts

`cups.plugin` provides one common section `destinations` and one section per destination. 

> Destinations in CUPS represent individual printers or classes (collections or pools) of printers (https://www.cups.org/doc/cupspm.html#working-with-destinations)

The section `server` provides these charts:

1. **destinations by state**
 * idle
 * printing
 * stopped

2. **destinations by options**
 * total
 * accepting jobs
 * shared

3. **total job number by status**
 * pending
 * processing
 * held

4. **total job size by status**
 * pending
 * processing
 * held

For each destination the plugin provides these charts:

1. **job number by status**
 * pending
 * held
 * processing

3. **job size by status**
 * pending
 * held
 * processing
  
At the moment only job status pending, processing, and held are reported because we do not have a method to collect stopped, canceled, aborted and completed jobs which scales.