carpediem/mattermost-monolog

Mattermost monolog integration

1.1.0 2018-01-19 09:41 UTC

Requires

• php: >=5.6.0
• carpediem/mattermost-webhook: ^1.2.0 || ^2.2.0
• monolog/monolog: ^1.23

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.0
• phpunit/phpunit: ^5.7 || ^6.2

MIT

• Carpediem Developper

• php
• monolog
• PHP7
• Mattermost
• monolog-handler
• monolog-formatter

README

This package allows sending log to Mattermost webhook using a dedicated Handler and Formatter.

This package requires carpediem/mattermost-webhook

System Requirements

You need PHP >= 5.6.0 but the latest stable version of PHP is recommended.

Installation

$ composer require carpediem/mattermost-monolog

Documentation

Basic usage

The code above will register a Mattermost handler to your Monolog\Logger object.

<?php

require __DIR__ . 'vendor/autoload.php';

use Carpediem\Mattermost;
use GuzzleHttp\Client as GuzzleClient;
use Monolog\Logger;

$template = (new Mattermost\Webhook\Message('This text will be overriden by the logger'))
    ->setChannel('alerts')
    ->setUsername('AlertBot')
    ->setIconUrl('https://cdn2.iconfinder.com/data/icons/security-2-1/512/bug-512.png')
;

$monolog_handler = new Mattermost\Monolog\Handler(
    'https://your_mattermost_webhook_url',
    new Mattermost\Webhook\Client(new GuzzleClient(['http_errors' => false]))
    Logger::WARNING
);
$monolog_handler->setFormatter(new Mattermost\Monolog\Formatter($template));

$logger = new Logger('MyAwesomeLogger');
$logger->pushHandler($monolog_handler);

Advanced usage

If you don't like our formatter don't worry you can create your own formatter as long as

• Formatter::format returns a Carpediem\Mattermost\Webhook\MessageInterface object
• Formatter::formatBatch returns a Carpediem\Mattermost\Webhook\MessageInterface object

you'll be able to use the Carpediem\Mattermost\Monolog\Handler

Contributing

Contributions are welcome and will be fully credited. Please see CONTRIBUTINGfor details.

Testing

Mattermost Monolog has a PHPUnit test suite and a coding style compliance test suite using PHP CS Fixer. To run the tests, run the following command from the project folder.

$ composer test

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• carpediem
• All Contributors

License

The MIT License (MIT). Please see License File for more information.