kuborgh/logentries-bundle

Bundle to integrate logentries as monolog logger into symfony

v1.0.3 2016-06-20 08:55 UTC

Requires

• guzzlehttp/guzzle: ~5.2
• jms/serializer: ~1.0
• monolog/monolog: >=1.4
• symfony/framework-bundle: ~2.3

Requires (Dev)

• phpunit/phpunit: ~4.8
• symfony/property-access: ~2.3

MIT

• Hannes Giesenow

• logging
• symfony
• monolog
• logentries

README

[![Build Status][travis-image]][travis-url] [travis-url]: https://travis-ci.org/kuborgh/logentries-bundle [travis-image]: https://secure.travis-ci.org/kuborgh/logentries-bundle.svg?branch=master

This bundle integrates logentries.com into your symfony application. It is intended as a monolog handler, but can be used for other purposes, too.

Features

• Logging in JSON Format
• Easy integration vie monolog
• Transport abstraction to use HTTP/TCP/UDP as needed

Installation

Step 1: Download the Bundle

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

$ composer require kuborgh/logentries-bundle

Step 2: Enable the Bundle

Then, enable the bundle by adding it to the list of registered bundles in the app/AppKernel.php file of your project:

<?php
// app/AppKernel.php

// ...
class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = array(
            // ...

            new Kuborgh\LogentriesBundle\LogentriesBundle(),
        );

        // ...
    }

    // ...
}

Configuration

The full configuration can be shown with php app/console config:dump-reference kuborgh_logentries

Following sample configuration can be used inside the config.yml of your project

kuborgh_logentries:
    # Possibility to disable logentries in dev mode
    enabled: true

    # Create monolog compatible handlers
    monolog:
        # Name of the handler
        my_handler:
            # Transport for logging.
            transport: http_guzzle

            # Account Key of logentries.com account for http transport
            account_key: <logentries account key>
            
            # LogSet
            log_set: my_log_set
            
            # Log channel
            log: my_log
            
            # Loglevel (can not be configured in monolog config!)
            level: error
            
    # Create simple logger service
    logger:
        # Name of the service will be kuborgh_logentries.my_logger
        my_logger:
            # Transport for logging.
            transport: http_guzzle
            
            # Account Key of logentries.com account for http transport
            account_key: <logentries account key>
            
            # LogSet
            log_set: my_log_set
            
            # Log channel
            log: my_log

UDP Transport

UDP transport only needs a port

my_logger:
    transport: udp
   
    # UPD port assigned by logentries
    port: 12345
    
    # Alternative host, when using a proxy 
    host: host.proxy.lan

To enable monolog logging, add the defined handler(s) to the monolog section

monolog:
    custom:
        type: service
        id: kuborgh_logentries.handler.my_handler

Testing

You can run the unitttests with

$ composer install
$ bin/phpunit

The coverage report is saved in the coverage folder.