bloatless/pile

Dead simple centralized logging.

v0.3.4 2024-03-05 07:33 UTC

Requires

• php: ^8.0
• ext-json: *
• ext-mbstring: *
• bloatless/endocore: v0.5.0.x-dev

MIT

• Simon Samtleben

• logging
• php
• centralized

README

Pile

Dead simple centralized logging.

Installation

To install Pile just clone this repository to your server:

git clone https://github.com/bloatless/pile.git

• Point your virtual host document root to the public directory and rewrite ald requests to the index.php file.
• Create a new MySQL database and import the structure using the db_stucture.sql file.
• Copy config/config.sample.php to config/config.php and adjust database configuration, api-keys and user-account settings.

Documentation

Log message structure

The general structure of a log message to be send to the Pile API should be as follows:

¹ = field is required

Log levels

Valid log level codes are:

Sending logs to your Pile instance

Using HTTP REST API

Log messages can be sent to your Pile instance using a simple post request:

POST https://pile.yourdomain.com/api/v1/log
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
X-API-Key: 123123123

{
    "data": {
        "type": "log",
        "attributes": {
            "source": "MyProjectName",
            "message": "Some error occoured",
            "context": {
                "exception": {
                    "class": "My\\Fancy\\Classname",
                    "message": "Invalid value",
                    "code": "42",
                    "file": "\/framework\/src\/Foo\/Bar\/Classname.php:1337"
                }
            },
            "level": 400,
            "level_name": "ERROR",
            "channel": "dev",
            "datetime": "2019-11-05 17:44:26",
            "extra": []
        }
    }
} 

Be sure to include an API key within the request header.

Using Monolog Handler

If you are using Monolog in your project you can also use the MonoPile package which provides a handler and formatter for Monolog to easily send error-logs to your Pile instance.

Cleanup

Old log entries can be regularly deleted using the cleanup script:

php cli/cleanup.php

This will delete old log entries from the database. The "lifetime" of log entries can be configured within the config/config.php file.

It is recommended to regularly call the cleanup script using a cronjob.

License

MIT