\Monolog\HandlerSlackWebhookHandler

Sends notifications through Slack Webhooks

Classes extending it should (in most cases) only implement write($record)

Summary

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

Properties

$level

$level : 

Type

$bubble

$bubble : 

Type

$processors

$processors : 

Type

$webhookUrl

$webhookUrl : string

Slack Webhook token

Type

string

$slackRecord

$slackRecord : \Monolog\Handler\Slack\SlackRecord

Instance of the SlackRecord util class preparing data for Slack API.

Type

\Monolog\Handler\Slack\SlackRecord

Methods

handle()

handle(array  $record) 

{@inheritdoc}

Parameters

array $record

__construct()

__construct(string  $webhookUrl, string|null  $channel = null, string|null  $username = null, boolean  $useAttachment = true, string|null  $iconEmoji = null, boolean  $useShortAttachment = false, boolean  $includeContextAndExtra = false, integer  $level = \Monolog\Logger::CRITICAL, boolean  $bubble = true, array  $excludeFields = array()) 

Parameters

string $webhookUrl

Slack Webhook URL

string|null $channel

Slack channel (encoded ID or name)

string|null $username

Name of a bot

boolean $useAttachment

Whether the message should be added to Slack as attachment (plain text otherwise)

string|null $iconEmoji

The emoji name to use (or null)

boolean $useShortAttachment

Whether the the context/extra messages added to Slack as attachments are in a short style

boolean $includeContextAndExtra

Whether the attachment should include context and extra data

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

array $excludeFields

Dot separated list of fields to exclude from slack message. E.g. ['context.field1', 'extra.field2']

isHandling()

isHandling(array  $record) : Boolean

Checks whether the given record will be handled by this handler.

This is mostly done for performance reasons, to avoid calling processors for nothing.

Handlers should still check the record levels within handle(), returning false in isHandling() is no guarantee that handle() will not be called, and isHandling() might not be called for a given record.

Parameters

array $record

Partial log record containing only a level key

Returns

Boolean

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.

This will be called automatically when the object is destroyed

pushProcessor()

pushProcessor(callable  $callback) : self

Adds a processor in the stack.

Parameters

callable $callback

Returns

self

popProcessor()

popProcessor() : callable

Removes the processor on top of the stack and returns it.

Returns

callable

getFormatter()

getFormatter() 

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.

__destruct()

__destruct() 

getSlackRecord()

getSlackRecord() 

write()

write(array  $record) : void

Writes the record down to the log of the implementing handler

Parameters

array $record

processRecord()

processRecord(array  $record) : array

Processes a record.

Parameters

array $record

Returns

array