Documentation
- Installation - Install, enable and connect your MCP client
- For AI agents - The MCP tools and how an agent uses them
- Artisan commands - The same data from the terminal
- Dashboard - The same data in your browser
- Tracing - How a page, its calls, jobs and processes are linked
- Browser tracing - Linking a page's fetch and XHR calls, and the Monocle button on the page
- What gets recorded - Every lens and what it records
- Spans and metadata - Measure your own code
- Writing a lens - Record something Monocle does not know about
- Third-party lenses - Lenses for other packages, maintained by others
- Configuration - Every option in
config/monocle.php - Storage - Where captures are kept
Where things are
| Looking for | Page |
|---|---|
| Turning Monocle on or off | Installation |
monocle:install | Installation |
monocle-list, monocle-show, monocle-rows, ... | For AI agents |
X-Monocle-Id, X-Monocle-Label | For AI agents |
Monocle::span(), measure(), mark(), meta(), label() | Spans and metadata |
| Stopping a span somewhere else | Spans and metadata |
| Turning lenses on, off or adding your own | Configuration |
| Masking secrets | Configuration |
Recording Storage disks | Filesystem |
| Request phases | Request |
| Linking pages, jobs and processes into a trace | Tracing |
| Jumping from a page to its captures | Browser tracing |
| N+1 and slow query warnings | Database |
Contributing
- Contributing - Proposing a change and what a pull request needs
- Security - Reporting a vulnerability
- Code of Conduct