-
Notifications
You must be signed in to change notification settings - Fork 0
Home
This is a work in progress, this document will be updated as we make our way to v1.0
LogCentral is an app to keep all your logs organized in one place. LogCentral was developed so you don't have to look at those ugly log files anymore, so with it's fresh UI you can see the bigger picture fast and find a particular transaction easily.
The installation process in very simple you just git clone this repo into your desire folder, then you should do these 5 steps:
- composer install
- configure your .env variables
-
php artisan migrate
(this will create all necessary tables) -
php artisan db:seed
(this will seed your database with a default admin user. email = test@test.com password = admin)
After this your application should be ready to use. This have been tested on a 512 Mb ram droplet in DigitalOcean with no issue at all.
If you like to use the Google nocaptcha functionality and another settings you need to configure the .env file you should copy de .env.example to a file named .env and start from there.
**Please make sure you run php artisan key:generate
to generate a new secret key to your application **
To make the google captcha you need to update this variables:
NOCAPTCHA_SECRET=secret
NOCAPTCHA_SITEKEY=sitekey
If you decide to use LogCentral the first step is to create a Project. Projects are the base of what we will create in the future (Streams and then Logs). The Project entity it self serve as a group in which you could have multiple streams. In order to create a new Project you can go to Project, click on the create button, fill the form and then save.
Let say that you already have a Project created, let's call it the Acme Project now you should create some Streams, Streams are meant to be so your logs don't mix up between process. As an example let's say in your Acme Project you have a website and some API that you use to sell products, imagine that you have all your logs into one place it will be boring separate between actions made by your website and actions made using your API so in this case we will create two streams. One for Web and another one for your API.
To create a new Stream, you can go to the Streams menu, then click on the button to create a new project, fill the form and save. Once you have created a new stream and click on it's name a new form appears given you a new api token, this token is what we will to send logs to LogCentral.
So we are finally ready to send some logs, all you need to do is follow the guide to send LogCentral API requests, then using your previously generated api token you will be able to save all the transactions made in the Acme Web or Acme API without mixes and without problem.
Let's say that in the Acme web some user change a value that make a change in the database, it will be awesome to keep a record of those changes to right? Well LogCentral can make that happen and will create a Diff that can be related to a Log so you now what action trigger that changes and what fields were changed. This is possible via LogCentral API
This is often related with folder permission to the storage folder, a quick solution is to change it's permissions to 777