handle()
reset()
pushProcessor()
popProcessor()
setFormatter()
getFormatter()
__construct()
isHandling()
setLevel()
getLevel()
setBubble()
getBubble()
handleBatch()
close()
__destruct()
__sleep()
getOptions()

No public properties found

No constants found

write()
processRecord()
resetProcessors()
getDefaultFormatter()
bulkSend()
createExceptionFromResponses()
createExceptionFromError()

$processors
$formatter
$level
$bubble
$client
$options

N/A

No private methods found

$needsType

N/A

File: vendor/monolog/monolog/src/Monolog/Handler/ElasticsearchHandler.php
Package: Application
Class hierarchy: Handler

AbstractHandler

AbstractProcessingHandler

\Monolog\Handler\ElasticsearchHandler
See also: 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);
Uses

Tags

author	Avtandil Kikabidze akalongman@gmail.com

Properties

$processors

$processors : callable[]

Type

callable[] —

Inherited from: \Monolog\Handler\ProcessableHandlerTrait
Uses

Tags

phpstan-var	array<ProcessorInterface\|callable(Record): Record>

$formatter

$formatter : ?\Monolog\Formatter\FormatterInterface

Type

FormatterInterface —

$level

$level : int

Type

int —

Inherited from: \Monolog\Handler\AbstractHandler
Uses

Tags

phpstan-var	Level

$bubble

$bubble : bool

Type

bool —

$client

$client : \Elasticsearch\Client|\Elastic\Elasticsearch\Client

Type

Client —

$options

$options : array

Type

array — Handler config options

$needsType

$needsType : bool

Type

bool —

Methods

handle()

handle(array  $record) : bool

{@inheritDoc}

Parameters

array

$record

Returns

bool —

reset()

reset() : void

pushProcessor()

pushProcessor(callable  $callback) : \Monolog\Handler\HandlerInterface

{@inheritDoc}

Parameters

callable

$callback

Returns

\Monolog\Handler\HandlerInterface —

popProcessor()

popProcessor() : callable

{@inheritDoc}

Returns

callable —

setFormatter()

setFormatter(\Monolog\Formatter\FormatterInterface  $formatter) : \Monolog\Handler\HandlerInterface

{@inheritDoc}

Parameters

\Monolog\Formatter\FormatterInterface

$formatter

Returns

\Monolog\Handler\HandlerInterface —

getFormatter()

getFormatter() : \Monolog\Formatter\FormatterInterface

{@inheritDoc}

Returns

\Monolog\Formatter\FormatterInterface —

__construct()

__construct(\Elasticsearch\Client|\Elastic\Elasticsearch\Client  $client, array  $options = [], mixed  $level = Logger::DEBUG, bool  $bubble = true) : mixed

Parameters

\Elasticsearch\Client\|\Elastic\Elasticsearch\Client	$client	Elasticsearch Client object
array	$options	Handler configuration
mixed	$level
bool	$bubble

Returns

mixed —

isHandling()

isHandling(array  $record) : bool

{@inheritDoc}

Parameters

array

$record

Returns

bool —

setLevel()

setLevel(mixed  $level) : self

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

Parameters

mixed

$level

Returns

self —

getLevel()

getLevel() : int

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

Returns

int —

Inherited from: \Monolog\Handler\AbstractHandler
Uses

Tags

phpstan-return	Level

setBubble()

setBubble(bool  $bubble) : self

Sets the bubbling behavior.

Parameters

bool

$bubble

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

Returns

self —

getBubble()

getBubble() : bool

Gets the bubbling behavior.

Returns

bool —

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

handleBatch()

handleBatch(array  $records) : void

{@inheritDoc}

Parameters

array

$records

close()

close() : void

Closes the handler.

__destruct()

__destruct() : mixed

Returns

mixed —

__sleep()

__sleep() : mixed

Returns

mixed —

getOptions()

getOptions() : array

Getter options

Returns

array —

write()

write(array  $record) : void

Writes the record down to the log of the implementing handler

Parameters

array

$record

processRecord()

processRecord(array  $record) : array

Processes a record.

Parameters

array

$record

Returns

array —

Inherited from: \Monolog\Handler\ProcessableHandlerTrait
Uses

Tags

phpstan-param	Record $record
phpstan-return	Record

resetProcessors()

resetProcessors() : void

getDefaultFormatter()

getDefaultFormatter() : \Monolog\Formatter\FormatterInterface

{@inheritDoc}

Returns

\Monolog\Formatter\FormatterInterface —

bulkSend()

bulkSend(array[]  $records) : void

Use Elasticsearch bulk API to send list of documents

Parameters

array[]

$records

Records + _index/_type keys

Throws

\RuntimeException

createExceptionFromResponses()

createExceptionFromResponses(array|\Elastic\Elasticsearch\Response\Elasticsearch  $responses) : \Throwable

Creates elasticsearch exception from responses array

Only the first error is converted into an exception.

Parameters

array|\Elastic\Elasticsearch\Response\Elasticsearch

$responses

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

Returns

\Throwable —

createExceptionFromError()

createExceptionFromError(array  $error) : \Throwable

Creates elasticsearch exception from error array

Parameters

array

$error

Returns

\Throwable —