outsourced/log

Outsourced backed

0.3.3 2020-12-03 19:46 UTC

Requires

• php: ^7.2
• fideloper/proxy: ^4.0
• firebase/php-jwt: ^5.2
• imliam/laravel-env-set-command: ^1.0
• laravel/framework: ^6.2
• laravel/tinker: ^2.0
• psr/log: ^1.1
• sentry/sdk: ^2.1

Requires (Dev)

• facade/ignition: ^1.4
• fzaninotto/faker: ^1.9.1
• mockery/mockery: ^1.0
• nunomaduro/collision: ^3.0
• phpunit/phpunit: ^8.0

MIT

• log
• logging
• proxy
• roles
• permissions
• outsource

README

Standalone server service for managing your applications's:

• logs
• user permissions

Demo

Outsourced web client

Create new connection to demo server:

• Name: demo
• Host: https://log-demo-api.ovaldo.sk
• Username: root
• Password: root

Installation

Demo Installation

Demo installlation is good just for trying thinks out. You will not be able to update application in the future easily.

First step is to install source code

composer create-project --prefer-dist --no-dev outsourced/log

this command will create a folder named log. This guide will assume, you have not changed this folder name

Switch to newly creted directory cd log and start app setup.

php artisan setup
php artisan setup:database
php artisan migrate

These command will guide you trough app setup, database setup and will create all database tables.

sudo chown -R www-data:www-data storage

This commad will grant access permission for storage folder. Application logs are stored there.

Then you have to configure your virtual host.

If you are runnig this application localy, then you will have to add <your_domain> to hosts file.

Now you should be able to access one API endpoint. Open your web browser and input <subdomain>.<your_domain>/api/v1/projects. You should receive json response with empty array.

Installation

Production installation is slightlly different, because you have to think about future updates. That requires a special directory structure. We have prepared a list of commands that will create this directory structure for you. The idea is to have a releases directory, that contains every update. You can switch what version is currenctly in use. To switch between version you will use direcotry link current that will point tu currently used version. Then there is a storage direcotry, that stores your application data an logs. So every version in releases directory will use the same storage. environment directory has configuration for this instance of application. public directory contains index.php and .htaccess files. This is also a directory that your virtual host should refer to. And last directory is console and there you can find script that can help you set up some enviroment values or clear cache or migrate database ...

Then you should go to console directory and run initial setup.

cd console
php artisan key:generate --ansi
php artisan init:file
php artisan setup
php artisan setup:database
php artisan migrate
cd ../

Application will need access to one directory, so you will have to run sudo chown -R www-data:www-data storage

Then you have to configure your virtual host. And add ertificate. For testing purpose, we created tutorial how to setup certificate with certbot

If you are runnig this application localy, then you will have to add <your_domain> to hosts file.

Now you should be able to access one API endpoint. Open your web browser and input <subdomain>.<your_domain>/api/v1/projects. You should receive json response with empty array.

Update to new version

cd console
php artisan release:upgrade
cd ../

Rollback to previous version

cd console
php artisan release:rollback
cd ../

API

Logging

Single

[POST] /logs/{accessKey}

Body

{
    "level": "debug" | "info" | "notice" | "warning" | "error" | "critical" | "alert" | "emergency",
    "message": "string",
    "context": {}
}

Batch

[POST] /logs/{accessKey}/batch

Body

[
    {
        "level": "debug" | "info" | "notice" | "warning" | "error" | "critical" | "alert" | "emergency",
        "message": "string",
        "context": {}
    },
    ...
]

Permissions

Verify

[GET] /permissions/{accessKey}

Query

user=string
permissions[]=string

Response

string[]

SDK

• PHP

Contribution