abstract class Feature

Methods

__construct(Container $container)

Create a new feature instance.

bool
isApplicable()

Indicate if the feature is applicable to the current environment.

void
register()

Register the feature in the environment.

void
onBoot()

Set up the feature in the environment.

void
onBootInactive()

Set up the feature in the environment in an inactive state (when no DSN was set).

void
boot()

Initialize the feature.

void
bootInactive()

Initialize the feature in an inactive state (when no DSN was set).

array
getUserConfig()

Retrieve the user configuration.

bool
shouldSendDefaultPii()

Determine if default PII should be sent.

bool
isTracingFeatureEnabled(string $feature, bool $default = true)

Indicate if the given feature is enabled for tracing.

bool
isBreadcrumbFeatureEnabled(string $feature, bool $default = true)

Indicate if the given feature is enabled for breadcrumbs.

bool
canRecordSpans()

Determine if the active SDK client can record spans.

bool
canRecordBreadcrumbs()

Determine if the active SDK client can record breadcrumbs.

Details

at line 34
__construct(Container $container)

Create a new feature instance.

Parameters

Container $container

at line 42
abstract bool isApplicable()

Indicate if the feature is applicable to the current environment.

Return Value

bool

at line 47
void register()

Register the feature in the environment.

Return Value

void

at line 55
void onBoot()

Set up the feature in the environment.

Return Value

void

at line 63
void onBootInactive()

Set up the feature in the environment in an inactive state (when no DSN was set).

Return Value

void

at line 70
void boot()

Initialize the feature.

Return Value

void

at line 80
void bootInactive()

Initialize the feature in an inactive state (when no DSN was set).

Return Value

void

at line 90
protected array getUserConfig()

Retrieve the user configuration.

Return Value

array

at line 98
protected bool shouldSendDefaultPii()

Determine if default PII should be sent.

Return Value

bool

at line 112
protected bool isTracingFeatureEnabled(string $feature, bool $default = true)

Indicate if the given feature is enabled for tracing.

Parameters

string $feature
bool $default

Return Value

bool

at line 125
protected bool isBreadcrumbFeatureEnabled(string $feature, bool $default = true)

Indicate if the given feature is enabled for breadcrumbs.

Parameters

string $feature
bool $default

Return Value

bool

at line 148
protected bool canRecordSpans()

Determine if the active SDK client can record spans.

Return Value

bool

at line 162
protected bool canRecordBreadcrumbs()

Determine if the active SDK client can record breadcrumbs.

Return Value

bool