TimelineObserver (nextflow 0.30.0-BETA2 API)

nextflow.trace.TimelineObserver

All Implemented Interfaces and Traits:

TraceObserver
```
@groovy.util.logging.Slf4j
@groovy.transform.CompileStatic
class TimelineObserver
extends java.lang.Object
```
Render pipeline timeline processes execution
Authors:
Paolo Di Tommaso

Properties Summary

Properties
Type	Name and description
`static java.lang.String`	`DEF_FILE_NAME`

Constructor Summary

Constructors
Constructor and description
`TimelineObserver (java.nio.file.Path file)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected void`	`append(java.lang.StringBuilder template, TraceRecord record)`
	`boolean`	`enableMetrics()`
	`protected java.lang.String`	`labelString(TraceRecord record)`
	`void`	`onFlowComplete()` Save the pending processes and close the trace file
	`void`	`onFlowStart(Session session)` Create the trace file, in file already existing with the same name it is "rolled" to a new file
	`void`	`onProcessCached(TaskHandler handler, TraceRecord trace)`
	`void`	`onProcessComplete(TaskHandler handler, TraceRecord trace)` This method is invoked when a process run completes
	`void`	`onProcessCreate(TaskProcessor process)`
	`void`	`onProcessStart(TaskHandler handler, TraceRecord trace)` This method is invoked when a process run is going to start
	`void`	`onProcessSubmit(TaskHandler handler, TraceRecord trace)` This method is invoked before a process run is going to be submitted
	`protected java.lang.String`	`readTemplate()`
	`protected java.lang.StringBuilder`	`renderData()`
	`protected void`	`renderHtml()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - static final java.lang.String DEF_FILE_NAME
- Constructor Detail
  - TimelineObserver(java.nio.file.Path file)
- Method Detail
  - protected void append(java.lang.StringBuilder template, TraceRecord record)
  - @java.lang.Override boolean enableMetrics()
  - protected java.lang.String labelString(TraceRecord record)
  - @java.lang.Override void onFlowComplete()
    
    Save the pending processes and close the trace file
  - @java.lang.Override void onFlowStart(Session session)
    
    Create the trace file, in file already existing with the same name it is "rolled" to a new file
  - @java.lang.Override void onProcessCached(TaskHandler handler, TraceRecord trace)
  - @java.lang.Override void onProcessComplete(TaskHandler handler, TraceRecord trace)
    
    This method is invoked when a process run completes
    Parameters:
    handler
  - @java.lang.Override void onProcessCreate(TaskProcessor process)
  - @java.lang.Override void onProcessStart(TaskHandler handler, TraceRecord trace)
    
    This method is invoked when a process run is going to start
    Parameters:
    handler
  - @java.lang.Override void onProcessSubmit(TaskHandler handler, TraceRecord trace)
    
    This method is invoked before a process run is going to be submitted
    Parameters:
    handler
  - protected java.lang.String readTemplate()
  - protected java.lang.StringBuilder renderData()
  - protected void renderHtml()

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class TimelineObserver

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

static final java.lang.String DEF_FILE_NAME

Constructor Detail

TimelineObserver(java.nio.file.Path file)

Method Detail

protected void append(java.lang.StringBuilder template, TraceRecord record)

@java.lang.Override boolean enableMetrics()

protected java.lang.String labelString(TraceRecord record)

@java.lang.Override void onFlowComplete()

@java.lang.Override void onFlowStart(Session session)

@java.lang.Override void onProcessCached(TaskHandler handler, TraceRecord trace)

@java.lang.Override void onProcessComplete(TaskHandler handler, TraceRecord trace)

@java.lang.Override void onProcessCreate(TaskProcessor process)

@java.lang.Override void onProcessStart(TaskHandler handler, TraceRecord trace)

@java.lang.Override void onProcessSubmit(TaskHandler handler, TraceRecord trace)

protected java.lang.String readTemplate()

protected java.lang.StringBuilder renderData()

protected void renderHtml()