class RedisInstrumentation extends AbstractInstrumentation

Traits

LogsMessagesTrait

Constants

protected CONNECTION_ATTRIBUTE

protected DURATION_BOUNDARIES

Properties

protected InstrumentationOptions $options from  AbstractInstrumentation
protected TracerInterface|null $tracer
protected HistogramInterface|null $duration
protected bool $queryText
protected int|null $queryTextMaxLength

Methods

void
register(array $options)

Register the instrumentation with normalized options.

void
registerInstrumentation()

Register Redis listeners and instruments.

bool
tracesEnabled()

Determine whether trace output is enabled.

bool
metricEnabled(string $name)

Determine whether a metric is enabled.

array
indexObservers(array $names, array $observers)

Index callback observers by their matching instrument name.

__construct(Dispatcher $events, TracerProviderInterface $tracerProvider, MeterProviderInterface $meterProvider, ClockInterface $clock, OpenTelemetryManager $openTelemetry, RedisManager $redis, RedisQueryTextFormatter $queryTextFormatter, ExceptionContextRegistry $exceptionContexts, OperationOrigin $origins, ProcessIdentity $identity)

Create Redis instrumentation.

void
commandExecuted(CommandExecuted $event)

Record a completed Redis command.

void
commandFailed(CommandFailed $event)

Record a failed Redis command.

void
recordCommand(string $command, array $parameters, float $elapsedMilliseconds, string $connection, Throwable|null $exception = null)

Record one completed Redis operation.

array
attributes(string $operation, string $connection, string|null $errorType)

Return low-cardinality attributes shared by spans and metrics.

string|null
queryText(string $command, string $operation, array $parameters, string $connection)

Resolve the bounded Redis query text.

Details

final void register(array $options)

Register the instrumentation with normalized options.

Parameters

array $options

Return Value

void

at line 79
protected void registerInstrumentation()

Register Redis listeners and instruments.

Return Value

void

protected bool tracesEnabled()

Determine whether trace output is enabled.

Return Value

bool

protected bool metricEnabled(string $name)

Determine whether a metric is enabled.

Parameters

string $name

Return Value

bool

protected array indexObservers(array $names, array $observers)

Index callback observers by their matching instrument name.

The SDK supplies observers in the same order as the instruments passed to batchObserve(), so the unchanged name order is the mapping contract.

Parameters

array $names
array $observers

Return Value

array

at line 62
__construct(Dispatcher $events, TracerProviderInterface $tracerProvider, MeterProviderInterface $meterProvider, ClockInterface $clock, OpenTelemetryManager $openTelemetry, RedisManager $redis, RedisQueryTextFormatter $queryTextFormatter, ExceptionContextRegistry $exceptionContexts, OperationOrigin $origins, ProcessIdentity $identity)

Create Redis instrumentation.

Parameters

Dispatcher $events
TracerProviderInterface $tracerProvider
MeterProviderInterface $meterProvider
ClockInterface $clock
OpenTelemetryManager $openTelemetry
RedisManager $redis
RedisQueryTextFormatter $queryTextFormatter
ExceptionContextRegistry $exceptionContexts
OperationOrigin $origins
ProcessIdentity $identity

at line 117
protected void commandExecuted(CommandExecuted $event)

Record a completed Redis command.

Parameters

CommandExecuted $event

Return Value

void

at line 130
protected void commandFailed(CommandFailed $event)

Record a failed Redis command.

Parameters

CommandFailed $event

Return Value

void

at line 149
protected void recordCommand(string $command, array $parameters, float $elapsedMilliseconds, string $connection, Throwable|null $exception = null)

Record one completed Redis operation.

Parameters

string $command
array $parameters
float $elapsedMilliseconds
string $connection
Throwable|null $exception

Return Value

void

at line 226
protected array attributes(string $operation, string $connection, string|null $errorType)

Return low-cardinality attributes shared by spans and metrics.

Parameters

string $operation
string $connection
string|null $errorType

Return Value

array

at line 241
protected string|null queryText(string $command, string $operation, array $parameters, string $connection)

Resolve the bounded Redis query text.

Parameters

string $command
string $operation
array $parameters
string $connection

Return Value

string|null