1. class
  2. Hypervel
  3. \
  4. Sentry
  5. \
  6. Features
  7. \
  8. Feature

Feature

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
shouldCollectGenAiInputs()

Determine whether AI inputs may be collected.

bool
shouldCollectGenAiOutputs()

Determine whether AI outputs may be collected.

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 35
__construct(Container $container)

Create a new feature instance.

Parameters

Container $container

at line 43
abstract bool isApplicable()

Indicate if the feature is applicable to the current environment.

Return Value

bool

at line 48
void register()

Register the feature in the environment.

Return Value

void

at line 56
void onBoot()

Set up the feature in the environment.

Return Value

void

at line 64
void onBootInactive()

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

Return Value

void

at line 71
void boot()

Initialize the feature.

Return Value

void

at line 81
void bootInactive()

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

Return Value

void

at line 91
protected array getUserConfig()

Retrieve the user configuration.

Return Value

array

at line 99
protected bool shouldSendDefaultPii()

Determine if default PII should be sent.

Return Value

bool

at line 113
protected bool shouldCollectGenAiInputs()

Determine whether AI inputs may be collected.

Return Value

bool

at line 121
protected bool shouldCollectGenAiOutputs()

Determine whether AI outputs may be collected.

Return Value

bool

at line 146
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 159
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 182
protected bool canRecordSpans()

Determine if the active SDK client can record spans.

Return Value

bool

at line 196
protected bool canRecordBreadcrumbs()

Determine if the active SDK client can record breadcrumbs.

Return Value

bool