README

The package contains symfony bundle to profile CLI applications with xhprof. It can be used for production profiling.

System requirements:

• PHP >= 8.2
• ext-xhprof
• xhgui (tested on xhgui/xhgui:0.22.1)

Installation (Composer):

composer require aeatech/cli-snapshot-profiler-xhprof-bundle

Auto installation

You can install it with custom recipe.

composer config extra.symfony.allow-contrib true
composer config --json --merge extra.symfony.endpoint '["https://api.github.com/repos/AEATech/recipes/contents/index.json?ref=main", "flex://defaults"]'
composer require aeatech/cli-snapshot-profiler-xhprof-bundle

Manual installation

Enable bundle in dev and prod env.

// config/bundles.php

return [
    // ...
    AEATech\CLISnapshotProfilerXhprofBundle\AEATechCLISnapshotProfilerXhprofBundle::class => ['dev' => true, 'prod' => true],
    // ...
];

Configuration

Symfony Flex generates a default configuration in config/packages/aea_tech_cli_snapshot_profiler_xhprof.yaml

aea_tech_cli_snapshot_profiler_xhprof:
    # Enable/Disable profiling
    is_profiling_enabled: false

    # Application info for snapshot naming
    app_version: '0.0.1'

    # XHGUI configuration
    xhgui:
        import_uri: '%env(string:AEA_TECH_CLI_SNAPSHOT_PROFILER_XHPROF_XHGUI)%'
        import_timeout: 1

    ###
    # xhprof configuration
    # - collect internal functions info
    # - collect memory allocation info
    ###
    xhprof:
        collect_additional_info: '1'
        flags:
            - !php/const Xhgui\Profiler\ProfilingFlags::MEMORY

    ###
    # Event matched configuration - START
    ###
    event_matcher:
        # Enable/Disable all commands profiling
        is_profile_all_commands: false

        # Enable profile by command name (\AEATech\CLISnapshotProfilerEventSubscriber\EventMatcher\CommandEventMatcher)
        command:
            is_enabled: false
            name_list:
                - 'app:command'
    ###
    # Event matched configuration - END
    ###

License

MIT License. See LICENSE for details.