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. 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
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- MetricsD3Timeline
- Serializable
- Serializable
- Product
- Equals
- MetricsFormatting
- FileOutput
- MetricsOutput
- Function1
- AnyRef
- Any
Implicitly
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
Visibility
- Public
- All
Instance Constructors
-
new
MetricsD3Timeline(path: String, file: String)
- path
path to directory where the files will be placed
- file
file name prefix
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
+(other: String): String
- Implicit
- This member is added by an implicit conversion from MetricsD3Timeline[KeyT] to any2stringadd[MetricsD3Timeline[KeyT]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (MetricsD3Timeline[KeyT], B)
- Implicit
- This member is added by an implicit conversion from MetricsD3Timeline[KeyT] to ArrowAssoc[MetricsD3Timeline[KeyT]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
and(h: MetricsOutput[KeyT]): MetricsOutputs[KeyT]
Compose with another MetricsOutput in sequence.
Compose with another MetricsOutput in sequence.
- Definition Classes
- MetricsOutput
-
def
andThen[A](g: (Unit) ⇒ A): (MetricsAggregator[KeyT]) ⇒ A
- Definition Classes
- Function1
- Annotations
- @unspecialized()
-
def
apply(aggregator: MetricsAggregator[KeyT]): Unit
- Definition Classes
- MetricsD3Timeline → Function1
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
build(aggregator: MetricsAggregator[KeyT], now: Long): String
Helps build the output with a static system time.
-
def
callEntry(now: Long, m: ProcessMetrics[KeyT], prefix: String): String
Encodes a process call as a timeline task.
Encodes a process call as a timeline task.
- now
the current (real) to be used as the end time of unfinished processes
- m
the ProcessMetrics recorded for this process call
- prefix
a string to prefix (usually some whitespace) to prefix the entry
- returns
the encoded timeline task
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
compose[A](g: (A) ⇒ MetricsAggregator[KeyT]): (A) ⇒ Unit
- Definition Classes
- Function1
- Annotations
- @unspecialized()
-
def
ensuring(cond: (MetricsD3Timeline[KeyT]) ⇒ Boolean, msg: ⇒ Any): MetricsD3Timeline[KeyT]
- Implicit
- This member is added by an implicit conversion from MetricsD3Timeline[KeyT] to Ensuring[MetricsD3Timeline[KeyT]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (MetricsD3Timeline[KeyT]) ⇒ Boolean): MetricsD3Timeline[KeyT]
- Implicit
- This member is added by an implicit conversion from MetricsD3Timeline[KeyT] to Ensuring[MetricsD3Timeline[KeyT]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): MetricsD3Timeline[KeyT]
- Implicit
- This member is added by an implicit conversion from MetricsD3Timeline[KeyT] to Ensuring[MetricsD3Timeline[KeyT]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): MetricsD3Timeline[KeyT]
- Implicit
- This member is added by an implicit conversion from MetricsD3Timeline[KeyT] to Ensuring[MetricsD3Timeline[KeyT]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val file: String
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
formatDuration(from: Option[Long], to: Option[Long], format: String, nullValue: String): String
- Definition Classes
- MetricsFormatting
-
def
formatDuration(from: Option[Long], to: Long, format: String, nullValue: String): String
- Definition Classes
- MetricsFormatting
-
def
formatDuration(from: Long, to: Long, format: String): String
- Definition Classes
- MetricsFormatting
-
def
formatOption[T](v: Option[T], nullValue: String, format: (T) ⇒ String = x: T => x.toString): String
- Definition Classes
- MetricsFormatting
-
def
formatTime(format: String)(time: Long): String
- Definition Classes
- MetricsFormatting
-
def
formatTimeOption(time: Option[Long], format: String, nullValue: String): String
- Definition Classes
- MetricsFormatting
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from MetricsD3Timeline[KeyT] to StringFormat[MetricsD3Timeline[KeyT]] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val path: String
-
def
processEntry(proc: String, i: Seq[ProcessMetrics[KeyT]], now: Long, prefix: String): String
Encodes multiple process calls of the same process in a single lane.
Encodes multiple process calls of the same process in a single lane.
- proc
the name of the process
- i
the list of ProcessMetrics recorded for each process call
- now
the current (real) to be used as the end time of unfinished processes
- prefix
a string to prefix (usually some whitespace) to prefix the entry
- returns
the encoded timeline lane
-
def
quote(s: String): String
- Definition Classes
- MetricsFormatting
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- Function1 → AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
workflowEntry(m: WorkflowMetrics[KeyT], agg: MetricsAggregator[KeyT], now: Long, prefix: String): String
Encodes an entire workflow as a timeline.
Encodes an entire workflow as a timeline.
- m
thr WorkflowMetrics recorded for the particular workflow
- agg
the MetricsAggregator containing all the relevant metrics
- now
the current (real) to be used as the end time of unfinished processes
- prefix
a string to prefix (usually some whitespace) to prefix the entry
- returns
the encoded timeline for the workflow
-
def
writeToFile(filePath: String, output: String): Option[Exception]
- Definition Classes
- FileOutput
-
def
→[B](y: B): (MetricsD3Timeline[KeyT], B)
- Implicit
- This member is added by an implicit conversion from MetricsD3Timeline[KeyT] to ArrowAssoc[MetricsD3Timeline[KeyT]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc