c

com.workflowfm.pew.metrics

MetricsCSVFileOutput

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. 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

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MetricsCSVFileOutput
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. FileOutput
  7. MetricsStringOutput
  8. MetricsFormatting
  9. MetricsOutput
  10. Function1
  11. AnyRef
  12. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new MetricsCSVFileOutput(path: String, prefix: String, separator: String = ",")

    path

    path to directory where the files will be placed

    prefix

    file name prefix

    separator

    a string to separate values, defaulting to a comma

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from MetricsCSVFileOutput[KeyT] to any2stringadd[MetricsCSVFileOutput[KeyT]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (MetricsCSVFileOutput[KeyT], B)
    Implicit
    This member is added by an implicit conversion from MetricsCSVFileOutput[KeyT] to ArrowAssoc[MetricsCSVFileOutput[KeyT]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def and(h: MetricsOutput[KeyT]): MetricsOutputs[KeyT]

    Compose with another MetricsOutput in sequence.

    Compose with another MetricsOutput in sequence.

    Definition Classes
    MetricsOutput
  7. def andThen[A](g: (Unit) ⇒ A): (MetricsAggregator[KeyT]) ⇒ A
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  8. def apply(aggregator: MetricsAggregator[KeyT]): Unit
    Definition Classes
    MetricsCSVFileOutput → Function1
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  11. def compose[A](g: (A) ⇒ MetricsAggregator[KeyT]): (A) ⇒ Unit
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  12. def ensuring(cond: (MetricsCSVFileOutput[KeyT]) ⇒ Boolean, msg: ⇒ Any): MetricsCSVFileOutput[KeyT]
    Implicit
    This member is added by an implicit conversion from MetricsCSVFileOutput[KeyT] to Ensuring[MetricsCSVFileOutput[KeyT]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (MetricsCSVFileOutput[KeyT]) ⇒ Boolean): MetricsCSVFileOutput[KeyT]
    Implicit
    This member is added by an implicit conversion from MetricsCSVFileOutput[KeyT] to Ensuring[MetricsCSVFileOutput[KeyT]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: ⇒ Any): MetricsCSVFileOutput[KeyT]
    Implicit
    This member is added by an implicit conversion from MetricsCSVFileOutput[KeyT] to Ensuring[MetricsCSVFileOutput[KeyT]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): MetricsCSVFileOutput[KeyT]
    Implicit
    This member is added by an implicit conversion from MetricsCSVFileOutput[KeyT] to Ensuring[MetricsCSVFileOutput[KeyT]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. def formatDuration(from: Option[Long], to: Option[Long], format: String, nullValue: String): String
    Definition Classes
    MetricsFormatting
  19. def formatDuration(from: Option[Long], to: Long, format: String, nullValue: String): String
    Definition Classes
    MetricsFormatting
  20. def formatDuration(from: Long, to: Long, format: String): String
    Definition Classes
    MetricsFormatting
  21. def formatOption[T](v: Option[T], nullValue: String, format: (T) ⇒ String = x: T => x.toString): String
    Definition Classes
    MetricsFormatting
  22. def formatTime(format: String)(time: Long): String
    Definition Classes
    MetricsFormatting
  23. def formatTimeOption(time: Option[Long], format: String, nullValue: String): String
    Definition Classes
    MetricsFormatting
  24. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from MetricsCSVFileOutput[KeyT] to StringFormat[MetricsCSVFileOutput[KeyT]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  25. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  30. val nullValue: String

    A string representing null values.

    A string representing null values.

    Definition Classes
    MetricsStringOutput
  31. val path: String
  32. val prefix: String
  33. def procCSV(separator: String, timeFormat: Option[String])(m: ProcessMetrics[KeyT]): String

    String representation of a ProcessMetrics instance.

    String representation of a ProcessMetrics instance.

    separator

    a string (such as a space or comma) to separate the values

    timeFormat

    optional argument to format timestamps using java.text.SimpleDateFormat

    m

    the ProcessMetrics instance to be handled

    Definition Classes
    MetricsStringOutput
  34. def procHeader(separator: String): String

    The field names for ProcessMetrics.

    The field names for ProcessMetrics.

    separator

    a string (such as a space or comma) to separate the names

    Definition Classes
    MetricsStringOutput
  35. def processes(aggregator: MetricsAggregator[KeyT], separator: String, lineSep: String = "\n", timeFormat: Option[String] = None): String

    Formats all ProcessMetrics in a MetricsAggregator in a single string.

    Formats all ProcessMetrics in a MetricsAggregator in a single string.

    aggregator

    the MetricsAggregator to retrieve the metrics to be formatted

    separator

    a string (such as a space or comma) to separate values

    lineSep

    a string (such as a new line) to separate process metrics

    timeFormat

    optional argument to format timestamps using java.text.SimpleDateFormat

    Definition Classes
    MetricsStringOutput
  36. def quote(s: String): String
    Definition Classes
    MetricsFormatting
  37. val separator: String
  38. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  39. def toString(): String
    Definition Classes
    Function1 → AnyRef → Any
  40. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  43. def workflowCSV(separator: String, timeFormat: Option[String])(m: WorkflowMetrics[KeyT]): String

    String representation of a WorkflowMetrics instance.

    String representation of a WorkflowMetrics instance.

    separator

    a string (such as a space or comma) to separate the values

    timeFormat

    optional argument to format timestamps using java.text.SimpleDateFormat

    m

    the WorkflowMetrics instance to be handled

    Definition Classes
    MetricsStringOutput
  44. def workflowHeader(separator: String): String

    The field names for WorkflowMetrics.

    The field names for WorkflowMetrics.

    separator

    a string (such as a space or comma) to separate the names

    Definition Classes
    MetricsStringOutput
  45. def workflows(aggregator: MetricsAggregator[KeyT], separator: String, lineSep: String = "\n", timeFormat: Option[String] = None): String

    Formats all WorkflowMetrics in a MetricsAggregator in a single string.

    Formats all WorkflowMetrics in a MetricsAggregator in a single string.

    aggregator

    the MetricsAggregator to retrieve the metrics to be formatted

    separator

    a string (such as a space or comma) to separate values

    lineSep

    a string (such as a new line) to separate workflow metrics

    timeFormat

    optional argument to format timestamps using java.text.SimpleDateFormat

    Definition Classes
    MetricsStringOutput
  46. def writeToFile(filePath: String, output: String): Option[Exception]
    Definition Classes
    FileOutput
  47. def [B](y: B): (MetricsCSVFileOutput[KeyT], B)
    Implicit
    This member is added by an implicit conversion from MetricsCSVFileOutput[KeyT] to ArrowAssoc[MetricsCSVFileOutput[KeyT]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from FileOutput

Inherited from MetricsStringOutput[KeyT]

Inherited from MetricsFormatting

Inherited from MetricsOutput[KeyT]

Inherited from (MetricsAggregator[KeyT]) ⇒ Unit

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from MetricsCSVFileOutput[KeyT] to any2stringadd[MetricsCSVFileOutput[KeyT]]

Inherited by implicit conversion StringFormat from MetricsCSVFileOutput[KeyT] to StringFormat[MetricsCSVFileOutput[KeyT]]

Inherited by implicit conversion Ensuring from MetricsCSVFileOutput[KeyT] to Ensuring[MetricsCSVFileOutput[KeyT]]

Inherited by implicit conversion ArrowAssoc from MetricsCSVFileOutput[KeyT] to ArrowAssoc[MetricsCSVFileOutput[KeyT]]

Ungrouped