networkteam/netwokteam.neos.sentryclient

Sentry client for neos cms

Networkteam.Neos.SentryClient

This is a Sentry client package for the Neos CMS (https://www.neos.io).

It's based on https://github.com/getsentry/sentry-php.

Have a look at https://sentry.io for more information about Sentry.

Installation:

$ composer require networkteam/neos-sentryclient

Configuration:

Add the following to your Settings.yaml and replace the dsn setting with your project DSN (API Keys in your Sentry project):

Networkteam:
  SentryClient:
    # The Sentry DSN
    dsn: 'http://public_key:[email protected]/project-id'

You can implement the \Networkteam\SentryClient\User\UserContextServiceInterface to pass your own user context information to the logging. If you do not have the TYPO3.Party Package and don't want to implement your own UserContextService you need to set the \Networkteam\SentryClient\User\DummyUserContext in the Objects.yaml like

Networkteam\SentryClient\User\UserContextServiceInterface:
  className: Networkteam\SentryClient\User\DummyUserContext

This will prevent any collection of user information except information that is available via the Flow SecurityContext.

Usage:

Sentry will log all exceptions that have the rendering option logException enabled. This can be enabled or disabled by status code or exception class according to the Flow configuration.

Development:

This package is managed on GitHub. Feel free to get in touch at https://github.com/networkteam/Networkteam.Neos.SentryClient.

License:

See the LICENSE file for license rights and limitations (MIT).

netwokteam.neos.sentryclient's Issues

Incompatible to neos/flow >= 7.3.6

In version 7.3.6 of neos/flow the AbstractExceptionHandler::echoExceptionCli signature changed from

protected function echoExceptionCli(\Throwable $exception) to
protected function echoExceptionCli(\Throwable $exception, bool $exceptionWasLogged)

So this causes an error now:

PHP Fatal error: Declaration of Networkteam\SentryClient\Handler\DebugExceptionHandler::echoExceptionCLI(Throwable $exception) must be compatible with Neos\Flow\Error\AbstractExceptionHandler::echoExceptionCli(Throwable $exception, bool $exceptionWasLogged)

Temporary solution is to pin the package to 7.3.5 in composer.json.

Refactor package to use ThrowableStorage to hook into exception handling

Idea:

We want to use Sentry to log (useful) throwables. For containerized deployments there should be no local files written with exception information. We should investigate the idea if we could refactor the implementation to override the logger throwable storage class and use Sentry (with an ignore list of not very useful exceptions like "asset not found").

This should only happen if a Sentry DSN is set - otherwise the exception should be logged (console or log file).

Maybe we could get rid of the Debug / Production Exception Handlers.

JavaScript error tracking

It would be awesome to have the JavaScript error tracking integrated into Netwokteam.Neos.SentryClient
https://sentry.io/for/javascript/

Unable to install package via composer without adding path manually

Can you make this package available on packagist?

Thx,
Sebastian

User Details (User / Browser) missing on Sentry

Description

Netwokteam.Neos.SentryClient does not send User Details (User / Browser) to Sentry.

Steps to Reproduce

1. Install Netwokteam.Neos.SentryClient
2. Configuration (add dsn)
3. Produce an Error 💥
4. Check Error on Sentry

Expected behavior

Error will be logged to Sentry including User Details (User / Browser)

Actual behavior

Error will be logged to Sentry without User Details (User / Browser)

Affected Versions

Neos: 4.1.7
networkteam/neos-sentryclient: v4.0.1

Upgrading "networkteam/sentryclient" to use Sentry SDK V2

Are there any plans to upgrade the dependency of "networkteam/sentryclient" from 5 to 6 to use the new Sentry SDK 2?