Created Date: Oct 07, 2020 11:13
Last Modifed Date: Feb 19, 2021 10:18

ScreenPro Direct offers two optional ways for the user to gain insight into the operation of its pipeline:

  1. Pipeline metrics: Metrics collected during a Print Run that are output in CSV files when ScreenPro Direct exits.
  2. Pipeline logging: Console output emitted several times per second, showing the current state of the pipeline.

Pipeline metrics

ScreenPro Direct is able to collect various pipeline metrics during a Print Run. When a MetricsDirectory has been specified, CSV files are output to that directory when ScreenPro Direct exits. Each of these files has the same column headings and represents either a different stage or plugin thread or some consolidation of them. (The one with everything is called full_report.csv.)

The headings are:

Stage Index: The stage of the plugin pipeline, counting up from 0. Stage 0 will therefore usually be the Preload Plugin.

Thread Index: The thread instance of the plugin, counting up from 0.

Job Id: When you send a single raster with multiple copies, each copy is considered a new job, by default, so each value here should only appear once per plugin. With two threads for a given stage, you can expect all even jobs to go to one thread and odd jobs to the other.

Page Id: When raster filenames are supplied within an XML file, each filename is considered a different page within the job.

Plane Id: The plane this page is destined for. Plane numbers start at 1.

Data Length: The size in bytes of the raster being sent in the page.

Input Gap: The time in microseconds between finishing with the previous task and starting to process this one.

Reorder Time: The total time spent reordering.

Miss Count: Number of times a raster has been out of order.

Processing Time: The time in microseconds that it took for this plugin thread to completely process the task.

Throughput: Calculated from the Data Length divided by Processing Time.

Total Time: Input Gap + Reorder Time + Processing Time.

Pipeline logging

When PipelineLogging is set to 1 in your config file, the current state of ScreenPro Direct's pipeline is printed to the screen as a single line of text several times per second.

Within that line, for each plugin, the name of the plugin, the number of items in its queue, and the average throughput for the run in MB/s (separated by a colon) is displayed

For a five-stage pipeline outputting to Tiff, you can expect to see several lines like the following until the first image is received:

PreloadPlugin:0:0 InputPlugin:0:0 ScreeningPlugin:0:0 PackPlugin:0:0 TiffOutputPlugin:0:0

Once there are rasters in the pipeline being processed by each plugin, you might see something like this:

PreloadPlugin:1:4512 InputPlugin:6:1337 ScreeningPlugin:2:1330 PackPlugin:2:165 TiffOutputPlugin:0:164

In the example above:

  • The Preload Plugin has one item in its queue and has managed 4512 MB/s since the run began.
  • The Input Plugin has six items in its queue and has processed 1337 MB/s on average so far.
  • The Screening Plugin has two items in its queue, and so on.