Repository files navigation

Adoscope

🔭 An elegant debug assistant for AdonisJS Framework.

This package isunder development and not ready to use. I'm currently working with the core team to bring this project to life ( Seecurrent RFC ) . Most of the work has been done on Adoscope, the front-end of the application is ready, models too, we only need to develop the watchers that will retrieve the real events from Adonis.

Currently only fake data are seeded, and the application is currently not a package. It is a complete Adonis application but the whole thing will be exported in a package once the watchers are implemented.

Adoscope is basically a Laravel Telescope clone. Adoscope provides insight into the requests coming into your application, exceptions, log entries, database queries, mails, notifications, redis operations, and more. Adoscope makes a wonderful companion to your Adonis development environment.

• You must have a database to store Adoscope entries. (Adonis Sail allows you to create your database in 2 minutes! )
• Therefore, you must have@adonisjs/lucid installed and configured.

// TODO

After installing Adoscope, you will find the main configuration file inapp/adoscope.ts. Each of the configuration options has a description of its purpose.

Without pruning, theadoscope_entries table can accumulate records very quickly. To mitigate this, you should schedule theadoscope:prune Ace command to run daily. Since AdonisJS does not (yet?) have a built-in Scheduler, you can do this by using a simple cronjob, or usingadonis5-scheduler.

By default, all entries older than 24 hours will be pruned. You may use thehours option when calling the command to determine how long to retain Adoscope data. For example, the following command will delete all records created over 48 hours ago:

node ace adoscope:prune --hours=48

// TODO

// TODO

Adoscope is open-sourced software licensed under theMIT license.

Thanks to Laravel team and its awesome Ecosystem ! In case it wasn't obvious,Laravel Telescope was a BIG inspiration for Adoscope.