Download the PHP package velpl/buggregator-profiler-bundle without Composer
On this page you can find all versions of the php package velpl/buggregator-profiler-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download velpl/buggregator-profiler-bundle
More information about velpl/buggregator-profiler-bundle
Files in velpl/buggregator-profiler-bundle
Package buggregator-profiler-bundle
Short Description Symfony bundle integrating Buggregator profiler
License MIT
Informations about the package buggregator-profiler-bundle
A Buggregator profiler bundle for Symfony framework
A Symfony bundle that integrates Buggregator into your Symfony application, enabling you to send profiling data to a running Buggregator server instance. See Buggregator docs to learn more about Buggregator itself and how to make the most out of it.
Requirements
- PHP: 8.3, 8.4 or 8.5
- Symfony: 6.4 or 7.4 or 8.0+ (for Symfony 8 PHP 8.4+ is required)
Installation
⚠️ Please mind this is a work in progress and not yet a stable release – breaking changes are possible. Please provide feedback, suggestions and bug reports using GitHub issues. Pull requests are very welcome!
The recommended way to install this bundle is as a dev dependency, since profiling is typically only needed during development:
If you need profiling available in production environments as well, you can install it as a regular dependency:
Configuration
Using Symfony Flex (recommended)
This bundle ships with a Symfony Flex recipe available in the symfony/recipes-contrib repository.
When installing the bundle via Composer with Flex enabled, you will be prompted to run the contrib recipe automatically. Accepting it will:
- Register the bundle in
config/bundles.php - Create a default configuration file at
config/packages/buggregator_profiler.yaml - Add buggregator service to Docker
compose.yamlso you can run Buggregator server locally
If you choose not to run the recipe automatically, you can refer to the symfony/recipes-contrib repository for the recipe contents and apply the configuration manually (see the Manual Configuration section below).
Manual Configuration
If you are not using Flex or opted out of the recipe, register the bundle manually:
Then create the configuration file:
Set environment variables to configure the bundle (skips ones for which you want default values):
It's highly recommended to set BUGGREGATOR_BUNDLE_IMAGE_TAG to a specific version
of the Buggregator server image to avoid unexpected behavior.
You can find the available versions on
Buggregator server versions on GitHub.
And finally add the Buggregator service to your Docker compose.yaml:
Configuration Reference
| Option | Type | Default | Description |
|---|---|---|---|
enabled |
bool | false |
Whether profiling is active. Set to true to start sending data. |
application_name |
string | 'Symfony App' |
A label used to identify your application in Buggregator. |
profiler_url |
string | 'http://127.0.0.1:8000' |
The URL of your running Buggregator server instance. |
Note: The bundle is disabled by default. Set
enabled: true(or control it via an environment variable) to activate profiling.
License
MIT