chameleon-m/phalcon-logger

Phalcon logger

Logger

, _(*1)

How to install

Using Composer (recommended)

Best way to install skeleton would be Composer, if you didn't install it, _(*2)

Run code in the terminal:, _(*3)

composer create-project Chameleon-m/phalcon-logger /path/to/install

Using Git

First you need to clone the project, update vendors:, _(*4)

git clone https://github.com/Chameleon-m/phalcon-logger.git ./project
cd project
composer update

DB

For PostgreSQL:, _(*5)

psql -h <host> -d <database> -U <user_name> -p <port> -a -w -f tests/_data/dump.sql, _(*6)

Or run migration (use phalcon devtools): phalcon migration run, _(*7)

Two methods are available:, _(*8)

POST /api/logs, _(*9)

POST /api/logs?queue=1 - push in queue (for save need run task php cli.php logs queue -v -t), _(*10)

The data in it is passed to json. For example:, _(*11)

POST curl -X POST -d '{"entity":"Event","entityId":1000,"date":"2017-12-12 12:12:12","userId":3,"action":"create","diff":{"before":"test1","after":"test2"}}' http://phalcon-logger.dev/api/logs, _(*12)

{
    "entity": "Event",
    "entityId": 1000,
    "date": "2017-12-12 12:12:12",
    "userId": 3,
    "action": "create",
    "diff": {
        "before": "test1",
        "after": "test2"
    }
}

The date is passed in the Postgresql timestamp format., _(*13)

GET /api/logs, _(*14)

Possible filters for the query:, _(*15)

• from - paired filter from to. Indicates the date on which the filtering starts.
• to - paired filter with from. Indicates the date the filtering ends.
• entity - the name of the entity.
• entityId - array with entity id.
• action - the name of the action.
• userId - array with user id.

The response is as follows:, _(*16)

GET curl -X GET http://phalcon-logger.dev/api/logs?page=3, _(*17)

{
    "items": [
        {
            "id": 1,
            "entity": "Event",
            "entityId": 1000,
            "date": "2017-12-12 12:12:12",
            "userId": 3,
            "action": "create",
            "diff": {
                "before": "test1",
                "after": "test2"
            }
        },
        {...},
        {...},
    ],
    "first": 1,
    "before": 2,
    "current": 3,
    "last": 8,
    "next": 4,
    "total_pages": 8,
    "total_items": 72,
    "limit": 10
}

Attribute - Description, _(*18)

items - The set of records to be displayed at the current page\ current - The current page\ before - The previous page to the current one\ next - The next page to the current one\ last - The last page in the set of records\ total_pages - The number of pages\ total_items - The number of items in the source data\, _(*19)

Testing

First you need to re-generate base classes for test all suites:, _(*20)

vendor/bin/codecept build, _(*21)

Once the database is created and base clases re-generated, run the tests on a terminal:, _(*22)

vendor/bin/codecept run, _(*23)

or for detailed output:, _(*24)

vendor/bin/codecept run --debug, _(*25)

Requirements

• PHP 7.0 and up
• Phalcon 3.2.0
• Composer

License

This project is open-sourced software licensed under the MIT License., _(*26)

See the LICENSE file for more information., _(*27)