rsg/log

Log utilities for RSG

v0.1.3 2021-04-16 12:39 UTC

Requires

• monolog/monolog: >=1.0.2

Requires (Dev)

• phpunit/phpunit: 7.*

proprietary

README

A collection of logging utilities that can be used by RSG.

Processors

StandardProcessor

This is the root processor. It does not decorate any other ProcessorInterfaces like the other ones in this library. It is used to add values that all records should contain.

Usage

Rsg\Log\StandardProcessor:
    tags: [ 'monolog.processor' ]
    arguments: [ '%env%', 'some-service' ]

WebProcessor

An adapter for Monolog's WebProcessor. It is used to add "extra" data for web requests. This also decorates any ProcessorInterface.

Usage

Rsg\Log\StandardProcessor:
    arguments: [ '%env%', 'some-service' ]

Rsg\Log\WebProcessor:
    tags: [ 'monolog.processor' ]
    arguments: [ '@Rsg\Log\StandardProcessor' ]

ContextProcessor

Copies important data from the context to the root of the record. This also decorates any ProcessorInterface. The purpose is to allow us to do something like $logger->info( 'some message', [ 'important_field' => 1 ] ); and be able to search "important_field=1" in our log aggregator.

Usage

Rsg\Log\StandardProcessor:
    arguments: [ '%env%', 'some-service' ]

Rsg\Log\ContextProcessor:
    tags: [ 'monolog.processor' ]
    arguments: [ '@Rsg\Log\StandardProcessor' ]

Additionally, one can customize the keys that will be copied.

Rsg\Log\StandardProcessor:
    arguments: [ '%env%', 'some-service' ]

Rsg\Log\ContextProcessor:
    tags: [ 'monolog.processor' ]
    arguments:
        $processor: '@Rsg\Log\StandardProcessor'
        $keys_to_escalate:
            - foo
            - bar
            - baz

Recommended Settings

The settings recommended for all RSG apps should include:

monolog:
    handlers:
        main:
            type: fingers_crossed
            action_level: error
            passthru_level: info
            handler: nested
            formatter: monolog.formatter

and

monolog.formatter:
    class: 'Monolog\Formatter\JsonFormatter'