QueueFeature
class QueueFeature extends Feature
Traits
Track pushed scopes and spans using coroutine-local storage.
Constants
| private QUEUE_SPAN_OP_QUEUE_PUBLISH |
|
| private QUEUE_PAYLOAD_BAGGAGE_DATA |
|
| private QUEUE_PAYLOAD_TRACE_PARENT_DATA |
|
| private QUEUE_PAYLOAD_PUBLISH_TIME |
|
| private QUEUE_PAYLOAD_DESTINATION_NAME |
|
Methods
Indicate if the feature is applicable to the current environment.
Set up the feature in the environment.
Set up the feature in the environment in an inactive state (when no DSN was set).
Indicate if the given feature is enabled for tracing.
Indicate if the given feature is enabled for breadcrumbs.
Push a span onto the coroutine-local stack and set it as current on the hub.
No description
Track an operation-local span without making it current on the Hub.
Pop a span from the coroutine-local stack and restore the parent span.
Pop a scope from the hub if one was pushed in this coroutine.
Finish the current span if one exists on the coroutine-local stack.
Finish an operation-local span by key if one exists.
Details
at line 50
bool
isApplicable()
Indicate if the feature is applicable to the current environment.
in
Feature at line 47
void
register()
Register the feature in the environment.
at line 55
void
onBoot()
Set up the feature in the environment.
in
Feature at line 63
void
onBootInactive()
Set up the feature in the environment in an inactive state (when no DSN was set).
in
Feature at line 70
void
boot()
Initialize the feature.
in
Feature at line 80
void
bootInactive()
Initialize the feature in an inactive state (when no DSN was set).
in
Feature at line 90
protected array
getUserConfig()
Retrieve the user configuration.
in
Feature at line 98
protected bool
shouldSendDefaultPii()
Determine if default PII should be sent.
in
Feature at line 112
protected bool
isTracingFeatureEnabled(string $feature, bool $default = true)
Indicate if the given feature is enabled for tracing.
in
Feature at line 125
protected bool
isBreadcrumbFeatureEnabled(string $feature, bool $default = true)
Indicate if the given feature is enabled for breadcrumbs.
in
Feature at line 148
protected bool
canRecordSpans()
Determine if the active SDK client can record spans.
in
Feature at line 162
protected bool
canRecordBreadcrumbs()
Determine if the active SDK client can record breadcrumbs.
in
TracksPushedScopesAndSpans at line 26
protected void
pushSpan(Span $span)
Push a span onto the coroutine-local stack and set it as current on the hub.
at line 276
protected Scope
pushScope()
No description
in
TracksPushedScopesAndSpans at line 59
protected void
trackLocalSpan(string $key, Span $span)
Track an operation-local span without making it current on the Hub.
in
TracksPushedScopesAndSpans at line 70
protected Span|null
maybePopSpan()
Pop a span from the coroutine-local stack and restore the parent span.
in
TracksPushedScopesAndSpans at line 93
protected void
maybePopScope()
Pop a scope from the hub if one was pushed in this coroutine.
in
TracksPushedScopesAndSpans at line 109
protected Span|null
maybeFinishSpan(SpanStatus|null $status = null)
Finish the current span if one exists on the coroutine-local stack.
in
TracksPushedScopesAndSpans at line 129
protected Span|null
maybeFinishLocalSpan(string $key, SpanStatus|null $status = null)
Finish an operation-local span by key if one exists.
at line 92
void
handleJobQueueingEvent(JobQueueing $event)
No description
at line 129
void
handleJobQueuedEvent(JobQueued $event)
No description
at line 134
void
handleJobQueueingFailedEvent(JobQueueingFailed $event)
No description
at line 139
void
handleJobProcessedQueueEvent(JobProcessed $event)
No description
at line 146
void
handleJobProcessingQueueEvent(JobProcessing $event)
No description
at line 242
void
handleJobFailedEvent(JobFailed $event)
Handle a permanently failed job.
Finishes the span with an error status but does not pop the scope — breadcrumbs need to remain available for exception reporting. The next JobProcessing event will clean up via its maybePopScope() call before pushing a new scope.
at line 247
void
handleWorkerStoppingQueueEvent(WorkerStopping $event)
No description
at line 256
void
handleJobExceptionOccurredQueueEvent(JobExceptionOccurred $event)
No description