msschl/monolog-seq-handler

msschl/monolog-seq-handler sends log records to a Seq-Server.

0.1.1 2019-04-04 16:00 UTC

This package is auto-updated.

Last update: 2024-04-12 22:01:14 UTC


README

Build Status Scrutinizer Code Quality Code Intelligence Status Coverage Status

Monolog Seq Handler

This package provides a SeqHandler for the Monolog library. Seq is a log server that runs on a central machine. Your applications send structured events through a package like monolog-seq-handler.

Prerequisites

  • PHP 7.0 or above.
  • Since this package adds a HttpHandler to the Monolog library, you should first install Monolog.

Installation

Install the latest version with

$ composer require msschl/monolog-seq-handler

After the installation

...you need to decide on which HTTP client/adapter you want to use.

HTTP Clients

In order to send HTTP requests, you need a HTTP adapter. This package relies on HTTPlug which is build on top of PSR-7 and defines how HTTP message should be sent and received. You can use any library to send HTTP messages that implements php-http/client-implementation.

Here is a list of all officially supported clients and adapters by HTTPlug: http://docs.php-http.org/en/latest/clients.html

Read more about HTTPlug in their docs.

Basic Usage

<?php

use Monolog\Logger;
use Msschl\Monolog\Handler\SeqHandler;

// create a log channel
$log = new Logger('channel-name');

// push the SeqHandler to the monolog logger.
$log->pushHandler(new SeqHandler('https://seq-server/'));

// add records to the log
$log->warning('Foo');
$log->error('Bar');

To authenticate or tag messages from the logger, set a Api-Key:

$log->pushHandler(new SeqHandler('https://seq-server/', 'API-KEY'));

About

Submitting bugs and feature requests

Bugs and feature request are tracked on GitHub

Contributing

First of all, thank you for contributing! In order to make code reviews easier please follow some simple rules listed in the CONTRIBUTING.md file.

License

This project is licensed under the terms of the MIT license. See the LICENSE file for license rights and limitations.