Imaging Overview

This dashboard provides a consolidated, near real-time view of imaging job activity, throughput, and outcomes across your Relativity environment. It tracks how imaging jobs move through the pipeline - from submission, to pickup by the request agent, to completion - and summarizes the documents and images produced, the mix of imaging job types, and the success/error/skip breakdown of processed documents. It helps administrators validate that imaging is processing efficiently, detect stalled or failing jobs, understand which file types drive volume or warnings, and confirm imaging health after installations, upgrades, or configuration changes.

Availability

The Imaging Overview dashboard is available in Relativity Server 2026 and later. Its visualizations depend on imaging instrumentation shipped with the server and its built-in applications. If the dashboard loads empty, the target environment does not yet include the required imaging instrumentation, or no imaging activity occurred in the selected time range.

Prerequisites

• Environment Watch is installed and the Elastic/Kibana stack is receiving telemetry from the target Relativity Server.
• The Relativity Server is version 2026+ so that imaging OpenTelemetry (OTEL) metrics are emitted.
• Imaging jobs have run within the selected time range so that the panels have data to display.

Navigation

The Imaging Overview is part of the Document Transformation feature domain, which also includes the Document Transformation, OCR, PDF, and Production overviews. A tab strip at the top of the dashboard lets you switch between these related views:

• Document Transformation Overview
• Imaging Overview
• OCR Overview
• PDF Overview
• Production Overview

A left-hand navigation panel provides quick links to other Environment Watch feature domains (Platform, Applications, Logs/Searches/Alerts), making it easy to move between imaging and adjacent areas such as Processing, Review, and Monitoring.

Filters and Time Range

• Time range - Use the time picker in the top-right to scope every panel to a specific window. The dashboard does not save a fixed time range, so it opens with your Kibana default (or last-used) range; set the window you need and all visualizations respect the selected range.
• KQL filter bar - Use the query bar to narrow results with Kibana Query Language (for example, by host or job type field) and add ad-hoc filters. Filters apply across all panels on the tab.

Job Activity and Throughput Summary

The metric tiles across the top of the dashboard summarize imaging job flow and output for the selected time range:

• Jobs Completed - Total number of imaging jobs that finished.
• Jobs Submitted - Total number of imaging jobs submitted to the queue.
• Jobs Picked Up by Request Agent - Total number of jobs picked up for processing by the request agent. Comparing this with Jobs Submitted and Jobs Completed reveals whether jobs are being drained from the queue and finishing as expected.
• Documents Processed - Total documents processed across completed imaging jobs.
• Images Produced - Total images generated across completed imaging jobs.
• Job Duration (Avg) - Average end-to-end duration of a completed imaging job, giving a quick read on processing performance.

Large values are automatically formatted into compact, human-readable form (for example, 1.2k, 3.4M) for consistency with the other Environment Watch dashboards.

The Imaging - Job Queue Composition donut shows the distribution of imaging jobs by job type for the period, with the total job count displayed in the center. Job types include:

• ImageOnTheFly - On-the-fly (single document) imaging requests.
• ImagingSet - Imaging set jobs.
• MassImaging - Mass imaging jobs.
• RetryImagingSet - Retried imaging set jobs.
• Stop - Stop/cancel requests.

This breakdown helps administrators understand what kind of imaging work dominates the environment and spot unexpected spikes in retries or mass operations.

Document Outcomes and Warnings

The Imaging - Document Outcome donut summarizes the result of processed documents as a percentage of the total, with the imaged percentage highlighted in the center and the total document count shown beneath the chart:

• Imaged - Documents successfully imaged.
• Errored - Documents that failed during imaging.
• Skipped - Documents skipped during imaging.

This visualization provides an at-a-glance measure of imaging quality and reliability. A rising Errored slice is an early signal of file-type, configuration, or resource issues that warrant investigation.

The Imaging - Warnings by File Type table lists file types that generated imaging warnings, along with the count of cut-off image warnings for each. It helps pinpoint problematic content types (for example, oversized emails or images) that may need rendering or configuration attention.

File Type Detail and Throughput Trend

The Imaging - Documents by File Type table breaks imaging results down per file type and processing machine, including:

• File Type - The Invariant/Relativity native file type.
• Machine - The host/worker that processed the documents.
• Docs - Number of documents processed for that file type.
• Images - Number of images produced.
• Errors - Number of documents that errored.
• Avg (s) - Average imaging time in seconds for that file type.

This granular view is useful for identifying which content types are slow, error-prone, or high-volume, and for comparing performance across worker machines. The table is paginated for environments with many file types.

The Imaging - Documents / Minute line chart plots document imaging throughput over time. It reveals demand patterns, ramp-up and ramp-down behavior, and dips or plateaus that may indicate contention, throttling, or stalled processing.

Metrics Reference

The dashboard is powered by the following imaging OpenTelemetry (OTEL) metrics and their associated label fields.

OTEL metrics

OTEL metric	Description
relsvr.imaging.job_submission	An imaging job was submitted to the queue.
relsvr.imaging.job_picked_up_by_request_agent	A request agent picked up a job to process.
relsvr.imaging.job_started	An imaging job started running.
relsvr.imaging.job_completed	An imaging job finished.
relsvr.imaging.warning_created	An imaging warning was raised (e.g., cut-off image).
relsvr.imaging.status_per_invariant_file_type	Imaging results grouped by Invariant file type.
relsvr.imaging.status_per_relativity_native_type	Imaging results grouped by Relativity native type.

Label fields

Field	Description
labels.Imaging_JobType	Type of imaging job (MassImage, ImageDocument, ImagingSet, RetryImagingSet, Stop).
labels.Imaging_Documents_Total	Number of documents processed by a job.
labels.Imaging_Images_Total	Number of images produced by a job.
labels.Imaging_TotalTimeInSeconds	Time taken by a job, in seconds.
labels.Imaging_Documents_Imaged	Documents imaged successfully.
labels.Imaging_Documents_Errored	Documents that failed imaging.
labels.Imaging_Documents_Skipped	Documents skipped during imaging.
labels.Imaging_FileType	File type associated with a warning.
labels.Imaging_TotalCutOffImageWarnings	Count of cut-off image warnings.
labels.Imaging_DocumentTotal	Documents processed per file type.
labels.Imaging_ImagesTotal	Images produced per file type.
labels.Imaging_ErrorTotal	Errors per file type.
labels.Imaging_AverageImagingTime	Average imaging time per file type.

Panel-to-metric mapping

Panel	Type	Metric(s)	Key fields
Jobs Completed	Metric	relsvr.imaging.job_completed	count
Jobs Submitted	Metric	relsvr.imaging.job_submission	count
Jobs Picked Up by Request Agent	Metric	relsvr.imaging.job_picked_up_by_request_agent	count
Documents Processed	Metric	relsvr.imaging.job_completed	sum of Imaging_Documents_Total
Images Produced	Metric	relsvr.imaging.job_completed	sum of Imaging_Images_Total
Job Duration (Avg)	Metric	relsvr.imaging.job_completed	avg of Imaging_TotalTimeInSeconds
Imaging - Job Queue Composition	Donut	relsvr.imaging.job_started	grouped by Imaging_JobType
Imaging - Document Outcome	Donut	relsvr.imaging.job_completed	Imaging_Documents_Imaged, Imaging_Documents_Errored, Imaging_Documents_Skipped
Imaging - Warnings by File Type	Table	relsvr.imaging.warning_created	Imaging_FileType, Imaging_TotalCutOffImageWarnings
Imaging - Documents by File Type	Table	relsvr.imaging.status_per_invariant_file_type, relsvr.imaging.status_per_relativity_native_type	Imaging_DocumentTotal, Imaging_ImagesTotal, Imaging_ErrorTotal, Imaging_AverageImagingTime
Imaging - Documents / Minute	Line	relsvr.imaging.job_completed	Imaging_Documents_Total over time

Use Cases

Use Case	Description
Monitor imaging throughput	Track jobs submitted, picked up, and completed along with documents and images produced to confirm imaging is keeping pace with demand.
Detect queue backlog or stalls	Compare Jobs Submitted, Jobs Picked Up by Request Agent, and Jobs Completed to identify jobs that are queued but not draining or completing.
Assess imaging quality	Use the Document Outcome donut to watch the imaged/errored/skipped mix and catch rising error rates early.
Isolate problematic file types	Review the Documents by File Type and Warnings by File Type tables to find content types that are slow, error-prone, or generating cut-off image warnings.
Analyze workload composition	Use the Job Queue Composition donut to understand the balance between on-the-fly, imaging set, mass imaging, and retry work.
Validate post-install/upgrade health	After a deployment or configuration change, confirm imaging jobs complete successfully and durations remain within expected ranges.
Investigate performance trends	Use the Documents / Minute chart and Job Duration (Avg) to correlate throughput dips or duration spikes with load or resource constraints.

Associated Alerts

No imaging-specific Environment Watch alerts are currently associated with this dashboard. This section will be updated as imaging alerts are published.