Download the PHP package sfertrack/rollbar-symfony-bundle without Composer

Introduction

Rollbar is one of the best bug tracking systems that supported a lot of programming languages, including PHP.

You can find their official php library here and symfony bundle that allow easily integrate rollbar to your application. Unfortunately, they announced that the bundle will not be actively developed and will be archived in January 2025:

As of May 2024, Rollbar will not be actively updating this repository and plans to archive it in January of 2025. We encourage our community to fork this repo if you wish to continue its development. While Rollbar will no longer be engaging in active development, we remain committed to reviewing and merging pull requests related to security updates. If an actively maintained fork emerges, please reach out to our support team and we will link to it from our documentation.

So, looks like it's time to create new rollbar symfony bundle that will support actual PHP and symfony versions.

Set up instructions

1. To set up the bundle you need to sign up rollbar account

2. Add the bundle with composer:

3. Create rollbar_symfony.yaml configuration file (if you use application structure recommended by symfony, then it should be placed to config/packages folder)
4. Configure your Rollbar setup in config/packages/rollbar_symfony.yaml or in any of the environment subdirectories:

That's it! Rollbar is integrated to your application.

For complete configuration reference take a look official documentation

Additional configuration

This bundle provides you with several services and patterns that simplify developer life like:

• PersonProvider
• CheckIgnoreVoter
• ExceptionExtraDataProvider
• Scrubber
• RollbarReporter
• IgnoreExceptionInterface
• AbstractExtraDataException
• UserFriendlyExceptionInterface
• Scrubbing environment variables

PersonProvider service

The service automatically collects information about authenticated users if your application uses symfony/security-bundle. No extra configuration is needed.

If you use impersonation feature, the service will also collect information about the impersonator.

To collect user information, the service uses Symfony serializer. You can easily define which fields you want to report to Rollbar by configuring user entity serialization groups.

If you want to implement your own service to collect user information, simply implement PersonProviderInterface

You can define several person provider services if your application has a complex authentication flow. All services that implement PersonProviderInterface are called in turn, until one of them returns user data.

PersonProvider that comes with this bundle has a priority of -1 and is called last, in case previous services couldn't provide user data.

Exceptions thrown by person provider services don't stop the call queue. So, don't worry if your person provider service throws an exception - the original exception will still be delivered to Rollbar.

(!) Note: If a person provider service returns an array without an id key, Rollbar won't report user data at all

CheckIgnoreVoter

Sometimes we don't need to see noisy exceptions when a route is not found, a method is not allowed, access is denied, or similar issues occur. For these cases, Rollbar has a check_ignore option.

You can define your own service to ignore exceptions with custom rules. To do this, simply implement CheckIgnoreVoterInterface.

The bundle allows you to create several voters, as the logic to ignore exceptions can be quite complex. All voters that implement the interface will be called one by one until one of them votes to ignore the occurred exception. If this doesn't happen, the exception will be reported to Rollbar.

For you convenience the bundle includes an example: CheckIgnoreVoter. If you want to use it, you can simply define the class as a service in your configuration files.

ExceptionExtraDataProvider

The bundle provides an interface for exceptions that allows easy passing of additional context to reported exceptions. Typically, developers include this context in exception messages, but this approach becomes inconvenient, especially when the context contains responses from other services.

To address this issue, the bundle includes ExceptionExtraDataInterface. This interface defines only one method: getExtraData. When a thrown exception implements ExceptionExtraDataInterface, getExtraData method is called to retrieve the additional data previously passed by the developer. It's assumed that this data is passed through the constructor when the exception is created.

Scrubber

By default, Rollbar provides a scrubber that allows you to scrub specific values by key. Take a look on scrub_fields option

Sometimes, you need to scrub cookie values, such as user sessions, but still want to see other cookies in the occurrence details.

To resolve this problem, the bundle includes CookieScrubber

This scrubber is enabled by default. List of keys to be scrubbed can be configured using the scrub_cookie_fields option

You can also add your own scrubber, here are two ways to do it:

• create a service that implements ScrubberInterface defined by this bundle or
• create a service that implements ScrubberInterface from rollbar package and add tag rollbar.scrubber to the service

RollbarReporter

You might occasionally need to catch an exception, handle it, and log it to Rollbar, especially to track down tricky issues.

RollbarReporter can assist you with this.

IgnoreExceptionInterface

IgnoreExceptionInterface is designed to ignore exceptions. The interface is used by CheckIgnoreVoter. Therefore, if you do not want to report some of your exceptions, they just need to implement this interface.

AbstractExtraDataException

UserFriendlyExceptionInterface

Sometimes, exception messages may contain technical information; displaying these messages to users is not good practice.

UserFriendlyExceptionInterface is designed to distinguish exceptions whose messages are user-friendly and can be displayed to the user. Typically, these types of exceptions do not require a fix from developers; instead, users should perform certain actions themselves.

Imagine your developed application depends on an external service. Occasionally, this service might be broken and return a 5xx error. In such a case, you can throw your own exception that implements UserFriendlyExceptionInterface. You can rely on this interface and simply display the exception message to the user.

For example:

Scrubbing environment variables

Scrubbing production application secrets is a good practice. By default, the Rollbar package dumps local environment variables, as the local_vars_dump option is enabled by default. The Symfony HTTP request object has a server field that contains environment variables. These environment variables may contain secret keys, such as a database DSN. You will likely want to keep these values hidden, especially from junior developers.

Here are two possible ways to keep environment variables hidden:

• Add all environment variable names to the scrub_fields option of the Rollbar configuration. In this case, Rollbar will scrub the values of the listed environment variables. However, you should keep in mind, that every time a new sensitive environment variable is added, it must also be added to the scrub_fields list.
• Rely on the scrub_env_variables option, provided by the bundle (this option is enabled by default). When this option is enabled, all environment variables will be scrubbed. If you do not want to scrub a specific variable, you can add its name to the scrub_safelist configuration option. You might also notice that some secrets can be passed to a service as method arguments, these values will also be dumped, and the secret value will be disclosed. The bundle takes care of this as well and scrubs such values.