EonX Packages

# Client configurators

The client factory allows you to set a collection of client configurators. Once the client has been instantiated, the client factory will loop through the configurators, providing them the client instance to be configured.

A configurator is a PHP class implementing EonX\EasyBugsnag\Interfaces\ClientConfiguratorInterface. When used within your favourite PHP framework, the configurators will be set on the factory for you so that any Bugsnag client will be configured before being injected into your services. Each configurator must define a priority (an integer value) which will be used to define the order of execution of the entire configurator collection.

TIP

To simplify the process of creating configurators, you can extend EonX\EasyBugsnag\Configurators\AbstractClientConfigurator, which uses a default priority of 0.

For example, the following configurator sets the release stage attribute of the application data for Bugsnag:

// src/Bugsnag/ReleaseStageConfigurator.php

namespace App\Bugsnag;

use Bugsnag\Client;
use EonX\EasyBugsnag\Configurators\AbstractClientConfigurator;

final class ReleaseStageConfigurator extends AbstractClientConfigurator
{
    public function configure(Client $bugsnag): void
    {
        $bugsnag->setReleaseStage('dev');
    }
}

# Default configurators

The package comes with a set of configurators that are enabled by default. You can disable the default configurators by setting the use_default_configurators configuration option to false. See Configuration.

The default configurators are:

  • BasicsConfigurator: Sets basic information in the Bugsnag client:
    • The project root
    • The release stage
    • The strip path
  • RuntimeVersionConfigurator: Sets the runtime and version in the runtime versions of the device data for Bugsnag:
    • For Symfony applications, sets the runtime to the value of the runtime configuration option (symfony by default) and sets the version to the value of the runtime_version configuration option (the Symfony runtime version).
    • For Laravel/Lumen applications, sets the runtime to either lumen or laravel as applicable and sets the version to the application version.
  • AwsEcsFargateConfigurator: If the aws_ecs_fargate.enabled configuration option is set to true, then the AwsEcsFargateConfigurator automatically resolves information about the AWS ECS Fargate task (AvailabilityZone, Cluster, TaskARN and TaskDefinition) and adds it as metadata to Bugsnag reports.

# Registering additional configurators

# Symfony

To register additional client configurators in Symfony, you simply register a new service implementing the EonX\EasyBugsnag\Interfaces\ClientConfiguratorInterface. The EasyBugsnag package registers the interface for auto-configuration by default, so you have nothing else to worry about.

# Laravel/Lumen

To register additional client configurators in Laravel/Lumen, you must explicitly tag them within the service container.

# Example

The following example configurator adds the Laravel version to the runtime versions attribute of the device data for Bugsnag.

Create a class extending EonX\EasyBugsnag\Configurators\AbstractClientConfigurator and add your version logic:

// app/Bugsnag/RuntimeVersionConfigurator.php

namespace App\Bugsnag;

use Bugsnag\Client;
use EonX\EasyBugsnag\Configurators\AbstractClientConfigurator;
use Illuminate\Contracts\Foundation\Application;

final class RuntimeVersionConfigurator extends AbstractClientConfigurator
{
    /**
     * @var \Illuminate\Contracts\Foundation\Application
     */
    private $app;

    public function __construct(Application $app, ?int $priority = null)
    {
        $this->app = $app;

        parent::__construct($priority);
    }

    public function configure(Client $client): void
    {
        $client->getConfig()->mergeDeviceData([
            'runtimeVersions' => ['laravel' => $this->app->version()],
        ]);
    }
}

Register your client configurator as a service and tag it using the EonX\EasyBugsnag\Bridge\BridgeConstantsInterface constant TAG_CLIENT_CONFIGURATOR provided for this purpose. This should be done in a service provider. For example:

// app/Providers/BugsnagServiceProvider.php

use App\Bugsnag\RuntimeVersionConfigurator;
use EonX\EasyBugsnag\Bridge\BridgeConstantsInterface;
use Illuminate\Contracts\Container\Container;
use Illuminate\Support\ServiceProvider;

final class BugsnagServiceProvider extends ServiceProvider
{
    public function register(): void
    {
        // Register your configurator as a service
        $this->app->singleton(RuntimeVersionConfigurator::class, static function (Container $app): RuntimeVersionConfigurator {
            return new RuntimeVersionConfigurator($app);
        });

        // Tag it as a client configurator
        $this->app->tag(RuntimeVersionConfigurator::class, [BridgeConstantsInterface::TAG_CLIENT_CONFIGURATOR]);
    }
}

Every Bugsnag client created by the client factory will now have the laravel runtime version within its device data.

← Session tracking →