Type Members

1.  class MetricsAggregator[KeyT] extends AnyRef

   Collects/aggregates metrics across multiple process calls and workflow executions

2.  case class MetricsCSVFileOutput[KeyT](path: String, prefix: String, separator: String = ",") extends MetricsStringOutput[KeyT] with FileOutput with Product with Serializable

   Outputs metrics to files using a standard CSV format.

   Outputs metrics to files using a standard CSV format. Generates 2 CSV files: 1. one for processes with a "-tasks.csv" suffix, 2. and one for workflows with a "-workflows.csv" suffix.

   KeyT

   the type used for workflow IDs

   path

   path to directory where the files will be placed

   prefix

   file name prefix

   separator

   a string to separate values, defaulting to a comma

3.  case class MetricsD3Timeline[KeyT](path: String, file: String) extends MetricsOutput[KeyT] with FileOutput with MetricsFormatting with Product with Serializable

   Outputs metrics to a file using the d3-timeline format.

   Outputs metrics to a file using the d3-timeline format. Generates 1 file with a "-data.js" suffix. This can then be combined with the resources at https://github.com/workflowfm/d3-workflow-timeline to render the timeline in a browser.

   KeyT

   the type used for workflow IDs

   path

   path to directory where the files will be placed

   file

   file name prefix

4.  trait MetricsFormatting extends AnyRef

   Contains helpful formatting shortcut functions.

5.  class MetricsHandler[KeyT] extends MetricsAggregator[KeyT] with PiEventHandler[KeyT]

   A MetricsAggregator that is also a com.workflowfm.pew.stream.PiEventHandler.

   A MetricsAggregator that is also a com.workflowfm.pew.stream.PiEventHandler. Aggregates metrics automatically based on PiEvents and system time.

6.  trait MetricsOutput[KeyT] extends (MetricsAggregator[KeyT]) ⇒ Unit

   Manipulates a MetricsAggregator to produce some output via side-effects.

   Manipulates a MetricsAggregator to produce some output via side-effects.

   KeyT

   the type used for workflow IDs

7.  case class MetricsOutputs[KeyT](handlers: Queue[MetricsOutput[KeyT]]) extends MetricsOutput[KeyT] with Product with Serializable

   A MetricsOutput consisting of a scala.collection.immutable.Queue of MetricsOutputs to be run sequentially.

8.  case class MetricsPrinter[KeyT](separator: String = "\t| ", timeFormat: Some[String] = Some("YYYY-MM-dd HH:mm:ss.SSS")) extends MetricsStringOutput[KeyT] with Product with Serializable

   Prints all metrics to standard output.

   Prints all metrics to standard output.

   separator

   A string to separate values.

   timeFormat

   An optional time format using java.text.SimpleDateFormat

9.  trait MetricsStringOutput[KeyT] extends MetricsOutput[KeyT] with MetricsFormatting

   Generates a string representation of the metrics using a generalized CSV format.

10.  case class ProcessMetrics[KeyT](piID: KeyT, ref: Int, process: String, start: Long, finish: Option[Long], result: Option[String]) extends Product with Serializable

    Metrics for a particular instance of an atomic process.

    Metrics for a particular instance of an atomic process.

    KeyT

    the type used for workflow IDs

    piID

    the ID of the workflow that executed this process

    ref

    the call reference for that process, i.e. a unique call ID for this particular workflow

    process

    the name of the process

    start

    the system time in milliseconds when the process call started

    finish

    the system time in milliseconds that the process call finished, or scala.None if it is still running

    result

    a String representation of the returned result from the process call, or scala.None if it still running. In case of failure, the field is populated with the localized message of the exception thrown

11.  case class WorkflowMetrics[KeyT](piID: KeyT, start: Long, calls: Int, finish: Option[Long], result: Option[String]) extends Product with Serializable

    Metrics for a particular workflow.

    Metrics for a particular workflow.

    KeyT

    the type used for workflow IDs

    piID

    the unique ID of the workflow.

    start

    the system time in milliseconds when the workflow started executing

    calls

    the number of calls to atomic processes

    finish

    the system time in milliseconds that this workflow finished, or scala.None if it is still running

    result

    a String representation of the returned result from the workflow, or scala.None if it still running. In case of failure, the field is populated with the localized message of the exception thrown