Skip to content

Latest commit

 

History

History
54 lines (40 loc) · 2.93 KB

README.md

File metadata and controls

54 lines (40 loc) · 2.93 KB

Adoscope

🔭 An elegant debug assistant for AdonisJS Framework.



🚧 Warning: WORK-IN-PROGRESS

This package is under development and not ready to use. I'm currently working with the core team to bring this project to life ( See current 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.

Introduction

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.

Prequisites

  • 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.

Installation

// TODO

Configuration

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

Data Pruning

Without pruning, the adoscope_entries table can accumulate records very quickly. To mitigate this, you should schedule the adoscope: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 using adonis5-scheduler.

By default, all entries older than 24 hours will be pruned. You may use the hours 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

Authorization

// TODO

Available Watchers

// TODO

License

Adoscope is open-sourced software licensed under the MIT license.

Thanks

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