summaryrefslogtreecommitdiffstats
path: root/collectors/cups.plugin/README.md
blob: 0658cc8b385078110ff466023629843856370b12 (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
<!--
title: "Printers (cups.plugin)"
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/cups.plugin/README.md"
sidebar_label: "cups.plugin"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "References/Collectors references/Remotes/Devices"
-->

# 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. Supports cups since version 1.7.

If you installed Netdata using our native packages, you will have to additionally install `netdata-plugin-cups` to use this plugin for data collection. It is not installed by default due to the large number of dependencies it requires.

## 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

2.  **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.