TelemetryContext
FinalYes
Tags
Properties
Methods
- __construct() : mixed
- dataFrameBatchProcessed() : void
- dataFrameCompleted() : void
- dataFrameFailed() : void
- dataFrameStarted() : void
- limitReached() : void
- logger() : Logger
- memory() : Consumption
- The heap of the data frame started last, sampled once per batch; it stays readable after the data frame ends.
- stepCompleted() : void
- Completes the span stepStarted() opened; a span already completed or drained is left alone.
- stepFailed() : void
- stepStarted() : SpanScope
- Opens a step's span under the data frame span. An operator's span is not activated: it stays open across the batches it yields, while other code runs.
- taskCompleted() : void
- One span per task a launcher completed, named "$stage $task"; the spans of the steps shipped with it are lost.
- totalRows() : int
- The rows that reached the end of the data frame started last; it stays readable after the data frame ends.
Properties
$options read-only
public
TelemetryOptions
$options
Methods
__construct()
public
__construct(string $dataFrameId, string $dataFrameName, Backend $backend, Logger $logger, Tracer $tracer, Meter $meter, TelemetryOptions $options) : mixed
Parameters
- $dataFrameId : string
- $dataFrameName : string
- $backend : Backend
- $logger : Logger
- $tracer : Tracer
- $meter : Meter
- $options : TelemetryOptions
dataFrameBatchProcessed()
public
dataFrameBatchProcessed(Rows $rows) : void
Parameters
- $rows : Rows
dataFrameCompleted()
public
dataFrameCompleted([TAttributeValueMap $attributes = [] ]) : void
Parameters
- $attributes : TAttributeValueMap = []
dataFrameFailed()
public
dataFrameFailed(Throwable $exception[, TAttributeValueMap $attributes = [] ]) : void
Parameters
- $exception : Throwable
- $attributes : TAttributeValueMap = []
dataFrameStarted()
public
dataFrameStarted(TAttributeValueMap $configuration) : void
Parameters
- $configuration : TAttributeValueMap
-
the run's settings, logged with the start
limitReached()
public
limitReached([TAttributeValueMap $attributes = [] ]) : void
Parameters
- $attributes : TAttributeValueMap = []
logger()
public
logger() : Logger
Return values
Loggermemory()
The heap of the data frame started last, sampled once per batch; it stays readable after the data frame ends.
public
memory() : Consumption
Return values
ConsumptionstepCompleted()
Completes the span stepStarted() opened; a span already completed or drained is left alone.
public
stepCompleted(SpanScope $step[, TAttributeValueMap $attributes = [] ]) : void
Parameters
- $step : SpanScope
- $attributes : TAttributeValueMap = []
stepFailed()
public
stepFailed(SpanScope $step, StepKind $kind, class-string $class, Throwable $exception[, TAttributeValueMap $attributes = [] ]) : void
Parameters
stepStarted()
Opens a step's span under the data frame span. An operator's span is not activated: it stays open across the batches it yields, while other code runs.
public
stepStarted(StepKind $kind, class-string $class[, TAttributeValueMap $attributes = [] ]) : SpanScope
Parameters
- $kind : StepKind
- $class : class-string
- $attributes : TAttributeValueMap = []
Return values
SpanScopetaskCompleted()
One span per task a launcher completed, named "$stage $task"; the spans of the steps shipped with it are lost.
public
taskCompleted(int $task, string $stage[, TAttributeValueMap $attributes = [] ]) : void
Parameters
- $task : int
- $stage : string
- $attributes : TAttributeValueMap = []
totalRows()
The rows that reached the end of the data frame started last; it stays readable after the data frame ends.
public
totalRows() : int