| 1 | plugin_name: cups.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | plugin_name: cups.plugin |
| 5 | module_name: cups.plugin |
| 6 | monitored_instance: |
| 7 | name: CUPS |
| 8 | link: "https://www.cups.org/" |
| 9 | categories: |
| 10 | - data-collection.applications |
| 11 | icon_filename: "cups.png" |
| 12 | related_resources: |
| 13 | integrations: |
| 14 | list: [] |
| 15 | info_provided_to_referring_integrations: |
| 16 | description: "" |
| 17 | keywords: [] |
| 18 | overview: |
| 19 | data_collection: |
| 20 | metrics_description: "Monitor CUPS performance for achieving optimal printing system operations. Monitor job statuses, queue lengths, and error rates to ensure smooth printing tasks." |
| 21 | method_description: "The plugin uses CUPS shared library to connect and monitor the server." |
| 22 | supported_platforms: |
| 23 | include: [] |
| 24 | exclude: [] |
| 25 | multi_instance: true |
| 26 | additional_permissions: |
| 27 | description: "The plugin needs to access the server. Netdata sets permissions during installation time to reach the server through its library." |
| 28 | default_behavior: |
| 29 | auto_detection: |
| 30 | description: "The plugin detects when CUPS server is running and tries to connect to it." |
| 31 | limits: |
| 32 | description: "" |
| 33 | performance_impact: |
| 34 | description: "" |
| 35 | setup: |
| 36 | prerequisites: |
| 37 | list: |
| 38 | - title: Minimum setup |
| 39 | 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`." |
| 40 | configuration: |
| 41 | file: |
| 42 | name: "netdata.conf" |
| 43 | section_name: "[plugin:cups]" |
| 44 | description: "The netdata main configuration file." |
| 45 | options: |
| 46 | description: "" |
| 47 | folding: |
| 48 | title: "Config options" |
| 49 | enabled: true |
| 50 | list: |
| 51 | - name: update every |
| 52 | description: Data collection frequency. |
| 53 | default_value: 1 |
| 54 | required: false |
| 55 | - name: command options |
| 56 | description: Additional parameters for the collector |
| 57 | default_value: "" |
| 58 | required: false |
| 59 | examples: |
| 60 | folding: |
| 61 | enabled: true |
| 62 | title: "" |
| 63 | list: [] |
| 64 | troubleshooting: |
| 65 | problems: |
| 66 | list: [] |
| 67 | alerts: [] |
| 68 | metrics: |
| 69 | folding: |
| 70 | title: Metrics |
| 71 | enabled: false |
| 72 | description: "" |
| 73 | availability: [] |
| 74 | scopes: |
| 75 | - name: global |
| 76 | description: "" |
| 77 | labels: [] |
| 78 | metrics: |
| 79 | - name: cups.dests_state |
| 80 | description: Destinations by state |
| 81 | unit: "dests" |
| 82 | chart_type: stacked |
| 83 | dimensions: |
| 84 | - name: idle |
| 85 | - name: printing |
| 86 | - name: stopped |
| 87 | - name: cups.dests_option |
| 88 | description: Destinations by option |
| 89 | unit: "dests" |
| 90 | chart_type: line |
| 91 | dimensions: |
| 92 | - name: total |
| 93 | - name: acceptingjobs |
| 94 | - name: shared |
| 95 | - name: cups.job_num |
| 96 | description: Active jobs |
| 97 | unit: "jobs" |
| 98 | chart_type: stacked |
| 99 | dimensions: |
| 100 | - name: pending |
| 101 | - name: held |
| 102 | - name: processing |
| 103 | - name: cups.job_size |
| 104 | description: Active jobs size |
| 105 | unit: "KB" |
| 106 | chart_type: stacked |
| 107 | dimensions: |
| 108 | - name: pending |
| 109 | - name: held |
| 110 | - name: processing |
| 111 | - name: destination |
| 112 | description: "" |
| 113 | labels: [] |
| 114 | metrics: |
| 115 | - name: cups.destination_job_num |
| 116 | description: Active jobs of {destination} |
| 117 | unit: "jobs" |
| 118 | chart_type: stacked |
| 119 | dimensions: |
| 120 | - name: pending |
| 121 | - name: held |
| 122 | - name: processing |
| 123 | - name: cups.destination_job_size |
| 124 | description: Active jobs size of {destination} |
| 125 | unit: "KB" |
| 126 | chart_type: stacked |
| 127 | dimensions: |
| 128 | - name: pending |
| 129 | - name: held |
| 130 | - name: processing |