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

RedisFeature

class RedisFeature extends Feature

Traits

ResolvesEventOrigin
ResolvesSessionKey

Properties

bool internal $detectSessionKeyOnConsole

Indicates whether to attempt to detect the session key when running in the console.

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 feature in the environment.

from  Feature
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).

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

Retrieve the application container.

from  ResolvesEventOrigin
array|null
resolveEventOrigin()

No description

from  ResolvesEventOrigin
string|null
resolveEventOriginAsString()

No description

from  ResolvesEventOrigin
void
handleRedisCommands(CommandExecuted $event)

No description

void
handleFailedRedisCommands(CommandFailed $event)

Record a failed Redis command as an error span.

Details

in Feature at line 34
__construct(Container $container)

Create a new feature instance.

Parameters

Container $container

at line 34
bool isApplicable()

Indicate if the feature is applicable to the current environment.

Return Value

bool

in Feature at line 47
void register()

Register the feature in the environment.

Return Value

void

at line 39
void onBoot()

Set up the feature in the environment.

Return Value

void

in Feature at line 63
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 70
void boot()

Initialize the feature.

Return Value

void

in Feature at line 80
void bootInactive()

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

Return Value

void

in Feature at line 90
protected array getUserConfig()

Retrieve the user configuration.

Return Value

array

in Feature at line 98
protected bool shouldSendDefaultPii()

Determine if default PII should be sent.

Return Value

bool

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

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

in Feature at line 148
protected bool canRecordSpans()

Determine if the active SDK client can record spans.

Return Value

bool

in Feature at line 162
protected bool canRecordBreadcrumbs()

Determine if the active SDK client can record breadcrumbs.

Return Value

bool

in ResolvesEventOrigin at line 15
protected Container container()

Retrieve the application container.

Return Value

Container

in ResolvesEventOrigin at line 20
protected array|null resolveEventOrigin()

No description

Return Value

array|null

in ResolvesEventOrigin at line 44
protected string|null resolveEventOriginAsString()

No description

Return Value

string|null

at line 48
void handleRedisCommands(CommandExecuted $event)

No description

Parameters

CommandExecuted $event

Return Value

void

at line 56
void handleFailedRedisCommands(CommandFailed $event)

Record a failed Redis command as an error span.

Parameters

CommandFailed $event

Return Value

void