innmind/silent-cartographer

Library to visualize processes manipulating the operating system

2.2.0 2021-02-14 15:45 UTC

Requires

• php: ~7.4|~8.0
• innmind/cli: ~2.0
• innmind/immutable: ~3.5
• innmind/ipc: ~3.0
• innmind/json: ^1.1
• innmind/operating-system: ~2.0
• innmind/url: ~3.3

Requires (Dev)

• innmind/black-box: ^4.9
• innmind/coding-standard: ^1.1
• innmind/object-graph: ~2.0
• phpunit/phpunit: ~9.0
• vimeo/psalm: ~4.4

MIT

• Baptiste Langlade

README

Simple tool to visualize all the operations done on the operating system inside other php applications.

Installation

For the command line tool:

composer global require innmind/silent-cartographer

In the project you want to see operations:

composer require innmind/silent-cartographer

Usage

To watch all activities:

silent-cartographer panel

In your project in order to send activities:

use Innmind\CLI\{
    Main,
    Environment,
};
use Innmind\OperatingSystem\OperatingSystem;
use Innmind\Url\Path;
use function Innmind\SilentCartographer\bootstrap;

new class extends Main {
    protected function main(Environment $env, OperatingSystem $os): void
    {
        $os = bootstrap($os)['cli'](Path::of(__DIR__));
        // then use the $os variable like you would normally do
    }
}

In an HTTP server context use the http_server context (instead of cli), the difference is that if no panel is activated at the reception of a request it will never try to send any activity to the panel for the rest of the request handling (this is done to reduce performance impact).