diff options
| -rw-r--r-- | src/Monolog/Handler/Slack/SlackRecord.php | 128 | ||||
| -rw-r--r-- | src/Monolog/Handler/SlackHandler.php | 6 | ||||
| -rw-r--r-- | src/Monolog/Handler/SlackWebhookHandler.php | 6 | ||||
| -rw-r--r-- | tests/Monolog/Handler/Slack/SlackRecordTest.php | 156 | ||||
| -rw-r--r-- | tests/Monolog/Handler/SlackWebhookHandlerTest.php | 9 |
5 files changed, 201 insertions, 104 deletions
diff --git a/src/Monolog/Handler/Slack/SlackRecord.php b/src/Monolog/Handler/Slack/SlackRecord.php index cb0b871..38bc838 100644 --- a/src/Monolog/Handler/Slack/SlackRecord.php +++ b/src/Monolog/Handler/Slack/SlackRecord.php @@ -12,7 +12,7 @@ namespace Monolog\Handler\Slack; use Monolog\Logger; -use Monolog\Formatter\LineFormatter; +use Monolog\Formatter\NormalizerFormatter; use Monolog\Formatter\FormatterInterface; /** @@ -41,15 +41,15 @@ class SlackRecord /** * Name of a bot - * @var string + * @var string|null */ private $username; /** - * Emoji icon name + * User icon e.g. 'ghost', 'http://example.com/user.png' * @var string */ - private $iconEmoji; + private $userIcon; /** * Whether the message should be added to Slack as attachment (plain text otherwise) @@ -70,42 +70,51 @@ class SlackRecord private $includeContextAndExtra; /** + * Dot separated list of fields to exclude from slack message. E.g. ['context.field1', 'extra.field2'] + * @var array + */ + private $excludeFields; + + /** * @var FormatterInterface */ private $formatter; /** - * @var LineFormatter + * @var NormalizerFormatter */ - private $lineFormatter; + private $normalizerFormatter; - public function __construct($channel = null, $username = 'Monolog', $useAttachment = true, $iconEmoji = null, $useShortAttachment = false, $includeContextAndExtra = false, FormatterInterface $formatter = null) + public function __construct($channel = null, $username = null, $useAttachment = true, $userIcon = null, $useShortAttachment = false, $includeContextAndExtra = false, array $excludeFields = array(), FormatterInterface $formatter = null) { $this->channel = $channel; $this->username = $username; - $this->iconEmoji = trim($iconEmoji, ':'); + $this->userIcon = trim($userIcon, ':'); $this->useAttachment = $useAttachment; $this->useShortAttachment = $useShortAttachment; $this->includeContextAndExtra = $includeContextAndExtra; + $this->excludeFields = $excludeFields; $this->formatter = $formatter; if ($this->includeContextAndExtra) { - $this->lineFormatter = new LineFormatter(); + $this->normalizerFormatter = new NormalizerFormatter(); } } public function getSlackData(array $record) { - $dataArray = array( - 'username' => $this->username, - 'text' => '', - ); + $dataArray = array(); + $record = $this->excludeFields($record); + + if ($this->username) { + $dataArray['username'] = $this->username; + } if ($this->channel) { $dataArray['channel'] = $this->channel; } - if ($this->formatter) { + if ($this->formatter && !$this->useAttachment) { $message = $this->formatter->format($record); } else { $message = $record['message']; @@ -113,19 +122,22 @@ class SlackRecord if ($this->useAttachment) { $attachment = array( - 'fallback' => $message, - 'text' => $message, - 'color' => $this->getAttachmentColor($record['level']), - 'fields' => array(), + 'fallback' => $message, + 'text' => $message, + 'color' => $this->getAttachmentColor($record['level']), + 'fields' => array(), + 'mrkdwn_in' => array('fields'), + 'ts' => $record['datetime']->getTimestamp() ); if ($this->useShortAttachment) { $attachment['title'] = $record['level_name']; } else { $attachment['title'] = 'Message'; - $attachment['fields'][] = $this->generateAttachmentField('Level', $record['level_name'], true); + $attachment['fields'][] = $this->generateAttachmentField('Level', $record['level_name']); } + if ($this->includeContextAndExtra) { foreach (array('extra', 'context') as $key) { if (empty($record[$key])) { @@ -135,8 +147,7 @@ class SlackRecord if ($this->useShortAttachment) { $attachment['fields'][] = $this->generateAttachmentField( ucfirst($key), - $this->stringify($record[$key]), - true + $record[$key] ); } else { // Add all extra fields as individual fields in attachment @@ -153,8 +164,12 @@ class SlackRecord $dataArray['text'] = $message; } - if ($this->iconEmoji) { - $dataArray['icon_emoji'] = ":{$this->iconEmoji}:"; + if ($this->userIcon) { + if (filter_var($this->userIcon, FILTER_VALIDATE_URL)) { + $dataArray['icon_url'] = $this->userIcon; + } else { + $dataArray['icon_emoji'] = ":{$this->userIcon}:"; + } } return $dataArray; @@ -184,23 +199,21 @@ class SlackRecord /** * Stringifies an array of key/value pairs to be used in attachment fields * - * @param array $fields - * @return string|null + * @param array $fields + * + * @return string */ public function stringify($fields) { - if (!$this->lineFormatter) { - return null; - } - - $string = ''; - foreach ($fields as $var => $val) { - $string .= $var.': '.$this->lineFormatter->stringify($val)." | "; - } + $normalized = $this->normalizerFormatter->format($fields); + $prettyPrintFlag = defined('JSON_PRETTY_PRINT') ? JSON_PRETTY_PRINT : 128; - $string = rtrim($string, " |"); + $hasSecondDimension = count(array_filter($normalized, 'is_array')); + $hasNonNumericKeys = !count(array_filter(array_keys($normalized), 'is_numeric')); - return $string; + return $hasSecondDimension || $hasNonNumericKeys + ? json_encode($normalized, $prettyPrintFlag) + : json_encode($normalized); } /** @@ -217,16 +230,20 @@ class SlackRecord * Generates attachment field * * @param string $title - * @param string|array $value - * @param bool $short + * @param string|array $value\ + * * @return array */ - private function generateAttachmentField($title, $value, $short) + private function generateAttachmentField($title, $value) { + $value = is_array($value) + ? sprintf('```%s```', $this->stringify($value)) + : $value; + return array( 'title' => $title, - 'value' => is_array($value) ? $this->lineFormatter->stringify($value) : $value, - 'short' => $short + 'value' => $value, + 'short' => false ); } @@ -234,15 +251,44 @@ class SlackRecord * Generates a collection of attachment fields from array * * @param array $data + * * @return array */ private function generateAttachmentFields(array $data) { $fields = array(); foreach ($data as $key => $value) { - $fields[] = $this->generateAttachmentField($key, $value, false); + $fields[] = $this->generateAttachmentField($key, $value); } return $fields; } + + /** + * Get a copy of record with fields excluded according to $this->excludeFields + * + * @param array $record + * + * @return array + */ + private function excludeFields(array $record) + { + foreach ($this->excludeFields as $field) { + $keys = explode('.', $field); + $node = &$record; + $lastKey = end($keys); + foreach ($keys as $key) { + if (!isset($node[$key])) { + break; + } + if ($lastKey === $key) { + unset($node[$key]); + break; + } + $node = &$node[$key]; + } + } + + return $record; + } } diff --git a/src/Monolog/Handler/SlackHandler.php b/src/Monolog/Handler/SlackHandler.php index c2cca0c..9324fc9 100644 --- a/src/Monolog/Handler/SlackHandler.php +++ b/src/Monolog/Handler/SlackHandler.php @@ -38,16 +38,17 @@ class SlackHandler extends SocketHandler /** * @param string $token Slack API token * @param string $channel Slack channel (encoded ID or name) - * @param string $username Name of a bot + * @param string|null $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 * @param bool $useShortAttachment Whether the the context/extra messages added to Slack as attachments are in a short style * @param bool $includeContextAndExtra Whether the attachment should include context and extra data + * @param array $excludeFields Dot separated list of fields to exclude from slack message. E.g. ['context.field1', 'extra.field2'] * @throws MissingExtensionException If no OpenSSL PHP extension configured */ - public function __construct($token, $channel, $username = 'Monolog', $useAttachment = true, $iconEmoji = null, $level = Logger::CRITICAL, $bubble = true, $useShortAttachment = false, $includeContextAndExtra = false) + public function __construct($token, $channel, $username = null, $useAttachment = true, $iconEmoji = null, $level = Logger::CRITICAL, $bubble = true, $useShortAttachment = false, $includeContextAndExtra = false, array $excludeFields = array()) { if (!extension_loaded('openssl')) { throw new MissingExtensionException('The OpenSSL PHP extension is required to use the SlackHandler'); @@ -62,6 +63,7 @@ class SlackHandler extends SocketHandler $iconEmoji, $useShortAttachment, $includeContextAndExtra, + $excludeFields, $this->formatter ); diff --git a/src/Monolog/Handler/SlackWebhookHandler.php b/src/Monolog/Handler/SlackWebhookHandler.php index a2df0f1..0d3e3ea 100644 --- a/src/Monolog/Handler/SlackWebhookHandler.php +++ b/src/Monolog/Handler/SlackWebhookHandler.php @@ -38,15 +38,16 @@ class SlackWebhookHandler extends AbstractProcessingHandler /** * @param string $webhookUrl Slack Webhook URL * @param string|null $channel Slack channel (encoded ID or name) - * @param string $username Name of a bot + * @param string|null $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 bool $useShortAttachment Whether the the context/extra messages added to Slack as attachments are in a short style * @param bool $includeContextAndExtra Whether the attachment should include context and extra data * @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 + * @param array $excludeFields Dot separated list of fields to exclude from slack message. E.g. ['context.field1', 'extra.field2'] */ - public function __construct($webhookUrl, $channel = null, $username = 'Monolog', $useAttachment = true, $iconEmoji = null, $useShortAttachment = false, $includeContextAndExtra = false, $level = Logger::CRITICAL, $bubble = true) + public function __construct($webhookUrl, $channel = null, $username = null, $useAttachment = true, $iconEmoji = null, $useShortAttachment = false, $includeContextAndExtra = false, $level = Logger::CRITICAL, $bubble = true, array $excludeFields = array()) { parent::__construct($level, $bubble); @@ -59,6 +60,7 @@ class SlackWebhookHandler extends AbstractProcessingHandler $iconEmoji, $useShortAttachment, $includeContextAndExtra, + $excludeFields, $this->formatter ); } diff --git a/tests/Monolog/Handler/Slack/SlackRecordTest.php b/tests/Monolog/Handler/Slack/SlackRecordTest.php index d6c6c22..e1aa96d 100644 --- a/tests/Monolog/Handler/Slack/SlackRecordTest.php +++ b/tests/Monolog/Handler/Slack/SlackRecordTest.php @@ -19,11 +19,11 @@ use Monolog\TestCase; */ class SlackRecordTest extends TestCase { - private $channel; + private $jsonPrettyPrintFlag; protected function setUp() { - $this->channel = 'monolog_alerts'; + $this->jsonPrettyPrintFlag = defined('JSON_PRETTY_PRINT') ? JSON_PRETTY_PRINT : 128; } public function dataGetAttachmentColor() @@ -39,6 +39,7 @@ class SlackRecordTest extends TestCase array(Logger::EMERGENCY, SlackRecord::COLOR_DANGER), ); } + /** * @dataProvider dataGetAttachmentColor * @param int $logLevel @@ -47,7 +48,7 @@ class SlackRecordTest extends TestCase */ public function testGetAttachmentColor($logLevel, $expectedColour) { - $slackRecord = new SlackRecord('#test'); + $slackRecord = new SlackRecord(); $this->assertSame( $expectedColour, $slackRecord->getAttachmentColor($logLevel) @@ -56,26 +57,20 @@ class SlackRecordTest extends TestCase public function testAddsChannel() { - $record = new SlackRecord($this->channel); + $channel = '#test'; + $record = new SlackRecord($channel); $data = $record->getSlackData($this->getRecord()); $this->assertArrayHasKey('channel', $data); - $this->assertSame($this->channel, $data['channel']); + $this->assertSame($channel, $data['channel']); } - public function testStringifyReturnsNullWithNoLineFormatter() + public function testNoUsernameByDefault() { - $slackRecord = new SlackRecord('#test'); - $this->assertNull($slackRecord->stringify(array('foo' => 'bar'))); - } - - public function testAddsDefaultUsername() - { - $record = new SlackRecord($this->channel); + $record = new SlackRecord(); $data = $record->getSlackData($this->getRecord()); - $this->assertArrayHasKey('username', $data); - $this->assertSame('Monolog', $data['username']); + $this->assertArrayNotHasKey('username', $data); } /** @@ -83,17 +78,24 @@ class SlackRecordTest extends TestCase */ public function dataStringify() { + $jsonPrettyPrintFlag = defined('JSON_PRETTY_PRINT') ? JSON_PRETTY_PRINT : 128; + + $multipleDimensions = array(array(1, 2)); + $numericKeys = array('library' => 'monolog'); + $singleDimension = array(1, 'Hello', 'Jordi'); + return array( - array(array(), ''), - array(array('foo' => 'bar'), 'foo: bar'), - array(array('Foo' => 'bAr'), 'Foo: bAr'), + array(array(), '[]'), + array($multipleDimensions, json_encode($multipleDimensions, $jsonPrettyPrintFlag)), + array($numericKeys, json_encode($numericKeys, $jsonPrettyPrintFlag)), + array($singleDimension, json_encode($singleDimension)) ); } /** * @dataProvider dataStringify */ - public function testStringifyWithLineFormatter($fields, $expectedResult) + public function testStringify($fields, $expectedResult) { $slackRecord = new SlackRecord( '#test', @@ -110,7 +112,7 @@ class SlackRecordTest extends TestCase public function testAddsCustomUsername() { $username = 'Monolog bot'; - $record = new SlackRecord($this->channel, $username); + $record = new SlackRecord(null, $username); $data = $record->getSlackData($this->getRecord()); $this->assertArrayHasKey('username', $data); @@ -119,7 +121,7 @@ class SlackRecordTest extends TestCase public function testNoIcon() { - $record = new SlackRecord($this->channel); + $record = new SlackRecord(); $data = $record->getSlackData($this->getRecord()); $this->assertArrayNotHasKey('icon_emoji', $data); @@ -127,25 +129,22 @@ class SlackRecordTest extends TestCase public function testAddsIcon() { - $record = new SlackRecord($this->channel, 'Monolog', true, 'ghost'); - $data = $record->getSlackData($this->getRecord()); + $record = $this->getRecord(); + $slackRecord = new SlackRecord(null, null, false, 'ghost'); + $data = $slackRecord->getSlackData($record); + + $slackRecord2 = new SlackRecord(null, null, false, 'http://github.com/Seldaek/monolog'); + $data2 = $slackRecord2->getSlackData($record); $this->assertArrayHasKey('icon_emoji', $data); $this->assertSame(':ghost:', $data['icon_emoji']); - } - - public function testAddsEmptyTextIfUseAttachment() - { - $record = new SlackRecord($this->channel); - $data = $record->getSlackData($this->getRecord()); - - $this->assertArrayHasKey('text', $data); - $this->assertSame('', $data['text']); + $this->assertArrayHasKey('icon_url', $data2); + $this->assertSame('http://github.com/Seldaek/monolog', $data2['icon_url']); } public function testAttachmentsNotPresentIfNoAttachment() { - $record = new SlackRecord($this->channel, 'Monolog', false); + $record = new SlackRecord(null, null, false); $data = $record->getSlackData($this->getRecord()); $this->assertArrayNotHasKey('attachments', $data); @@ -153,7 +152,7 @@ class SlackRecordTest extends TestCase public function testAddsOneAttachment() { - $record = new SlackRecord($this->channel); + $record = new SlackRecord(); $data = $record->getSlackData($this->getRecord()); $this->assertArrayHasKey('attachments', $data); @@ -161,10 +160,10 @@ class SlackRecordTest extends TestCase $this->assertInternalType('array', $data['attachments'][0]); } - public function testTextEqualsMessageIfNoFormatter() + public function testTextEqualsMessageIfNoAttachment() { $message = 'Test message'; - $record = new SlackRecord($this->channel, 'Monolog', false); + $record = new SlackRecord(null, null, false); $data = $record->getSlackData($this->getRecord(Logger::WARNING, $message)); $this->assertArrayHasKey('text', $data); @@ -186,7 +185,7 @@ class SlackRecordTest extends TestCase ->will($this->returnCallback(function ($record) { return $record['message'] . 'test1'; })); $message = 'Test message'; - $record = new SlackRecord($this->channel, 'Monolog', false, null, false, false, $formatter); + $record = new SlackRecord(null, null, false, null, false, false, array(), $formatter); $data = $record->getSlackData($this->getRecord(Logger::WARNING, $message)); $this->assertArrayHasKey('text', $data); @@ -202,7 +201,7 @@ class SlackRecordTest extends TestCase public function testAddsFallbackAndTextToAttachment() { $message = 'Test message'; - $record = new SlackRecord($this->channel); + $record = new SlackRecord(null); $data = $record->getSlackData($this->getRecord(Logger::WARNING, $message)); $this->assertSame($message, $data['attachments'][0]['text']); @@ -211,7 +210,7 @@ class SlackRecordTest extends TestCase public function testMapsLevelToColorAttachmentColor() { - $record = new SlackRecord($this->channel); + $record = new SlackRecord(null); $errorLoggerRecord = $this->getRecord(Logger::ERROR); $emergencyLoggerRecord = $this->getRecord(Logger::EMERGENCY); $warningLoggerRecord = $this->getRecord(Logger::WARNING); @@ -238,7 +237,7 @@ class SlackRecordTest extends TestCase { $level = Logger::ERROR; $levelName = Logger::getLevelName($level); - $record = new SlackRecord($this->channel, 'Monolog', true, null, true); + $record = new SlackRecord(null, null, true, null, true); $data = $record->getSlackData($this->getRecord($level, 'test', array('test' => 1))); $attachment = $data['attachments'][0]; @@ -252,9 +251,11 @@ class SlackRecordTest extends TestCase { $level = Logger::ERROR; $levelName = Logger::getLevelName($level); - $record = new SlackRecord($this->channel, 'Monolog', true, null, true, true); - $loggerRecord = $this->getRecord($level, 'test', array('test' => 1)); - $loggerRecord['extra'] = array('tags' => array('web')); + $context = array('test' => 1); + $extra = array('tags' => array('web')); + $record = new SlackRecord(null, null, true, null, true, true); + $loggerRecord = $this->getRecord($level, 'test', $context); + $loggerRecord['extra'] = $extra; $data = $record->getSlackData($loggerRecord); $attachment = $data['attachments'][0]; @@ -266,13 +267,13 @@ class SlackRecordTest extends TestCase array( array( 'title' => 'Extra', - 'value' => 'tags: ["web"]', - 'short' => true + 'value' => sprintf('```%s```', json_encode($extra, $this->jsonPrettyPrintFlag)), + 'short' => false ), array( 'title' => 'Context', - 'value' => 'test: 1', - 'short' => true + 'value' => sprintf('```%s```', json_encode($context, $this->jsonPrettyPrintFlag)), + 'short' => false ) ), $attachment['fields'] @@ -283,7 +284,7 @@ class SlackRecordTest extends TestCase { $level = Logger::ERROR; $levelName = Logger::getLevelName($level); - $record = new SlackRecord($this->channel, 'Monolog', true, null); + $record = new SlackRecord(null, null, true, null); $data = $record->getSlackData($this->getRecord($level, 'test', array('test' => 1))); $attachment = $data['attachments'][0]; @@ -295,7 +296,7 @@ class SlackRecordTest extends TestCase array(array( 'title' => 'Level', 'value' => $levelName, - 'short' => true + 'short' => false )), $attachment['fields'] ); @@ -305,25 +306,27 @@ class SlackRecordTest extends TestCase { $level = Logger::ERROR; $levelName = Logger::getLevelName($level); - $record = new SlackRecord($this->channel, 'Monolog', true, null, false, true); - $loggerRecord = $this->getRecord($level, 'test', array('test' => 1)); - $loggerRecord['extra'] = array('tags' => array('web')); + $context = array('test' => 1); + $extra = array('tags' => array('web')); + $record = new SlackRecord(null, null, true, null, false, true); + $loggerRecord = $this->getRecord($level, 'test', $context); + $loggerRecord['extra'] = $extra; $data = $record->getSlackData($loggerRecord); $expectedFields = array( array( 'title' => 'Level', 'value' => $levelName, - 'short' => true, + 'short' => false, ), array( 'title' => 'tags', - 'value' => '["web"]', + 'value' => sprintf('```%s```', json_encode($extra['tags'])), 'short' => false ), array( 'title' => 'test', - 'value' => 1, + 'value' => $context['test'], 'short' => false ) ); @@ -338,4 +341,47 @@ class SlackRecordTest extends TestCase $attachment['fields'] ); } + + public function testAddsTimestampToAttachment() + { + $record = $this->getRecord(); + $slackRecord = new SlackRecord(); + $data = $slackRecord->getSlackData($this->getRecord()); + + $attachment = $data['attachments'][0]; + $this->assertArrayHasKey('ts', $attachment); + $this->assertSame($record['datetime']->getTimestamp(), $attachment['ts']); + } + + public function testExcludeExtraAndContextFields() + { + $record = $this->getRecord( + Logger::WARNING, + 'test', + array('info' => array('library' => 'monolog', 'author' => 'Jordi')) + ); + $record['extra'] = array('tags' => array('web', 'cli')); + + $slackRecord = new SlackRecord(null, null, true, null, false, true, array('context.info.library', 'extra.tags.1')); + $data = $slackRecord->getSlackData($record); + $attachment = $data['attachments'][0]; + + $expected = array( + array( + 'title' => 'info', + 'value' => sprintf('```%s```', json_encode(array('author' => 'Jordi'), $this->jsonPrettyPrintFlag)), + 'short' => false + ), + array( + 'title' => 'tags', + 'value' => sprintf('```%s```', json_encode(array('web'))), + 'short' => false + ), + ); + + foreach ($expected as $field) { + $this->assertNotFalse(array_search($field, $attachment['fields'])); + break; + } + } } diff --git a/tests/Monolog/Handler/SlackWebhookHandlerTest.php b/tests/Monolog/Handler/SlackWebhookHandlerTest.php index cc9b7ba..c9229e2 100644 --- a/tests/Monolog/Handler/SlackWebhookHandlerTest.php +++ b/tests/Monolog/Handler/SlackWebhookHandlerTest.php @@ -32,11 +32,10 @@ class SlackWebhookHandlerTest extends TestCase public function testConstructorMinimal() { $handler = new SlackWebhookHandler(self::WEBHOOK_URL); + $record = $this->getRecord(); $slackRecord = $handler->getSlackRecord(); $this->assertInstanceOf('Monolog\Handler\Slack\SlackRecord', $slackRecord); $this->assertEquals(array( - 'username' => 'Monolog', - 'text' => '', 'attachments' => array( array( 'fallback' => 'test', @@ -46,13 +45,15 @@ class SlackWebhookHandlerTest extends TestCase array( 'title' => 'Level', 'value' => 'WARNING', - 'short' => true, + 'short' => false, ), ), 'title' => 'Message', + 'mrkdwn_in' => array('fields'), + 'ts' => $record['datetime']->getTimestamp(), ), ), - ), $slackRecord->getSlackData($this->getRecord())); + ), $slackRecord->getSlackData($record)); } /** |