Health monitoring using PRTG and PaperCut templates

With PaperCut and PRTG Network Monitor, you can easily monitor the health of your entire print environment, including real-time activity that will help you plan future printing resource requirements. End-users will have as wrinkle-free a printing experience as possible because you have avoided potential issues and outages along the way. How do the templates work? The PaperCut PRTG templates allow SysAdmins to perform health monitoring of their PaperCut printing environment, with a minimal amount of setup. The templates are automatically created by executing a python script ( PaperCut PRTG Template Generator ), which scans your specific PaperCut installation and create sensors for all printers, devices, and critical PaperCut infrastructure. You can then import this template directly into PRTG Network Monitor. The sensors included in the template monitor the following: Server health status: Overall server health Current number of held jobs Pages printed in the last minute Server errors in the last 10 minutes Server warnings in the last 10 minutes Individual printer health status Individual device health status For more advanced usage, check out the PaperCut NG System Health Interface reference. What do I need to get started? Python 3.1 or greater ( downloadable via https://www.python.org/ ) PaperCut PRTG Template Generator ( see below ) PaperCut NG / MF ( https://www.papercut.com ) PRTG installation Download the PaperCut PRTG Template Generator Visit our GitHub repository: https://github.com/PaperCutSoftware/PRTGTemplateGenerator . Click on the green button “Clone or download” and choose “Download ZIP”: Unzip the PRTGTemplateGenerator-master.zip file and keep it somewhere safe and easy to get to. You’ll need it soon! How do I generate the PaperCut PRTG Templates? Once the PaperCut PRTG Template Generator Script has been downloaded onto your local machine, it can be executed using a command line interface in order to generate the PaperCut PRTG Templates. Ensure that Python 3.1 or greater is installed. This section describes the steps required to generate PaperCut PRTG Templates: Obtain the PaperCut Health Monitoring API URL. Run the PaperCut PRTG Template Generator script. Import the PaperCut PRTG Templates. Obtain the PaperCut Health Monitoring API URL In the PaperCut Admin web interface, select Options > Advanced. In the System Health Monitoring area, copy the URL for the PaperCut Health Monitoring API (this is the ‘GET query parameter’), or select an appropriate URL from the list in the warning below. Caution When possible, the narrowest endpoint required should be used to minimise load on the application server. Endpoints like /api/health query almost all system components and can cause unnecessary stress. A list of endpoints can be found here. For example, if doing a simple check to see whether the application server is responding, http://localhost:9191/api/health/application-server/status?disk-threshold-mb=1024 can be used as it will only check if there is more than 1 GB of available disk space. Run the PaperCut PRTG Template Generator script Run the PaperCut PRTG Template Generator script (pc-prtg-generator.py) with the first argument being the GET Query Parameter (the Health Monitoring URL) for the PaperCut Health Monitoring API. First, CD to the un-zipped PRTGTemplateGenerator-master.zip folder from before. Next, see examples for your OS below: In Linux or macOS: $ ./pc-prtg-generator.py http://10.100.66.29:9191/api/health?Authorization=LAlwqdy57aE35n2TOyr777778888DaFb In Windows: c:\>pc-prtg-generator.py http://10.100.66.29:9191/api/health?Authorization=LAlwqdy57aE35n2TOyr777778888DaFb Please Note: Older versions of the PaperCut PRTG Template Generator Script did not support HTTPS URLs. If you’re finding yourself unable to successfully generate templates referencing HTTPS addresses, be sure to update to the latest version the scripts available from our GitHub repository. The PaperCut PRTG template files are generated in the same directory as the script. Templates are generated according to your setup. For example, if you have no printers or devices, the corresponding printer or device template file will not be generated. Up to three PRTG template files are generated: PaperCut Printers.odt : monitors PaperCut printers in your installation. PaperCut Devices.odt : monitors PaperCut devices in your installation. PaperCut Server.odt : monitors the PaperCut server. Required Arguments ArgumentParameterDescriptionaddressSTRINGGET Query URL for your PaperCut Server Health Monitoring API. Optional Arguments ArgumentParameterDescriptionExample-n --nameSTRING(Default: none) Filter printer and deviceresults by name. ./pc-prtg-generator.py http://10.100.66.29:9191/api/health?Authorization=LAlwqdy57aE35n2TOyr7BHy3p70CDaFb --name plotterPrinter-lo --locationSTRING(Default: none) Filter results by theprinter/device location. ./pc-prtg-generator.py http://10.100.66.29:9191/api/health?Authorization=LAlwqdy57aE35n2TOyr7BHy3p70CDaFb --location financeDept-s --serverSTRING(Default: none) Filter results by theprinter server. ./pc-prtg-generator.py http://10.100.66.29:9191/api/health?Authorization=LAlwqdy57aE35n2TOyr7BHy3p70CDaFb --server pc-Server-li --limitINT(Default: 250) Maximum number ofprinters/devices to include in the template. ./pc-prtg-generator.py http://10.100.66.29:9191/api/health?Authorization=LAlwqdy57aE35n2TOyr7BHy3p70CDaFb --limit 50 Importing PaperCut PRTG Templates Copy the following PRTG templates from the script directory to the devicetemplates folder in the PRTG installation directory: <installation directory>\PRTG Network Monitor\:PaperCut Printers.odtPaperCut Devices.odtPaperCut Server.odtNote: If you have no printers or devices, the corresponding device template file will not be generated.In the PRTG Admin Interface, under the Root group, right-click the PRTG current object (e.g. right-click on “127.0.0.1”); then select Add Device. The Root group is the highest instance in the object hierarchy of your PRTG setup and is the parent to all other objects.Add a new deviceUnder Sensor Management, select the Automatic Sensor creation using specific device template(s) option.Search the templates for PaperCut, and select the template you wish to use.Click Continue. Repeat the steps for each of the PaperCut PRTG templates. Your PRTG Network Monitor is now set up for you to monitor your PaperCut printing environment.