ElasticaHandler
extends AbstractProcessingHandler
in package
Elastic Search handler
Usage example:
$client = new \Elastica\Client(); $options = array( 'index' => 'elastic_index_name', 'type' => 'elastic_doc_type', ); $handler = new ElasticaHandler($client, $options); $log = new Logger('application'); $log->pushHandler($handler);
Tags
Table of Contents
- $bubble : mixed
- $client : Client
- $formatter : FormatterInterface
- $level : mixed
- $options : array<string|int, mixed>
- $processors : mixed
- __construct() : mixed
- __destruct() : mixed
- close() : mixed
- Closes the handler.
- getBubble() : bool
- Gets the bubbling behavior.
- getFormatter() : FormatterInterface
- Gets the formatter.
- getLevel() : int
- Gets minimum logging level at which this handler will be triggered.
- getOptions() : array<string|int, mixed>
- handle() : mixed
- {@inheritdoc}
- handleBatch() : void
- {@inheritdoc}
- isHandling() : bool
- Checks whether the given record will be handled by this handler.
- popProcessor() : callable
- Removes the processor on top of the stack and returns it.
- pushProcessor() : self
- Adds a processor in the stack.
- reset() : mixed
- 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
- getDefaultFormatter() : FormatterInterface
- {@inheritDoc}
- processRecord() : array<string|int, mixed>
- Processes a record.
- write() : void
- Writes the record down to the log of the implementing handler
Properties
$bubble
protected
mixed
$bubble
= true
$client
protected
Client
$client
$formatter
protected
FormatterInterface
$formatter
$level
protected
mixed
$level
= MonologLogger::DEBUG
$options
protected
array<string|int, mixed>
$options
= []
Handler config options
$processors
protected
mixed
$processors
= array()
Methods
__construct()
public
__construct(Client $client[, array<string|int, mixed> $options = [] ][, int|string $level = Logger::DEBUG ][, bool $bubble = true ]) : mixed
Parameters
- $client : Client
-
Elastica Client object
- $options : array<string|int, mixed> = []
-
Handler configuration
- $level : int|string = Logger::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
Return values
mixed —__destruct()
public
__destruct() : mixed
Return values
mixed —close()
Closes the handler.
public
close() : mixed
This will be called automatically when the object is destroyed
Return values
mixed —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.
getFormatter()
Gets the formatter.
public
getFormatter() : FormatterInterface
Return values
FormatterInterface —getLevel()
Gets minimum logging level at which this handler will be triggered.
public
getLevel() : int
Return values
int —getOptions()
public
getOptions() : array<string|int, mixed>
Return values
array<string|int, mixed> —handle()
{@inheritdoc}
public
handle(array<string|int, mixed> $record) : mixed
Parameters
- $record : array<string|int, mixed>
Return values
mixed —handleBatch()
{@inheritdoc}
public
handleBatch(array<string|int, mixed> $records) : void
Parameters
- $records : array<string|int, mixed>
Return values
void —isHandling()
Checks whether the given record will be handled by this handler.
public
isHandling(array<string|int, mixed> $record) : bool
Parameters
- $record : array<string|int, mixed>
-
Partial log record containing only a level key
Return values
bool —popProcessor()
Removes the processor on top of the stack and returns it.
public
popProcessor() : callable
Return values
callable —pushProcessor()
Adds a processor in the stack.
public
pushProcessor(mixed $callback) : self
Parameters
- $callback : mixed
Return values
self —reset()
public
reset() : mixed
Return values
mixed —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 —setFormatter()
{@inheritdoc}
public
setFormatter(FormatterInterface $formatter) : HandlerInterface
Parameters
- $formatter : FormatterInterface
Return values
HandlerInterface —setLevel()
Sets minimum logging level at which this handler will be triggered.
public
setLevel(int|string $level) : self
Parameters
- $level : int|string
-
Level or level name
Return values
self —bulkSend()
Use Elasticsearch bulk API to send list of documents
protected
bulkSend(array<string|int, mixed> $documents) : void
Parameters
- $documents : array<string|int, mixed>
Tags
Return values
void —getDefaultFormatter()
{@inheritDoc}
protected
getDefaultFormatter() : FormatterInterface
Return values
FormatterInterface —processRecord()
Processes a record.
protected
processRecord(array<string|int, mixed> $record) : array<string|int, mixed>
Parameters
- $record : array<string|int, mixed>
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>