README

Installation

To install via Composer, use the command below, it will automatically detect the latest version and bind it with ^.

composer require wyrihaximus/react-psr-3-loggly

Loggers

This package comes with two loggers:

LogglyLogger - Basic logger that will send every log call directly to Loggly.
LogglyBulkLogger - Buffering logger that will log either what max buffer size is reached or when timeout is reached.

Usage

Creating the LoggerlyLogger can be done in two ways. Either create it with an event loop, this will create a HTTP Client internally:

$token = 'abc';
$loop = createEventLoop();
$logger = LogglyLogger::create($loop, $token);

Or create LoggerlyLogger with an already create HTTP Client.

$token = 'abc';
$httpClient = createHttpClient();
$logger = LogglyLogger::createFromHttpClient($httpClient, $token);

For the LogglyBulkLogger a third parameter can be added. The timeout parameter, represented as float, used as maximum time to wait before sending all logs in the buffer to Loggly. Another difference with the bulk logger is that createFromHttpClient also requires the event loop due to the usage of timers:

$token = 'abc';
$loop = createEventLoop();
$httpClient = createHttpClient();
$logger = LogglyBulkLogger::createFromHttpClient($loop, $httpClient, $token, 12.3);

At this point both loggers can be used as any other 'PSR-3' logger.

Contributing

Please see CONTRIBUTING for details.

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

wyrihaximus / react-psr-3-loggly

Maintainers

Details