ScoutInstrumentation
class ScoutInstrumentation extends AbstractInstrumentation implements EngineOperationObserver
Constants
| protected MODEL_ATTRIBUTE |
|
| protected DURATION_BOUNDARIES |
|
Properties
| protected InstrumentationOptions | $options | from AbstractInstrumentation | |
| protected TracerInterface|null | $tracer | ||
| protected HistogramInterface|null | $duration |
Methods
Register the instrumentation with normalized options.
Register the Scout operation observer and instruments.
Determine whether a metric is enabled.
Determine whether the throwable is a direct coroutine cancellation.
Return the semantic conventions schema URL for Hypervel instrumentation scopes.
Index callback observers by their matching instrument name.
Create Scout instrumentation.
Finish observing a Scout engine operation.
Details
in
AbstractInstrumentation at line 21
final void
register(array $options)
Register the instrumentation with normalized options.
at line 60
protected void
registerInstrumentation()
Register the Scout operation observer and instruments.
in
AbstractInstrumentation at line 35
protected bool
tracesEnabled()
Determine whether trace output is enabled.
in
AbstractInstrumentation at line 43
protected bool
metricEnabled(string $name)
Determine whether a metric is enabled.
in
AbstractInstrumentation at line 53
protected bool
isDirectCancellation(Throwable|null $exception)
Determine whether the throwable is a direct coroutine cancellation.
Ending an operation by direct cancellation is control flow, not a failure.
in
AbstractInstrumentation at line 64
protected string
schemaUrl()
Return the semantic conventions schema URL for Hypervel instrumentation scopes.
Every tracer, meter and logger obtained for one scope must pass the same URL.
in
AbstractInstrumentation at line 79
protected array
indexObservers(array $names, array $observers)
Index callback observers by their matching instrument name.
The SDK supplies observers in the same order as the instruments passed to batchObserve(), so the unchanged name order is the mapping contract.
at line 48
__construct(EngineOperationRunner $operations, TracerProviderInterface $tracerProvider, MeterProviderInterface $meterProvider, ClockInterface $clock, LogContextScopeFactory $logContextScopes)
Create Scout instrumentation.
at line 85
mixed
starting(EngineOperation $operation)
Start observing a Scout engine operation.
at line 127
void
finished(EngineOperation $operation, mixed $token, Throwable|null $exception)
Finish observing a Scout engine operation.
at line 171
protected array
metricAttributes(EngineOperation $operation)
Return metric-safe Scout engine-operation attributes.