mediatekformation

ElasticsearchHandler extends AbstractProcessingHandler
in package

Elasticsearch handler

Tags
link

Simple usage example:

$client = \Elasticsearch\ClientBuilder::create() ->setHosts($hosts) ->build();

$options = array( 'index' => 'elastic_index_name', 'type' => 'elastic_doc_type', ); $handler = new ElasticsearchHandler($client, $options); $log = new Logger('application'); $log->pushHandler($handler);
author

Avtandil Kikabidze akalongman@gmail.com

Table of Contents

$bubble  : bool
$client  : Client
$formatter  : FormatterInterface|null
$level  : int
$options  : array<string|int, mixed>
$processors  : array<string|int, callable>
__construct()  : mixed
__destruct()  : mixed
__sleep()  : mixed
close()  : void
Closes the handler.
getBubble()  : bool
Gets the bubbling behavior.
getFormatter()  : FormatterInterface
{@inheritDoc}
getLevel()  : int
Gets minimum logging level at which this handler will be triggered.
getOptions()  : array<string|int, mixed>
Getter options
handle()  : bool
{@inheritDoc}
handleBatch()  : void
{@inheritDoc}
isHandling()  : bool
{@inheritDoc}
popProcessor()  : callable
{@inheritDoc}
pushProcessor()  : HandlerInterface
{@inheritDoc}
reset()  : void
setBubble()  : self
Sets the bubbling behavior.
setFormatter()  : HandlerInterface
{@inheritDoc}
setLevel()  : self
Sets minimum logging level at which this handler will be triggered.
bulkSend()  : void
Use Elasticsearch bulk API to send list of documents
createExceptionFromError()  : RuntimeException
Creates elasticsearch exception from error array
createExceptionFromResponses()  : RuntimeException
Creates elasticsearch exception from responses array
getDefaultFormatter()  : FormatterInterface
{@inheritDoc}
processRecord()  : array<string|int, mixed>
Processes a record.
resetProcessors()  : void
write()  : void
Writes the record down to the log of the implementing handler

Properties

$level

protected int $level = \Monolog\Logger::DEBUG
Tags
phpstan-var

Level

$processors

protected array<string|int, callable> $processors = []
Tags
phpstan-var

array<ProcessorInterface|callable(Record): Record>

Methods

__construct()

public __construct(Client $client[, array<string|int, mixed> $options = [] ][, mixed $level = Logger::DEBUG ][, bool $bubble = true ]) : mixed
Parameters
$client : Client

Elasticsearch Client object

$options : array<string|int, mixed> = []

Handler configuration

$level : mixed = Logger::DEBUG
$bubble : bool = true
Return values
mixed —

__destruct()

public __destruct() : mixed
Return values
mixed —

__sleep()

public __sleep() : mixed
Return values
mixed —

close()

Closes the handler.

public close() : void
Return values
void —

getBubble()

Gets the bubbling behavior.

public getBubble() : bool
Return values
bool —

true means that this handler allows bubbling. false means that bubbling is not permitted.

getLevel()

Gets minimum logging level at which this handler will be triggered.

public getLevel() : int
Tags
phpstan-return

Level

Return values
int —

getOptions()

Getter options

public getOptions() : array<string|int, mixed>
Return values
array<string|int, mixed> —

handle()

{@inheritDoc}

public handle(array<string|int, mixed> $record) : bool
Parameters
$record : array<string|int, mixed>
Return values
bool —

handleBatch()

{@inheritDoc}

public handleBatch(array<string|int, mixed> $records) : void
Parameters
$records : array<string|int, mixed>
Return values
void —

isHandling()

{@inheritDoc}

public isHandling(array<string|int, mixed> $record) : bool
Parameters
$record : array<string|int, mixed>
Return values
bool —

setBubble()

Sets the bubbling behavior.

public setBubble(bool $bubble) : self
Parameters
$bubble : bool

true means that this handler allows bubbling. false means that bubbling is not permitted.

Return values
self —

setLevel()

Sets minimum logging level at which this handler will be triggered.

public setLevel(mixed $level) : self
Parameters
$level : mixed
Return values
self —

bulkSend()

Use Elasticsearch bulk API to send list of documents

protected bulkSend(array<string|int, array<string|int, mixed>> $records) : void
Parameters
$records : array<string|int, array<string|int, mixed>>

Records + _index/_type keys

Tags
throws
RuntimeException
Return values
void —

createExceptionFromError()

Creates elasticsearch exception from error array

protected createExceptionFromError(array<string|int, mixed> $error) : RuntimeException
Parameters
$error : array<string|int, mixed>
Return values
RuntimeException —

createExceptionFromResponses()

Creates elasticsearch exception from responses array

protected createExceptionFromResponses(array<string|int, mixed> $responses) : RuntimeException

Only the first error is converted into an exception.

Parameters
$responses : array<string|int, mixed>

returned by $this->client->bulk()

Return values
RuntimeException —

processRecord()

Processes a record.

protected processRecord(array<string|int, mixed> $record) : array<string|int, mixed>
Parameters
$record : array<string|int, mixed>
Tags
phpstan-param

Record $record

phpstan-return

Record

Return values
array<string|int, mixed> —

write()

Writes the record down to the log of the implementing handler

protected write(array<string|int, mixed> $record) : void
Parameters
$record : array<string|int, mixed>
Return values
void —

Search results