class Integration extends Feature

Constants

private FEATURE_KEY

private STORAGE_DRIVER_NAME

Methods

__construct(Container $container)

Create a new feature instance.

from  Feature
bool
isApplicable()

Indicate if the feature is applicable to the current environment.

void
register()

Register the Sentry filesystem driver.

void
onBoot()

Set up the feature in the environment.

from  Feature
void
onBootInactive()

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

from  Feature
void
boot()

Initialize the feature.

from  Feature
void
bootInactive()

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

from  Feature
array
getUserConfig()

Retrieve the user configuration.

from  Feature
bool
shouldSendDefaultPii()

Determine if default PII should be sent.

from  Feature
bool
shouldCollectGenAiInputs()

Determine whether AI inputs may be collected.

from  Feature
bool
shouldCollectGenAiOutputs()

Determine whether AI outputs may be collected.

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

Indicate if the given feature is enabled for tracing.

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

Indicate if the given feature is enabled for breadcrumbs.

from  Feature
bool
canRecordSpans()

Determine if the active SDK client can record spans.

from  Feature
bool
canRecordBreadcrumbs()

Determine if the active SDK client can record breadcrumbs.

from  Feature
static array
configureDisk(string $diskName, array $diskConfig, bool $enableSpans = true, bool $enableBreadcrumbs = true)

Decorate the configuration for a single disk with Sentry driver configuration.

static array
configureDisks(array $diskConfigs, bool $enableSpans = true, bool $enableBreadcrumbs = true)

Decorate the configuration for all disks with Sentry driver configuration.

Details

in Feature at line 35
__construct(Container $container)

Create a new feature instance.

Parameters

Container $container

at line 25
bool isApplicable()

Indicate if the feature is applicable to the current environment.

Return Value

bool

at line 35
void register()

Register the Sentry filesystem driver.

Return Value

void

in Feature at line 56
void onBoot()

Set up the feature in the environment.

Return Value

void

in Feature at line 64
void onBootInactive()

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

Return Value

void

in Feature at line 71
void boot()

Initialize the feature.

Return Value

void

in Feature at line 81
void bootInactive()

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

Return Value

void

in Feature at line 91
protected array getUserConfig()

Retrieve the user configuration.

Return Value

array

in Feature at line 99
protected bool shouldSendDefaultPii()

Determine if default PII should be sent.

Return Value

bool

in Feature at line 113
protected bool shouldCollectGenAiInputs()

Determine whether AI inputs may be collected.

Return Value

bool

in Feature at line 121
protected bool shouldCollectGenAiOutputs()

Determine whether AI outputs may be collected.

Return Value

bool

in Feature 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

in Feature 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

in Feature at line 182
protected bool canRecordSpans()

Determine if the active SDK client can record spans.

Return Value

bool

in Feature at line 196
protected bool canRecordBreadcrumbs()

Determine if the active SDK client can record breadcrumbs.

Return Value

bool

at line 118
static array configureDisk(string $diskName, array $diskConfig, bool $enableSpans = true, bool $enableBreadcrumbs = true)

Decorate the configuration for a single disk with Sentry driver configuration.

This replaces the driver with a custom driver that will capture performance traces and breadcrumbs.

The custom driver will be an instance of SentryS3V3Adapter if the original driver is an AwsS3V3Adapter, and an instance of SentryFilesystemAdapter if the original driver is an FilesystemAdapter. If the original driver is neither of those, it will be SentryFilesystem or SentryCloudFilesystem based on the original contract.

You might run into problems if you expect another specific driver class.

Parameters

string $diskName
array $diskConfig
bool $enableSpans
bool $enableBreadcrumbs

Return Value

array

at line 142
static array configureDisks(array $diskConfigs, bool $enableSpans = true, bool $enableBreadcrumbs = true)

Decorate the configuration for all disks with Sentry driver configuration.

Parameters

array $diskConfigs
bool $enableSpans
bool $enableBreadcrumbs

Return Value

array

See also

\Hypervel\Sentry\Features\Storage\self::configureDisk()