\Monolog\HandlerMongoDBHandler

Logs to a MongoDB database.

Usage example:

$log = new \Monolog\Logger('application'); $client = new \MongoDB\Client('mongodb://localhost:27017'); $mongodb = new \Monolog\Handler\MongoDBHandler($client, 'logs', 'prod'); $log->pushHandler($mongodb);

The above examples uses the MongoDB PHP library's client class; however, the MongoDB\Driver\Manager class from ext-mongodb is also supported.

Summary

Methods
Properties
Constants
handle()
reset()
pushProcessor()
popProcessor()
setFormatter()
getFormatter()
__construct()
isHandling()
setLevel()
getLevel()
setBubble()
getBubble()
handleBatch()
close()
__destruct()
__sleep()
No public properties found
No constants found
write()
processRecord()
resetProcessors()
getDefaultFormatter()
$processors
$formatter
$level
$bubble
N/A
No private methods found
$collection
$manager
$namespace
N/A

Properties

$processors

$processors : array<mixed,callable>

Type

array<mixed,callable>

$formatter

$formatter : \Monolog\Handler\?FormatterInterface

Type

\Monolog\Handler\?FormatterInterface

$level

$level : 

Type

$bubble

$bubble : 

Type

$collection

$collection : 

Type

$manager

$manager : 

Type

$namespace

$namespace : 

Type

Methods

handle()

handle(array  $record) 

{@inheritdoc}

Parameters

array $record

reset()

reset() : void

pushProcessor()

pushProcessor(callable  $callback) 

{@inheritdoc}

Parameters

callable $callback

popProcessor()

popProcessor() 

{@inheritdoc}

getFormatter()

getFormatter() 

{@inheritdoc}

__construct()

__construct(\MongoDB\Client|\MongoDB\Driver\Manager  $mongodb, string  $database, string  $collection, string|integer  $level = \Monolog\Logger::DEBUG, boolean  $bubble = true) 

Constructor.

Parameters

\MongoDB\Client|\MongoDB\Driver\Manager $mongodb

MongoDB library or driver client

string $database

Database name

string $collection

Collection name

string|integer $level

The minimum logging level at which this handler will be triggered

boolean $bubble

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

isHandling()

isHandling(array  $record) 

{@inheritdoc}

Parameters

array $record

setLevel()

setLevel(integer|string  $level) : self

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

Parameters

integer|string $level

Level or level name

Returns

self

getLevel()

getLevel() : integer

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

Returns

integer

setBubble()

setBubble(boolean  $bubble) : self

Sets the bubbling behavior.

Parameters

boolean $bubble

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

Returns

self

getBubble()

getBubble() : boolean

Gets the bubbling behavior.

Returns

boolean —

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

handleBatch()

handleBatch(array  $records) 

Handles a set of records at once.

Parameters

array $records

The records to handle (an array of record arrays)

close()

close() 

Closes the handler.

Ends a log cycle and frees all resources used by the handler.

Closing a Handler means flushing all buffers and freeing any open resources/handles.

Implementations have to be idempotent (i.e. it should be possible to call close several times without breakage) and ideally handlers should be able to reopen themselves on handle() after they have been closed.

This is useful at the end of a request and will be called automatically when the object is destroyed if you extend Monolog\Handler\Handler.

If you are thinking of calling this method yourself, most likely you should be calling ResettableInterface::reset instead. Have a look.

__destruct()

__destruct() 

__sleep()

__sleep() 

write()

write(array  $record) 

Writes the record down to the log of the implementing handler

Parameters

array $record

processRecord()

processRecord(array  $record) 

Processes a record.

Parameters

array $record

resetProcessors()

resetProcessors() 

getDefaultFormatter()

getDefaultFormatter() 

{@inheritDoc}