summaryrefslogtreecommitdiffstats
path: root/collectors/cups.plugin/metadata.yaml
blob: 9ec2f4118fecd0aa69cd333ae8bd847d3843b2a8 (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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
plugin_name: cups.plugin
modules:
  - meta:
      plugin_name: cups.plugin
      module_name: cups.plugin
      monitored_instance:
        name: CUPS
        link: "https://www.cups.org/"
        categories:
          - data-collection.hardware-devices-and-sensors
        icon_filename: "cups.png"
      related_resources:
        integrations:
          list: []
      info_provided_to_referring_integrations:
        description: ""
      keywords: []
      most_popular: false
    overview:
      data_collection:
        metrics_description: "Monitor CUPS performance for achieving optimal printing system operations. Monitor job statuses, queue lengths, and error rates to ensure smooth printing tasks."
        method_description: "The plugin uses CUPS shared library to connect and monitor the server."
      supported_platforms:
        include: []
        exclude: []
      multi_instance: true
      additional_permissions:
        description: "The plugin needs to access the server. Netdata sets permissions during installation time to reach the server through its library."
      default_behavior:
        auto_detection:
          description: "The plugin detects when CUPS server is running and tries to connect to it."
        limits:
          description: ""
        performance_impact:
          description: ""
    setup:
      prerequisites:
        list:
          - title: Minimum setup
            description: "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`."
      configuration:
        file:
          name: "netdata.conf"
          section_name: "[plugin:cups]"
          description: "The netdata main configuration file."
        options:
          description: ""
          folding:
            title: "Config options"
            enabled: true
          list:
            - name: update every
              description: Data collection frequency.
              default_value: 1
              required: false
            - name: command options
              description: Additional parameters for the collector
              default_value: ""
              required: false
        examples:
          folding:
            enabled: true
            title: ""
          list: []
    troubleshooting:
      problems:
        list: []
    alerts: []
    metrics:
      folding:
        title: Metrics
        enabled: false
      description: ""
      availability: []
      scopes:
        - name: global
          description: ""
          labels: []
          metrics:
            - name: cups.dests_state
              description: Destinations by state
              unit: "dests"
              chart_type: stacked
              dimensions:
                - name: idle
                - name: printing
                - name: stopped
            - name: cups.dests_option
              description: Destinations by option
              unit: "dests"
              chart_type: line
              dimensions:
                - name: total
                - name: acceptingjobs
                - name: shared
            - name: cups.job_num
              description: Active jobs
              unit: "jobs"
              chart_type: stacked
              dimensions:
                - name: pending
                - name: held
                - name: processing
            - name: cups.job_size
              description: Active jobs size
              unit: "KB"
              chart_type: stacked
              dimensions:
                - name: pending
                - name: held
                - name: processing
        - name: destination
          description: ""
          labels: []
          metrics:
            - name: cups.destination_job_num
              description: Active jobs of {destination}
              unit: "jobs"
              chart_type: stacked
              dimensions:
                - name: pending
                - name: held
                - name: processing
            - name: cups.destination_job_size
              description: Active jobs size of {destination}
              unit: "KB"
              chart_type: stacked
              dimensions:
                - name: pending
                - name: held
                - name: processing