Documentation

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

phpstan-type

Options array{ index: string, type: string, ignore_error: bool, op_type: 'index'|'create' }

InputOptions array{ index?: string, type?: string, ignore_error?: bool, op_type?: 'index'|'create' }

Table of Contents

Properties

$bubble  : bool
$client  : Client|Client
$formatter  : FormatterInterface|null
$level  : Level
$options  : array<string|int, mixed>
$processors  : array<string|int, callable>
$needsType  : bool

Methods

__construct()  : mixed
__destruct()  : mixed
__sleep()  : mixed
close()  : void
Closes the handler.
getBubble()  : bool
Gets the bubbling behavior.
getFormatter()  : FormatterInterface
getLevel()  : Level
Gets minimum logging level at which this handler will be triggered.
getOptions()  : array<string|int, mixed>
Getter options
handle()  : bool
Handles a record.
handleBatch()  : void
Handles a set of records at once.
isHandling()  : bool
Checks whether the given record will be handled by this handler.
popProcessor()  : callable
pushProcessor()  : HandlerInterface
reset()  : void
setBubble()  : $this
Sets the bubbling behavior.
setFormatter()  : HandlerInterface
Sets the formatter.
setLevel()  : $this
Sets minimum logging level at which this handler will be triggered.
bulkSend()  : void
Use Elasticsearch bulk API to send list of documents
createExceptionFromError()  : Throwable
Creates elasticsearch exception from error array
createExceptionFromResponses()  : Throwable
Creates elasticsearch exception from responses array
getDefaultFormatter()  : FormatterInterface
processRecord()  : LogRecord
resetProcessors()  : void
write()  : void
Writes the (already formatted) record down to the log of the implementing handler

Properties

$options

protected array<string|int, mixed> $options

Handler config options

Tags
phpstan-var

Options

$processors

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

array<(callable(LogRecord): LogRecord)|ProcessorInterface>

Methods

__construct()

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

Elasticsearch Client object

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

Handler configuration

$level : int|string|Level = Level::Debug

The minimum logging level at which this handler will be triggered

$bubble : bool = true

Whether the messages that are handled can bubble up the stack or not

Tags
phpstan-param

InputOptions $options

__destruct()

public __destruct() : mixed

close()

Closes the handler.

public close() : void
Tags
inheritDoc

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() : Level
Return values
Level

getOptions()

Getter options

public getOptions() : array<string|int, mixed>
Tags
phpstan-return

Options

Return values
array<string|int, mixed>

handle()

Handles a record.

public handle(LogRecord $record) : bool
Parameters
$record : LogRecord

The record to handle

Tags
inheritDoc
Return values
bool —

true means that this handler handled the record, and that bubbling is not permitted. false means the record was either not processed or that this handler allows bubbling.

handleBatch()

Handles a set of records at once.

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

The records to handle

Tags
inheritDoc

isHandling()

Checks whether the given record will be handled by this handler.

public isHandling(LogRecord $record) : bool
Parameters
$record : LogRecord

Partial log record having only a level initialized

Tags
inheritDoc
Return values
bool

setBubble()

Sets the bubbling behavior.

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

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

Return values
$this

setLevel()

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

public setLevel(Level|LogLevel::* $level) : $this
Parameters
$level : Level|LogLevel::*

Level or level name

Tags
phpstan-param

value-ofLevel::VALUES|value-ofLevel::NAMES|Level|LogLevel::* $level

Return values
$this

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

createExceptionFromError()

Creates elasticsearch exception from error array

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

createExceptionFromResponses()

Creates elasticsearch exception from responses array

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

Only the first error is converted into an exception.

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

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

Return values
Throwable

write()

Writes the (already formatted) record down to the log of the implementing handler

protected write(LogRecord $record) : void
Parameters
$record : LogRecord
Tags
inheritDoc
On this page

Search results