hphio/logging-configurator

There is no license information available for the latest version (v1.0.5) of this package.

Loads and manages logging configuration files for an API service.

v1.0.5 2018-10-18 13:28 UTC

This package is auto-updated.

Last update: 2024-09-19 10:08:12 UTC


README

Loads and manages logging configuration files for an API service.

Scrutinizer Code Quality Code Coverage Build Status Code Intelligence Status

Installation

composer require hphio/logging-configurator

Requirements

This was developed on, and intended for PHP v7.0+. It may work on lower versions, but YMMV.

How to use this package

This package is designed to load and configure Monolog instances for use inside your classes. It will look for a file called config/logging.json, which should have the following structure:

{
  "services" : [
    {
      "name" : "auth",
      "enabled" : true,
      "path" : "/var/log/apache2/foo/",
      "filename" : "auth.log"
    },
    {
      "name" : "accounts",
      "enabled" : false,
      "path" : "/home/baruser/log/",
      "filename" : "accounts.log"
    }
  ]
}

Once you have configured a service that requires logging, this package will configure and instantiate a Monolog instance according to the settings you've setup. If you attempt to load a service that is not configured, it will simply return false.