Metrics¶
The services of Local Spooler expose several custom metrics that provide insights into their operation and performance and can help to identify any potential issues. These metrics are exposed at the /metrics endpoint of each service and can be scraped by Prometheus. You can visualize them by using tools like Grafana to create dashboards that provide a real-time view of the system's performance.
Following is a brief overview of the custom metrics for each service. For in depth information, refer to Custom Metrics JSON below.
For more information about the overall health of your servers, refer to Default Metrics.
Custom Service Metrics¶
seal-checkin¶
The seal-checkin service is the entry point for LPR jobs. It exposes the following custom metrics additionally:
-
out_ngn_bytes_total: This counter metric represents the total number of bytes received by the service. -
out_ngn_duration_seconds: This histogram metric represents the duration of the processing time in seconds. -
out_ngn_documents_total: This counter metric represents the total number of documents processed by the service.
seal-checkout¶
The seal-checkout service is responsible for sending the print job to the printer. It exposes the following custom metrics additionally:
-
out_ngn_bytes_total: This counter metric represents the total number of bytes received by the service. -
out_ngn_duration_seconds: This histogram metric represents the duration of the processing time in seconds. -
out_ngn_documents_total: This counter metric represents the total number of documents processed by the service.
seal-co-notifier¶
The seal-co-notifier sends job status notifications to SAP and IPP backend systems. It exposes the following custom metrics additionally:
-
out_ngn_sap_notifications_total: This counter metric represents the total number of successfully sent SAP notifications. Thedestinationlabel indicates the SAP system destination of the notification. Thenotification_typelabel is eitherjobordevice. -
out_ngn_sap_function_calls_total: This counter metric represents the total number of function calls to a SAP system. Thedestinationlabel indicates the SAP system destination of the function call. Thefunctionlabel indicates the function name.
seal-convert-dispatcher¶
The seal-convert-dispatcher service dispatches document conversions to other convert services. It exposes the following custom metrics additionally:
-
out_ngn_documents_total: This counter metric represents the total number of documents processed by the service. -
out_ngn_jobs_per_state_total: This counter metric represents the total number of jobs per state. It has a labelstatewhich indicates the state of the job. -
out_ngn_printer_locks: This gauge metric represents the number of printer locks per service.
seal-housekeeper¶
The seal-housekeeper service is responsible for cleaning up old print jobs. It exposes the following custom metrics additionally:
-
out_ngn_jobs_deleted_total: This counter metric represents the total number of deleted jobs from the database. -
out_ngn_files_deleted_total: This counter metric represents the total number of deleted files from the database. -
out_ngn_chunks_deleted_total: This counter metric represents the total number of deleted chunks from the database. -
out_ngn_notifications_deleted_total: This counter metric represents the total number of deleted notifications from the database. -
out_ngn_locks_deleted_total: This counter metric represents the total number of deleted locks from the database.
seal-ipp-checkin¶
The seal-ipp-checkin service is the entry point for IPP jobs. It exposes the following custom metrics additionally:
-
out_ngn_bytes_total: This counter metric represents the total number of bytes received by the service. -
out_ngn_documents_total: This counter metric represents the total number of documents processed by the service. -
out_ngn_duration_seconds: This histogram metric represents the duration of the processing time in seconds. -
out_ngn_job_filesize_bytes: This histogram metric represents the filesize of incoming jobs in bytes.
seal-job-notifier¶
The seal-job-notifier service sends job status notifications to the configured destinations. It exposes the following custom metrics additionally:
out_ngn_rest_notifications_total: This counter metric represents the total number of successfully sent REST notifications.
seal-out-ngn-message-relay¶
The seal-out-ngn-message-relay service is a relay service for the transactional outbox pattern. It exposes the following custom metrics additionally:
out_ngn_message_relay_total: This counter metric represents the total number of messages relayed by the service. Thenotification_typelabel indicates the type of the relayed message, which can bejoborprinter.
Other services like seal-rest do not expose custom metrics but can be monitored using the default metrics.
Custom Metrics JSON¶
[
{
"service": "seal-checkin",
"metricsUrl": "https://<host>:1948/metrics",
"metrics": [
{
"name": "out_ngn_bytes_total",
"help": "Total number of bytes processed by the service",
"type": "counter"
},
{
"name": "out_ngn_documents_total",
"help": "Total number of documents processed by the service",
"type": "counter"
},
{
"name": "out_ngn_duration_seconds",
"help": "Duration of document processing",
"type": "histogram"
}
]
},
{
"service": "seal-checkout",
"metricsUrl": "https://<host>:1998/metrics",
"metrics": [
{
"name": "out_ngn_bytes_total",
"help": "Total number of bytes processed by the service",
"type": "counter"
},
{
"name": "out_ngn_duration_seconds",
"help": "Duration of document processing",
"type": "histogram"
},
{
"name": "out_ngn_documents_total",
"help": "Total number of documents processed by the service",
"type": "counter"
}
]
},
{
"service": "seal-co-notifier",
"metricsUrl": "https://<host>:2098/metrics",
"metrics": [
{
"name": "out_ngn_sap_notifications_total",
"help": "Counter for successfully sent SAP notifications",
"type": "counter",
"labels": [
"destination", "notification_type"
]
},
{
"name": "out_ngn_sap_function_calls_total",
"help": "Counter for function calls to SAP system",
"type": "counter",
"labels": [
"destination", "function"
]
}
]
},
{
"service": "seal-controller",
"metricsUrl": "https://<host>:1969/metrics",
"metrics": [
{
"name": "out_ngn_documents_total",
"help": "Total number of documents processed by the service",
"type": "counter"
},
{
"name": "out_ngn_jobs_per_state",
"help": "Total number of jobs per state",
"type": "counter",
"labels": [
"state"
]
},
{
"name": "out_ngn_printer_locks",
"help": "Gauge for printer locks per service",
"type": "gauge"
},
{
"name": "out_ngn_printer_queue_length",
"help": "Gauge for printer queue length",
"type": "gauge",
"labels": [
"printername"
]
}
]
},
{
"service": "seal-convert-dispatcher",
"metricsUrl": "https://<host>:1958/metrics",
"metrics": [
{
"name": "out_ngn_documents_total",
"help": "Total number of documents processed by the service",
"type": "counter"
},
{
"name": "out_ngn_jobs_per_state",
"help": "Total number of jobs per state",
"type": "counter",
"labels": [
"state"
]
},
{
"name": "out_ngn_printer_locks",
"help": "Gauge for printer locks per service",
"type": "gauge"
}
]
},
{
"service": "seal-housekeeper",
"metricsUrl": "https://<host>:2198/metrics",
"metrics": [
{
"name": "out_ngn_jobs_deleted_total",
"help": "Number of jobs deleted from the database",
"type": "counter"
},
{
"name": "out_ngn_files_deleted_total",
"help": "Number of files deleted from the database",
"type": "counter"
},
{
"name": "out_ngn_chunks_deleted_total",
"help": "Number of chunks deleted from the database",
"type": "counter"
},
{
"name": "out_ngn_notifications_deleted_total",
"help": "Number of notifications deleted from the database",
"type": "counter"
},
{
"name": "out_ngn_locks_deleted_total",
"help": "Number of locks deleted from the database",
"type": "counter"
}
]
},
{
"service": "seal-ipp-checkin",
"metricsUrl": "https://<host>:632/metrics",
"metrics": [
{
"name": "out_ngn_bytes_total",
"help": "Total number of bytes processed by the service",
"type": "counter"
},
{
"name": "out_ngn_documents_total",
"help": "Total number of documents processed by the service",
"type": "counter"
},
{
"name": "out_ngn_duration_seconds",
"help": "Duration of document processing",
"type": "histogram"
},
{
"name": "out_ngn_job_filesize_bytes",
"help": "Histogram for filesize of incoming jobs",
"type": "histogram"
}
]
},
{
"service": "seal-job-notifier",
"metricsUrl": "https://<host>:8082/metrics",
"metrics": [
{
"name": "out_ngn_rest_notifications_total",
"help": "Counter for successfully sent REST notifications",
"type": "counter",
"labels": [
"destination"
]
}
]
},
{
"service": "seal-out-ngn-message-relay",
"metricsUrl": "https://<host>:2068/metrics",
"metrics": [
{
"name": "out_ngn_message_relay_total",
"help": "Total number of sent message from out_ngn message relay",
"type": "counter",
"labels": [
"notification_type"
]
}
]
},
{
"service": "seal-rest",
"metricsUrl": "https://<host>:8080/metrics",
"metrics": []
}
]
Default Metrics¶
Additionally to the custom metrics provided by the services, you can utilize the standard metrics provided by the Node.js prom-client to measure the overall health of your servers.
[
{
"name": "process_cpu_user_seconds_total",
"help": "Total user CPU time spent in seconds.",
"type": "counter"
},
{
"name": "process_cpu_system_seconds_total",
"help": "Total system CPU time spent in seconds.",
"type": "counter"
},
{
"name": "process_cpu_seconds_total",
"help": "Total user and system CPU time spent in seconds.",
"type": "counter"
},
{
"name": "process_start_time_seconds",
"help": "Start time of the process since unix epoch in seconds.",
"type": "gauge"
},
{
"name": "process_resident_memory_bytes",
"help": "Resident memory size in bytes.",
"type": "gauge"
},
{
"name": "process_virtual_memory_bytes",
"help": "Virtual memory size in bytes.",
"type": "gauge"
},
{
"name": "process_heap_bytes",
"help": "Process heap size in bytes.",
"type": "gauge"
},
{
"name": "process_open_fds",
"help": "Number of open file descriptors.",
"type": "gauge"
},
{
"name": "process_max_fds",
"help": "Maximum number of open file descriptors.",
"type": "gauge"
},
{
"name": "nodejs_eventloop_lag_seconds",
"help": "Lag of event loop in seconds.",
"type": "gauge"
},
{
"name": "nodejs_eventloop_lag_min_seconds",
"help": "The minimum recorded event loop delay.",
"type": "gauge"
},
{
"name": "nodejs_eventloop_lag_max_seconds",
"help": "The maximum recorded event loop delay.",
"type": "gauge"
},
{
"name": "nodejs_eventloop_lag_mean_seconds",
"help": "The mean of the recorded event loop delays.",
"type": "gauge"
},
{
"name": "nodejs_eventloop_lag_stddev_seconds",
"help": "The standard deviation of the recorded event loop delays.",
"type": "gauge"
},
{
"name": "nodejs_eventloop_lag_p50_seconds",
"help": "The 50th percentile of the recorded event loop delays.",
"type": "gauge"
},
{
"name": "nodejs_eventloop_lag_p90_seconds",
"help": "The 90th percentile of the recorded event loop delays.",
"type": "gauge"
},
{
"name": "nodejs_eventloop_lag_p99_seconds",
"help": "The 99th percentile of the recorded event loop delays.",
"type": "gauge"
},
{
"name": "nodejs_active_resources",
"help": "Number of active resources that are currently keeping the event loop alive, grouped by async resource type.",
"type": "gauge",
"labels": [
"type"
]
},
{
"name": "nodejs_active_resources_total",
"help": "Total number of active resources.",
"type": "gauge"
},
{
"name": "nodejs_active_handles",
"help": "Number of active libuv handles grouped by handle type. Every handle type is C++ class name.",
"type": "gauge",
"labels": [
"type"
]
},
{
"name": "nodejs_active_handles_total",
"help": "Total number of active handles.",
"type": "gauge"
},
{
"name": "nodejs_active_requests",
"help": "Number of active libuv requests grouped by request type. Every request type is C++ class name.",
"type": "gauge",
"labels": [
"type"
]
},
{
"name": "nodejs_active_requests_total",
"help": "Total number of active requests.",
"type": "gauge"
},
{
"name": "nodejs_heap_size_total_bytes",
"help": "Process heap size from Node.js in bytes.",
"type": "gauge"
},
{
"name": "nodejs_heap_size_used_bytes",
"help": "Process heap size used from Node.js in bytes.",
"type": "gauge"
},
{
"name": "nodejs_external_memory_bytes",
"help": "Nodejs external memory size in bytes.",
"type": "gauge"
},
{
"name": "nodejs_heap_space_size_total_bytes",
"help": "Process heap space size total from Node.js in bytes.",
"type": "gauge",
"labels": [
"space"
]
},
{
"name": "nodejs_heap_space_size_used_bytes",
"help": "Process heap space size used from Node.js in bytes.",
"type": "gauge",
"labels": [
"space"
]
},
{
"name": "nodejs_heap_space_size_available_bytes",
"help": "Process heap space size available from Node.js in bytes.",
"type": "gauge",
"labels": [
"space"
]
},
{
"name": "nodejs_version_info",
"help": "Node.js version info.",
"type": "gauge",
"labels": [
"version",
"major",
"minor",
"patch",
"release",
"lts"
]
},
{
"name": "nodejs_gc_duration_seconds",
"help": "Garbage collection duration by kind, one of major, minor, incremental or weakcb.",
"type": "histogram",
"labels": [
"kind"
]
},
{
"name": "http_request_duration_seconds",
"help": "duration histogram of http responses labeled with: status_code, method, path",
"type": "histogram",
"labels": [
"status_code",
"method",
"path"
]
},
{
"name": "up",
"help": "1 = up, 0 = not up",
"type": "gauge"
}
]