iluckhack / xhprof-buggregator-bundle
Xhprof buggregator integration for Symfony Framework
Installs: 2 327
Dependents: 0
Suggesters: 0
Security: 0
Stars: 5
Watchers: 1
Forks: 1
Open Issues: 0
Type:symfony-bundle
Requires
- php: ^8.1
- spiral-packages/profiler: ^1.0
- symfony/config: >=6.4
- symfony/console: >=6.4
- symfony/dependency-injection: >=6.4
- symfony/event-dispatcher: >=6.4
- symfony/http-kernel: >=6.4
Requires (Dev)
- symfony/dotenv: >=6.4
- symfony/framework-bundle: >=6.4
- symfony/test-pack: ^1.1
- symfony/yaml: >=6.4
README
Welcome to the Xhprof integration package for buggregator in Symfony Framework. This repository allows you to effortlessly enable Xhprof support for buggregator in your Symfony application.
Installation
To get started, install the package via composer:
composer require --dev iluckhack/xhprof-buggregator-bundle
Your bundle should be automatically enabled by Flex. But it useful for dev environment only, so you need to change it in config/bundles.php:
<?php // config/bundles.php return [ // ... Iluckhack\XhprofBuggregatorBundle\XhprofBuggregatorBundle::class => ['dev' => true], // ... ];
Usage
You can configure parameters via environment variables (if .env
file for example):
# ... # Your application name, it uses for providing to SpiralPackages\Profiler\Profiler XHPROF_BUGGREGATOR_APP_NAME="My awesome app" # Buggregator endpoint, it http://127.0.0.1:8000/api/profiler/store by default XHPROF_BUGGREGATOR_ENDPOINT=http://127.0.0.1:8123/api/profiler/store # If profiling enabled for CLI commands or HTTP requests respectively XHPROF_BUGGREGATOR_CLI_ENABLED=false XHPROF_BUGGREGATOR_HTTP_ENABLED=true # Custom header in your request to explicitly enable or disable profiling for that specific call # When this header is configured and present, it takes precedence over the "XHPROF_BUGGREGATOR_HTTP_ENABLED" variable XHPROF_BUGGREGATOR_HTTP_ENABLED_HEADER=X-Xhprof-Enabled # ...
When XHPROF_BUGGREGATOR_HTTP_ENABLED_HEADER
defined and header presents enabled values are true
/1
/on
/yes
, otherwise profiling will be disabled.
Values by default:
XHPROF_BUGGREGATOR_APP_NAME="Symfony Application" XHPROF_BUGGREGATOR_ENDPOINT=http://127.0.0.1:8000/api/profiler/store XHPROF_BUGGREGATOR_CLI_ENABLED=false XHPROF_BUGGREGATOR_HTTP_ENABLED=false XHPROF_BUGGREGATOR_HTTP_ENABLED_HEADER=
Testing
Run tests via composer:
composer tests
Or run it directly
./vendor/bin/simple-phpunit
License
The MIT License (MIT). Please see License File for more information.