mirror of
https://github.com/prometheus-community/windows_exporter.git
synced 2026-10-19 11:09:03 +02:00
printer: read printers and jobs from the spooler API (#2577)
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: Jan-Otto Kröpke <mail@jkroepke.de>
This commit is contained in:
Jan-Otto Kröpke
co-authored by
Claude Opus 5.5
Claude Opus 5.5
parent
cb5b4cb0bf
commit
7c200078ef
@@ -22,17 +22,28 @@ import (
|
||||
"fmt"
|
||||
"log/slog"
|
||||
"regexp"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"github.com/alecthomas/kingpin/v2"
|
||||
"github.com/prometheus-community/windows_exporter/internal/headers/winspool"
|
||||
"github.com/prometheus-community/windows_exporter/internal/mi"
|
||||
"github.com/prometheus-community/windows_exporter/internal/types"
|
||||
"github.com/prometheus/client_golang/prometheus"
|
||||
"golang.org/x/sys/windows"
|
||||
)
|
||||
|
||||
const Name = "printer"
|
||||
|
||||
// Win32_Printer PrinterStatus values.
|
||||
// https://learn.microsoft.com/en-us/windows/win32/cimwin32prov/win32-printer
|
||||
const (
|
||||
printerStatusOther uint16 = 1
|
||||
printerStatusUnknown uint16 = 2
|
||||
printerStatusIdle uint16 = 3
|
||||
printerStatusPrinting uint16 = 4
|
||||
printerStatusWarmup uint16 = 5
|
||||
)
|
||||
|
||||
// printerStatusMap source: https://learn.microsoft.com/en-us/windows/win32/cimwin32prov/win32-printer#:~:text=Power%20Save-,PrinterStatus,Offline%20(7),-PrintJobDataType
|
||||
//
|
||||
//nolint:gochecknoglobals
|
||||
@@ -58,10 +69,7 @@ var ConfigDefaults = Config{
|
||||
}
|
||||
|
||||
type Collector struct {
|
||||
config Config
|
||||
miSession *mi.Session
|
||||
miQueryPrinterJobs mi.Query
|
||||
miQueryPrinter mi.Query
|
||||
config Config
|
||||
|
||||
printerStatus *prometheus.Desc
|
||||
printerJobStatus *prometheus.Desc
|
||||
@@ -128,7 +136,7 @@ func (c *Collector) Close() error {
|
||||
return nil
|
||||
}
|
||||
|
||||
func (c *Collector) Build(_ *slog.Logger, miSession *mi.Session) error {
|
||||
func (c *Collector) Build(_ *slog.Logger, _ *mi.Session) error {
|
||||
c.printerJobStatus = prometheus.NewDesc(
|
||||
prometheus.BuildFQName(types.Namespace, Name, "job_status"),
|
||||
"A counter of printer jobs by status",
|
||||
@@ -148,86 +156,49 @@ func (c *Collector) Build(_ *slog.Logger, miSession *mi.Session) error {
|
||||
nil,
|
||||
)
|
||||
|
||||
if miSession == nil {
|
||||
return errors.New("miSession is nil")
|
||||
}
|
||||
|
||||
miQuery, err := mi.NewQuery("SELECT Name, Default, PrinterStatus, JobCountSinceLastReset FROM win32_Printer")
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to create WMI query: %w", err)
|
||||
}
|
||||
|
||||
c.miQueryPrinter = miQuery
|
||||
|
||||
miQuery, err = mi.NewQuery("SELECT Name, Status FROM win32_PrintJob")
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to create WMI query: %w", err)
|
||||
}
|
||||
|
||||
c.miQueryPrinterJobs = miQuery
|
||||
c.miSession = miSession
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func (c *Collector) GetName() string { return Name }
|
||||
|
||||
type wmiPrinter struct {
|
||||
Name string `mi:"Name"`
|
||||
Default bool `mi:"Default"`
|
||||
PrinterStatus uint16 `mi:"PrinterStatus"`
|
||||
JobCountSinceLastReset uint32 `mi:"JobCountSinceLastReset"`
|
||||
}
|
||||
// Collect reads printers and jobs from the print spooler.
|
||||
// Win32_Printer is not used because the CIMWin32 provider calls DeviceCapabilities
|
||||
// for every printer, which blocks for about a minute on an unreachable network printer.
|
||||
func (c *Collector) Collect(ch chan<- prometheus.Metric, _ time.Duration) error {
|
||||
// CIMWin32 enumerates the same printers for Win32_Printer.
|
||||
printers, err := winspool.EnumPrinters(winspool.PRINTER_ENUM_LOCAL | winspool.PRINTER_ENUM_CONNECTIONS)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to enumerate printers: %w", err)
|
||||
}
|
||||
|
||||
type wmiPrintJob struct {
|
||||
Name string `mi:"Name"`
|
||||
Status string `mi:"Status"`
|
||||
}
|
||||
|
||||
// minQueryTimeout keeps the job query bounded once the scrape budget is spent.
|
||||
// MI counts timeouts in whole milliseconds, and a zero timeout means no timeout at all.
|
||||
const minQueryTimeout = time.Millisecond
|
||||
|
||||
func (c *Collector) Collect(ch chan<- prometheus.Metric, maxScrapeDuration time.Duration) error {
|
||||
var errs []error
|
||||
|
||||
deadline := time.Now().Add(maxScrapeDuration)
|
||||
|
||||
// Win32_Printer calls DeviceCapabilities for every printer, whichever properties are selected.
|
||||
// For an IPP printer that is offline, this blocks until the network requests time out,
|
||||
// which can take close to a minute. Bound the query by the scrape timeout, so that a hung call
|
||||
// fails with the native MI timeout instead of blocking the collector for later scrapes.
|
||||
if err := c.collectPrinterStatus(ch, maxScrapeDuration); err != nil {
|
||||
errs = append(errs, fmt.Errorf("failed to collect printer status metrics: %w", err))
|
||||
}
|
||||
|
||||
jobQueryTimeout := maxScrapeDuration
|
||||
if maxScrapeDuration > 0 {
|
||||
jobQueryTimeout = max(time.Until(deadline), minQueryTimeout)
|
||||
}
|
||||
|
||||
if err := c.collectPrinterJobStatus(ch, jobQueryTimeout); err != nil {
|
||||
errs = append(errs, fmt.Errorf("failed to collect printer job status metrics: %w", err))
|
||||
}
|
||||
|
||||
return errors.Join(errs...)
|
||||
}
|
||||
|
||||
func (c *Collector) collectPrinterStatus(ch chan<- prometheus.Metric, maxScrapeDuration time.Duration) error {
|
||||
var printers []wmiPrinter
|
||||
if err := c.miSession.Query(&printers, mi.NamespaceRootCIMv2, c.miQueryPrinter, maxScrapeDuration); err != nil {
|
||||
return fmt.Errorf("WMI query failed: %w", err)
|
||||
}
|
||||
|
||||
for _, printer := range printers {
|
||||
if c.config.PrinterExclude.MatchString(printer.Name) ||
|
||||
!c.config.PrinterInclude.MatchString(printer.Name) {
|
||||
continue
|
||||
}
|
||||
|
||||
for printerStatus, printerStatusName := range printerStatusMap {
|
||||
// Win32_Printer JobCountSinceLastReset is PRINTER_INFO_2.cJobs, the number of queued jobs.
|
||||
ch <- prometheus.MustNewConstMetric(
|
||||
c.printerJobCount,
|
||||
prometheus.CounterValue,
|
||||
float64(printer.Jobs),
|
||||
printer.Name,
|
||||
)
|
||||
|
||||
jobs, err := printerJobs(printer)
|
||||
if err != nil {
|
||||
errs = append(errs, fmt.Errorf("failed to enumerate jobs of printer %s: %w", printer.Name, err))
|
||||
|
||||
continue
|
||||
}
|
||||
|
||||
currentStatus := printerStatus(printer.Status, jobs)
|
||||
|
||||
for status, statusName := range printerStatusMap {
|
||||
isCurrentStatus := 0.0
|
||||
if printerStatus == printer.PrinterStatus {
|
||||
if status == currentStatus {
|
||||
isCurrentStatus = 1.0
|
||||
}
|
||||
|
||||
@@ -236,62 +207,128 @@ func (c *Collector) collectPrinterStatus(ch chan<- prometheus.Metric, maxScrapeD
|
||||
prometheus.GaugeValue,
|
||||
isCurrentStatus,
|
||||
printer.Name,
|
||||
printerStatusName,
|
||||
statusName,
|
||||
)
|
||||
}
|
||||
|
||||
ch <- prometheus.MustNewConstMetric(
|
||||
c.printerJobCount,
|
||||
prometheus.CounterValue,
|
||||
float64(printer.JobCountSinceLastReset),
|
||||
printer.Name,
|
||||
)
|
||||
for status, count := range groupJobsByStatus(jobs) {
|
||||
ch <- prometheus.MustNewConstMetric(
|
||||
c.printerJobStatus,
|
||||
prometheus.GaugeValue,
|
||||
float64(count),
|
||||
printer.Name,
|
||||
status,
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
return errors.Join(errs...)
|
||||
}
|
||||
|
||||
func (c *Collector) collectPrinterJobStatus(ch chan<- prometheus.Metric, maxScrapeDuration time.Duration) error {
|
||||
var printJobs []wmiPrintJob
|
||||
if err := c.miSession.Query(&printJobs, mi.NamespaceRootCIMv2, c.miQueryPrinterJobs, maxScrapeDuration); err != nil {
|
||||
return fmt.Errorf("WMI query failed: %w", err)
|
||||
// printerJobs returns the jobs of the printer in queue order.
|
||||
func printerJobs(printer winspool.Printer) (_ []winspool.Job, err error) {
|
||||
// Skip OpenPrinter for an empty queue. For a printer connection, it can contact the print server.
|
||||
if printer.Jobs == 0 {
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
groupedPrintJobs := c.groupPrintJobs(printJobs)
|
||||
for group, count := range groupedPrintJobs {
|
||||
ch <- prometheus.MustNewConstMetric(
|
||||
c.printerJobStatus,
|
||||
prometheus.GaugeValue,
|
||||
float64(count),
|
||||
group.printerName,
|
||||
group.status,
|
||||
)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
type PrintJobStatusGroup struct {
|
||||
printerName string
|
||||
status string
|
||||
}
|
||||
|
||||
func (c *Collector) groupPrintJobs(printJobs []wmiPrintJob) map[PrintJobStatusGroup]int {
|
||||
groupedPrintJobs := make(map[PrintJobStatusGroup]int)
|
||||
|
||||
for _, printJob := range printJobs {
|
||||
printerName, _, _ := strings.Cut(printJob.Name, ",")
|
||||
|
||||
if c.config.PrinterExclude.MatchString(printerName) ||
|
||||
!c.config.PrinterInclude.MatchString(printerName) {
|
||||
continue
|
||||
handle, err := winspool.OpenPrinter(printer.Name)
|
||||
if err != nil {
|
||||
// The printer was deleted after EnumPrinters.
|
||||
if errors.Is(err, windows.ERROR_INVALID_PRINTER_NAME) {
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
groupedPrintJobs[PrintJobStatusGroup{
|
||||
printerName: printerName,
|
||||
status: printJob.Status,
|
||||
}]++
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return groupedPrintJobs
|
||||
defer func() {
|
||||
err = errors.Join(err, winspool.ClosePrinter(handle))
|
||||
}()
|
||||
|
||||
return winspool.EnumJobs(handle)
|
||||
}
|
||||
|
||||
// printerStatus returns the Win32_Printer PrinterStatus value for PRINTER_INFO_2.Status,
|
||||
// mapped the same way as the CIMWin32 provider (cimwin32.dll).
|
||||
//
|
||||
// CIMWin32 compares the whole Status value with single PRINTER_STATUS_* flags.
|
||||
// For 0 and for combinations of flags, it uses the first job in the queue instead.
|
||||
// It never reports Stopped Printing (6) or Offline (7); an offline printer is Other (1).
|
||||
func printerStatus(status uint32, jobs []winspool.Job) uint16 {
|
||||
switch status {
|
||||
case winspool.PRINTER_STATUS_PAUSED,
|
||||
winspool.PRINTER_STATUS_ERROR,
|
||||
winspool.PRINTER_STATUS_PENDING_DELETION,
|
||||
winspool.PRINTER_STATUS_PAPER_JAM,
|
||||
winspool.PRINTER_STATUS_PAPER_OUT,
|
||||
winspool.PRINTER_STATUS_MANUAL_FEED,
|
||||
winspool.PRINTER_STATUS_PAPER_PROBLEM,
|
||||
winspool.PRINTER_STATUS_OFFLINE,
|
||||
winspool.PRINTER_STATUS_OUTPUT_BIN_FULL,
|
||||
winspool.PRINTER_STATUS_TONER_LOW,
|
||||
winspool.PRINTER_STATUS_NO_TONER,
|
||||
winspool.PRINTER_STATUS_PAGE_PUNT,
|
||||
winspool.PRINTER_STATUS_USER_INTERVENTION,
|
||||
winspool.PRINTER_STATUS_OUT_OF_MEMORY,
|
||||
winspool.PRINTER_STATUS_DOOR_OPEN:
|
||||
return printerStatusOther
|
||||
case winspool.PRINTER_STATUS_IO_ACTIVE,
|
||||
winspool.PRINTER_STATUS_BUSY,
|
||||
winspool.PRINTER_STATUS_PRINTING,
|
||||
winspool.PRINTER_STATUS_PROCESSING:
|
||||
return printerStatusPrinting
|
||||
case winspool.PRINTER_STATUS_NOT_AVAILABLE:
|
||||
return printerStatusUnknown
|
||||
case winspool.PRINTER_STATUS_WAITING,
|
||||
winspool.PRINTER_STATUS_SERVER_UNKNOWN,
|
||||
winspool.PRINTER_STATUS_POWER_SAVE:
|
||||
return printerStatusIdle
|
||||
case winspool.PRINTER_STATUS_INITIALIZING,
|
||||
winspool.PRINTER_STATUS_WARMING_UP:
|
||||
return printerStatusWarmup
|
||||
}
|
||||
|
||||
if len(jobs) == 0 {
|
||||
return printerStatusIdle
|
||||
}
|
||||
|
||||
job := jobs[0]
|
||||
|
||||
switch {
|
||||
case job.StatusText != "":
|
||||
return printerStatusUnknown
|
||||
case job.Status&(winspool.JOB_STATUS_PAUSED|winspool.JOB_STATUS_ERROR|winspool.JOB_STATUS_DELETING|
|
||||
winspool.JOB_STATUS_OFFLINE|winspool.JOB_STATUS_PAPEROUT|winspool.JOB_STATUS_PRINTED) != 0:
|
||||
return printerStatusOther
|
||||
case job.Status&(winspool.JOB_STATUS_SPOOLING|winspool.JOB_STATUS_PRINTING) != 0:
|
||||
return printerStatusPrinting
|
||||
default:
|
||||
return printerStatusUnknown
|
||||
}
|
||||
}
|
||||
|
||||
// jobStatus returns the Win32_PrintJob Status value for JOB_INFO_1.Status,
|
||||
// mapped the same way as the CIMWin32 provider (cimwin32.dll).
|
||||
func jobStatus(status uint32) string {
|
||||
switch {
|
||||
case status&winspool.JOB_STATUS_ERROR != 0:
|
||||
return "Error"
|
||||
case status&(winspool.JOB_STATUS_PAUSED|winspool.JOB_STATUS_OFFLINE|winspool.JOB_STATUS_PAPEROUT) != 0:
|
||||
return "Degraded"
|
||||
case status&(winspool.JOB_STATUS_DELETING|winspool.JOB_STATUS_SPOOLING|winspool.JOB_STATUS_PRINTING|winspool.JOB_STATUS_PRINTED) != 0:
|
||||
return "OK"
|
||||
default:
|
||||
return "UNKNOWN"
|
||||
}
|
||||
}
|
||||
|
||||
func groupJobsByStatus(jobs []winspool.Job) map[string]int {
|
||||
groupedJobs := make(map[string]int)
|
||||
|
||||
for _, job := range jobs {
|
||||
groupedJobs[jobStatus(job.Status)]++
|
||||
}
|
||||
|
||||
return groupedJobs
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user