LogglyHandler
extends AbstractProcessingHandler
in package
Sends errors to Loggly.
Tags
Table of Contents
Constants
- ENDPOINT_BATCH = 'bulk'
- ENDPOINT_SINGLE = 'inputs'
- HOST = 'logs-01.loggly.com'
Properties
- $bubble : bool
- $curlHandlers : array<string|int, CurlHandle>
- Caches the curl handlers for every given endpoint.
- $formatter : FormatterInterface|null
- $level : Level
- $processors : array<string|int, callable>
- $tag : array<string|int, string>
- $token : string
Methods
- __construct() : mixed
- __destruct() : mixed
- __sleep() : mixed
- addTag() : $this
- 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.
- setTag() : $this
- getCurlHandler() : CurlHandle
- Loads and returns the shared curl handler for the given endpoint.
- getDefaultFormatter() : FormatterInterface
- processRecord() : LogRecord
- resetProcessors() : void
- send() : void
- write() : void
- Writes the (already formatted) record down to the log of the implementing handler
- loadCurlHandle() : CurlHandle
- Starts a fresh curl session for the given endpoint and returns its handler.
Constants
ENDPOINT_BATCH
protected
mixed
ENDPOINT_BATCH
= 'bulk'
ENDPOINT_SINGLE
protected
mixed
ENDPOINT_SINGLE
= 'inputs'
HOST
protected
mixed
HOST
= 'logs-01.loggly.com'
Properties
$bubble
protected
bool
$bubble
= true
$curlHandlers
Caches the curl handlers for every given endpoint.
protected
array<string|int, CurlHandle>
$curlHandlers
= []
$formatter
protected
FormatterInterface|null
$formatter
= null
$level
protected
Level
$level
= \Monolog\Level::Debug
$processors
protected
array<string|int, callable>
$processors
= []
Tags
$tag
protected
array<string|int, string>
$tag
= []
$token
protected
string
$token
Methods
__construct()
public
__construct(string $token[, int|string|Level $level = Level::Debug ][, bool $bubble = true ]) : mixed
Parameters
- $token : string
-
API token supplied by Loggly
- $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
__destruct()
public
__destruct() : mixed
__sleep()
public
__sleep() : mixed
addTag()
public
addTag(array<string|int, string>|string $tag) : $this
Parameters
- $tag : array<string|int, string>|string
Return values
$thisclose()
Closes the handler.
public
close() : void
Tags
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()
public
getFormatter() : FormatterInterface
Tags
Return values
FormatterInterfacegetLevel()
Gets minimum logging level at which this handler will be triggered.
public
getLevel() : Level
Return values
Levelhandle()
Handles a record.
public
handle(LogRecord $record) : bool
Parameters
- $record : LogRecord
-
The record to handle
Tags
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
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
Return values
boolpopProcessor()
public
popProcessor() : callable
Tags
Return values
callablepushProcessor()
public
pushProcessor(callable $callback) : HandlerInterface
Parameters
- $callback : callable
Tags
Return values
HandlerInterfacereset()
public
reset() : void
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
$thissetFormatter()
public
setFormatter(FormatterInterface $formatter) : HandlerInterface
Parameters
- $formatter : FormatterInterface
Tags
Return values
HandlerInterfacesetLevel()
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
Return values
$thissetTag()
public
setTag(array<string|int, string>|string $tag) : $this
Parameters
- $tag : array<string|int, string>|string
Return values
$thisgetCurlHandler()
Loads and returns the shared curl handler for the given endpoint.
protected
getCurlHandler(string $endpoint) : CurlHandle
Parameters
- $endpoint : string
Return values
CurlHandlegetDefaultFormatter()
protected
getDefaultFormatter() : FormatterInterface
Return values
FormatterInterfaceprocessRecord()
protected
processRecord(LogRecord $record) : LogRecord
Parameters
- $record : LogRecord
Return values
LogRecordresetProcessors()
protected
resetProcessors() : void
send()
protected
send(string $data, string $endpoint) : void
Parameters
- $data : string
- $endpoint : string
write()
Writes the (already formatted) record down to the log of the implementing handler
protected
write(LogRecord $record) : void
Parameters
- $record : LogRecord
loadCurlHandle()
Starts a fresh curl session for the given endpoint and returns its handler.
private
loadCurlHandle(string $endpoint) : CurlHandle
Parameters
- $endpoint : string