Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IPerformanceWorkflow

Workflow to monitor performance during transform

Hierarchy

  • IPerformanceWorkflow

Index

Properties

Methods

Properties

context

context: IContext

Contextual information about the workflow

id

id: string

ID

Unique identifier for a particular instance of the workflow

name

name: string

Name

Describes the workflow action

Methods

checkpoint

  • checkpoint(name: string): this

  • Creates an {@link ICheckpoint} for the workflow

    Parameters

    • name: string

      Name of the checkpoint

    Returns this

complete

  • complete(report?: boolean): this

  • Marks the workflow as complete and optionally reports it

    Parameters

    • Optional report: boolean

      Whether or not the workflow should be reported (If no value passed, the autoReport option will be used. If no autoReport option was specified, this defaults to true.)

      If the workflow is reported, this will remove the workflow from the {@link IPerformanceMonitorService} if it is being tracked

    Returns this

getDuration

  • getDuration(startCheckpoint: string, endCheckpoint: string): number

  • Retrieves the time value difference between 2 checkpoints in milliseconds

    Parameters

    • startCheckpoint: string

      name of the start checkpoint

    • endCheckpoint: string

      name of the end checkpoint

    Returns number

setContext

  • setContext(key: string, value: ApmCustomData, override?: boolean): this

  • Assigns a context property

    Parameters

    • key: string

      Context property name

    • value: ApmCustomData

      Context property value

    • Optional override: boolean

      Whether or not to override the existing value (Defaults to false)

    Returns this

start

  • start(startTime?: number): this

  • Marks the start of the workflow

    Parameters

    • Optional startTime: number

    Returns this