aboutcoders/logger-bundle

A symfony bundle to log messages from external applications over a REST API

1.2.1 2018-08-12 11:37 UTC

Requires

• php: >=5.4.0
• nelmio/api-doc-bundle: ~3
• symfony/symfony: ~2.6|~3.0

Requires (Dev)

• friendsofsymfony/rest-bundle: ~1.0|~2.0
• phpunit/phpunit: ~4
• sensio/framework-extra-bundle: ~3
• symfony/monolog-bundle: ~2

MIT

• Hannes Schulz

• log
• rest
• client
• logger
• bundle

README

A symfony bundle that provides a REST-API to log messages from external client applications.

Build Status:

Installation

Follow the installation instructions of the required third party bundles:

• SensioFrameworkExtraBundle
• NelmioApiDocBundle
• FOSRestBundle

Add the AbcLoggerBundle to your composer.json file

{
    "require": {
        "aboutcoders/logger-bundle": "~1.0"
    }
}

Include the bundle in the AppKernel.php class

public function registerBundles()
{
    $bundles = array(
        // ...
        new Abc\Bundle\LoggerBundle\AbcLoggerBundle(),
    );

    return $bundles;
}

Import the routing files

abc-rest-logger:
    type: rest
    resource: "@AbcLoggerBundle/Resources/config/routing/rest.yml"
    prefix: /api

Configuration

All you need to do is define the names of the applications which are allowed to log and configure the Monolog logging channel to use for each of them. Please refer to the offical symfony documentation on how-to define custom channels or log to different files.

abc_logger:
    applications:
        my_application:
            channel: my_channel

Usage

With the above configuration example you can now post log entries to the following url: http://localhost/api/log/my_application

The request body must contain the following parameters:

• level: The log level [emergency|alert|critical|error|warning|notice|info|debug]
• message: The log message
• context: Optional, an array of context data as defined by Monolog

Please refer to the API documentation that can be generated with the NelmioApiDocBundle to get more detailed information about the API method.