Documentation

CubeHandler extends AbstractProcessingHandler
in package

Logs to Cube.

Since 2.8.0 and 3.2.0, Cube appears abandoned and thus we will drop this handler in Monolog 4

Tags
link
https://github.com/square/cube/wiki
author

Wan Chen kami@kamisama.me

Table of Contents

Properties

$bubble  : bool
$formatter  : FormatterInterface|null
$level  : Level
$processors  : array<string|int, callable>
$acceptedSchemes  : array<string|int, string>
$host  : string
$httpConnection  : CurlHandle|null
$port  : int
$scheme  : string
$udpConnection  : Socket|null

Methods

__construct()  : mixed
Create a Cube handler
__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.
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
setLevel()  : $this
Sets minimum logging level at which this handler will be triggered.
connectHttp()  : void
Establish a connection to an http server
connectUdp()  : void
Establish a connection to an UDP socket
getDefaultFormatter()  : FormatterInterface
Gets the default formatter.
processRecord()  : LogRecord
resetProcessors()  : void
write()  : void
Writes the (already formatted) record down to the log of the implementing handler
writeHttp()  : void
writeUdp()  : void

Properties

$processors

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

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

$acceptedSchemes

private array<string|int, string> $acceptedSchemes = ['http', 'udp']

$httpConnection

private CurlHandle|null $httpConnection = null

$udpConnection

private Socket|null $udpConnection = null

Methods

__construct()

Create a Cube handler

public __construct(string $url[, int|string|Level $level = Level::Debug ][, bool $bubble = true ]) : mixed
Parameters
$url : string
$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
throws
UnexpectedValueException

when given url is not a valid url. A valid url must consist of three parts : protocol://host:port Only valid protocols used by Cube are http and udp

__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

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

connectHttp()

Establish a connection to an http server

protected connectHttp() : void
Tags
throws
LogicException

when unable to connect to the socket

throws
MissingExtensionException

when no curl extension

connectUdp()

Establish a connection to an UDP socket

protected connectUdp() : void
Tags
throws
LogicException

when unable to connect to the socket

throws
MissingExtensionException

when there is no socket extension

write()

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

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

writeHttp()

private writeHttp(string $data) : void
Parameters
$data : string

writeUdp()

private writeUdp(string $data) : void
Parameters
$data : string

        
On this page

Search results