1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
|
<?php
/*
* This file is part of the Monolog package.
*
* (c) Jordi Boggiano <j.boggiano@seld.be>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Monolog\Handler;
use Monolog\Logger;
use Monolog\Formatter\LineFormatter;
/**
* Sends notifications through Slack API
*
* @author Greg Kedzierski <greg@gregkedzierski.com>
* @see https://api.slack.com/
*/
class SlackHandler extends SocketHandler
{
/**
* Slack API token
* @var string
*/
private $token;
/**
* Slack channel (encoded ID or name)
* @var string
*/
private $channel;
/**
* Name of a bot
* @var string
*/
private $username;
/**
* Emoji icon name
* @var string
*/
private $iconEmoji;
/**
* Whether the message should be added to Slack as attachment (plain text otherwise)
* @var bool
*/
private $useAttachment;
/**
* Whether the the message that is added to Slack as attachment is in a short style (or not)
* @var bool
*/
private $useShortAttachment;
/**
* Whether the attachment should include extra data (or not)
* @var bool
*/
private $includeExtra;
/**
* @var LineFormatter
*/
private $lineFormatter;
/**
* @param string $token Slack API token
* @param string $channel Slack channel (encoded ID or name)
* @param string $username Name of a bot
* @param bool $useAttachment Whether the message should be added to Slack as attachment (plain text otherwise)
* @param string|null $iconEmoji The emoji name to use (or null)
* @param int $level The minimum logging level at which this handler will be triggered
* @param bool $bubble Whether the messages that are handled can bubble up the stack or not
*/
public function __construct($token, $channel, $username = 'Monolog', $useAttachment = true, $iconEmoji = null, $level = Logger::CRITICAL, $bubble = true, $useShortAttachment = false, $includeExtra = false)
{
if (!extension_loaded('openssl')) {
throw new MissingExtensionException('The OpenSSL PHP extension is required to use the SlackHandler');
}
parent::__construct('ssl://slack.com:443', $level, $bubble);
$this->token = $token;
$this->channel = $channel;
$this->username = $username;
$this->iconEmoji = trim($iconEmoji, ':');
$this->useAttachment = $useAttachment;
$this->useShortAttachment = $useShortAttachment;
$this->includeExtra = $includeExtra;
if ($this->includeExtra) {
$this->lineFormatter = new LineFormatter;
}
}
/**
* {@inheritdoc}
*
* @param array $record
* @return string
*/
protected function generateDataStream($record)
{
$content = $this->buildContent($record);
return $this->buildHeader($content) . $content;
}
/**
* Builds the body of API call
*
* @param array $record
* @return string
*/
private function buildContent($record)
{
$dataArray = array(
'token' => $this->token,
'channel' => $this->channel,
'username' => $this->username,
'text' => '',
'attachments' => array()
);
if ($this->useAttachment) {
$attachment = array(
'fallback' => $record['message'],
'color' => $this->getAttachmentColor($record['level'])
);
if ($this->useShortAttachment) {
$attachment['fields'] = array(
array(
'title' => $record['level_name'],
'value' => $record['message'],
'short' => false
)
);
} else {
$attachment['fields'] = array(
array(
'title' => 'Message',
'value' => $record['message'],
'short' => false
),
array(
'title' => 'Level',
'value' => $record['level_name'],
'short' => true
)
);
}
if ($this->includeExtra) {
$extra = '';
foreach ($record['extra'] as $var => $val) {
$extra .= $var.': '.$this->lineFormatter->stringify($val)." | ";
}
$extra = rtrim($extra, " |");
$attachment['fields'][] = array(
'title' => "Extra",
'value' => $extra,
'short' => false
);
}
$dataArray['attachments'] = json_encode(array($attachment));
} else {
$dataArray['text'] = $record['message'];
}
if ($this->iconEmoji) {
$dataArray['icon_emoji'] = ":{$this->iconEmoji}:";
}
return http_build_query($dataArray);
}
/**
* Builds the header of the API Call
*
* @param string $content
* @return string
*/
private function buildHeader($content)
{
$header = "POST /api/chat.postMessage HTTP/1.1\r\n";
$header .= "Host: slack.com\r\n";
$header .= "Content-Type: application/x-www-form-urlencoded\r\n";
$header .= "Content-Length: " . strlen($content) . "\r\n";
$header .= "\r\n";
return $header;
}
/**
* {@inheritdoc}
*
* @param array $record
*/
protected function write(array $record)
{
parent::write($record);
$this->closeSocket();
}
/**
* Returned a Slack message attachment color associated with
* provided level.
*
* @param int $level
* @return string
*/
protected function getAttachmentColor($level)
{
switch (true) {
case $level >= Logger::ERROR:
return 'danger';
case $level >= Logger::WARNING:
return 'warning';
case $level >= Logger::INFO:
return 'good';
default:
return '#e3e4e6';
}
}
}
|
