Documentation

LogglyHandler extends AbstractProcessingHandler
in package

Sends errors to Loggly.

Tags
author

Przemek Sobstel przemek@sobstel.org

author

Adam Pancutt adam@pancutt.com

author

Gregory Barchard gregory@barchard.net

Table of Contents

Constants

ENDPOINT_BATCH  = 'bulk'
ENDPOINT_SINGLE  = 'inputs'
HOST  = 'logs-01.loggly.com'

Properties

$bubble  : bool
$curlHandlers  : array<string|int, resource>|array<string|int, CurlHandle>
Caches the curl handlers for every given endpoint.
$formatter  : FormatterInterface|null
$level  : int
$processors  : array<string|int, callable>
$tag  : array<string|int, string>
$token  : string

Methods

__construct()  : mixed
__destruct()  : mixed
__sleep()  : mixed
addTag()  : self
close()  : void
Closes the handler.
getBubble()  : bool
Gets the bubbling behavior.
getFormatter()  : FormatterInterface
{@inheritDoc}
getLevel()  : int
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
{@inheritDoc}
pushProcessor()  : HandlerInterface
{@inheritDoc}
reset()  : void
setBubble()  : self
Sets the bubbling behavior.
setFormatter()  : HandlerInterface
{@inheritDoc}
setLevel()  : self
Sets minimum logging level at which this handler will be triggered.
setTag()  : self
getCurlHandler()  : resource|CurlHandle
Loads and returns the shared curl handler for the given endpoint.
getDefaultFormatter()  : FormatterInterface
processRecord()  : array<string|int, mixed>
Processes a record.
resetProcessors()  : void
send()  : void
write()  : void
Writes the record down to the log of the implementing handler
loadCurlHandle()  : resource|CurlHandle
Starts a fresh curl session for the given endpoint and returns its handler.

Constants

Properties

$curlHandlers

Caches the curl handlers for every given endpoint.

protected array<string|int, resource>|array<string|int, CurlHandle> $curlHandlers = []

$level

protected int $level = \Monolog\Logger::DEBUG
Tags
phpstan-var

Level

$processors

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

array<ProcessorInterface|callable(Record): Record>

Methods

__construct()

public __construct(string $token[, mixed $level = Logger::DEBUG ][, bool $bubble = true ]) : mixed
Parameters
$token : string

API token supplied by Loggly

$level : mixed = 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

Tags
throws
MissingExtensionException

If the curl extension is missing

__destruct()

public __destruct() : mixed

addTag()

public addTag(array<string|int, string>|string $tag) : self
Parameters
$tag : array<string|int, string>|string
Return values
self

close()

Closes the handler.

public close() : void

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() : int
Tags
phpstan-return

Level

Return values
int

handle()

Handles a record.

public handle(array<string|int, mixed> $record) : bool
Parameters
$record : array<string|int, mixed>

The record to handle

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 (an array of record arrays)

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

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

setLevel()

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

public setLevel(Level|LevelName|LogLevel::* $level) : self
Parameters
$level : Level|LevelName|LogLevel::*

Level or level name

Return values
self

setTag()

public setTag(array<string|int, string>|string $tag) : self
Parameters
$tag : array<string|int, string>|string
Return values
self

getCurlHandler()

Loads and returns the shared curl handler for the given endpoint.

protected getCurlHandler(string $endpoint) : resource|CurlHandle
Parameters
$endpoint : string
Return values
resource|CurlHandle

processRecord()

Processes a record.

protected processRecord(array<string|int, mixed> $record) : array<string|int, mixed>
Parameters
$record : array<string|int, mixed>
Tags
phpstan-param

Record $record

phpstan-return

Record

Return values
array<string|int, mixed>

send()

protected send(string $data, string $endpoint) : void
Parameters
$data : string
$endpoint : string

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>

loadCurlHandle()

Starts a fresh curl session for the given endpoint and returns its handler.

private loadCurlHandle(string $endpoint) : resource|CurlHandle
Parameters
$endpoint : string
Return values
resource|CurlHandle 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results