jop-software/typo3-sentry-client

Use Sentry to track down errors in your TYPO3 installation!

TYPO3 Sentry Client

This TYPO3 extension allows you to send exceptions that occur in a TYPO3 installation to Sentry.

---

Professional Support

Professional support is available, please contact [email protected] for more information.

Installation

Install this TYPO3 Extension via composer.

composer require jop-software/typo3-sentry-client

Attention: Installation for non-composer installations on TYPO3 is not supported currently, because we depend on some composer packages. See Issue #4 for more information.

Configuration

Configuration is supported via TYPO3 Extension configuration and environment variables. See Settings > Extension Configuration > typo3_sentry_client in the TYPO3 backend.

You can overwrite those settings with environment variables:

###> jop-software/typo3-sentry-client
SetEnv SENTRY_ACTIVE true
SetEnv SENTRY_DSN http://[email protected]/projectId
SetEnv SENTRY_ENVIRONMENT Production
SetEnv SENTRY_TRACES_SAMPLE_RATE 1.0
SetEnv SENTRY_RELEASE 9.10.19
SetEnv SENTRY_ERROR_LEVEL 32767 # See https://www.php.net/manual/en/errorfunc.constants.php
###< jop-software/typo3-sentry-client

Add the productionExceptionHandler / debugExceptionHandler to your LocalConfiguration.php or AdditionalConfiguration.phpfile.

$GLOBALS['TYPO3_CONF_VARS']['SYS']['productionExceptionHandler'] = 'Jops\TYPO3\Sentry\Handler\ProductionExceptionHandler';
$GLOBALS['TYPO3_CONF_VARS']['SYS']['debugExceptionHandler'] = 'Jops\TYPO3\Sentry\Handler\DebugExceptionHandler';

Multiple Environments

If you use the same .htaccess file for multiple environments like Production / Development, you can move the

SetEnv SENTRY_ENVIRONMENT Production

into the ApplicationContext section of the TYPO3 htaccess. e.G.:

# Rules to set ApplicationContext based on hostname
RewriteCond %{HTTP_HOST} ^dev\.example\.com$
RewriteRule .? - [E=TYPO3_CONTEXT:Development,E=SENTRY_ENVIRONMENT:Development]
RewriteCond %{HTTP_HOST} ^staging\.example\.com$
RewriteRule .? - [E=TYPO3_CONTEXT:Production/Staging,E=SENTRY_ENVIRONMENT:Production-Staging]
RewriteCond %{HTTP_HOST} ^www\.example\.com$
RewriteRule .? - [E=TYPO3_CONTEXT:Production,E=SENTRY_ENVIRONMENT:Production]

Local Development

We use DDEV for local development. With the extension you get a complete TYPO3 DDEV setup. Type ddev start to start the container.

Headless

If you use EXT:headless, you can use the official @nuxtjs/sentry module for the frontend. There is great documentation available here.

This extension itself can be used together with EXT:headless without any known problems.

License

This project is licensed under GPL-2.0-or-later, see the LICENSE file for more information.

© 2022-2023, jop-software Inh. Johannes Przymusinski

typo3-sentry-client's Issues

Installation without composer

This extension cannot be installed without composer currently.
We rely on some composer packages, which are not part of TYPO3 itself.

Is it possible to run composer install when creating a release and include the vendor directory in the ZIP-Archive Github generates for the release?
Also: I guess we need to adjust dependency loading.

Is this even worth it? How many TYPO3 installations nowadays do not use composer?

EDIT
It seems like there is a pretty easy way with composer to accomplish this.
Example from EXT:solr: TYPO3's EXT:solr does this: https://github.com/TYPO3-Solr/ext-solr/blob/main/Resources/Private/Php/ComposerLibraries/composer.json

Migrate to `actions/checkout@v3`

Can we support headless?

For the Headless PWA approcah we would need to inject a JS SDK into NuxtJS.
I guess thats better haused in a separate plugin.

Check weather is makes sense to create a own typo3-nuxt-pwa extension or if we can reccomend an existing NuxtJS Sentry Integration.

feat: send user data bag

Send use information in a user databag to sentry.
This feature should be Opt-In because of data protection rules.

chore: update `sentry/sentry` to 3.8

Recommend https://sentry.nuxtjs.org/guide/setup/ for headless

• Readme

Successor-Of: #10

chore: compatability to TYPO3 12.0

• Check and ensure compatability with TYPO3 12
• Run CI against 11 and 12

Note: When possible both Version 11 and 12 should be supported in the same major version.

bug: environment variables not handeled properly after 1.4

Ooops ...

chore: TYPO3 project testing

Docs: https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/Testing/ProjectTesting.html

feat: Add option to not send deprecation warnings to sentry

feat: add option to exclude 404 errors

in parallal to #24

docs: setup proper TYPO3 RST documentation

Docs: https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/WritingDocForExtension/Index.html

Add TYPO3 Version to sentry

Add an option to pass `error_types` to the Sentry SDK

https://docs.sentry.io/platforms/php/configuration/options/?original_referrer=https%3A%2F%2Fduckduckgo.com%2F#error-types

feat: include the sentry javascript sdk

Should be configurable, because it can be a GDPR issue

`ext_emconf.php` Version does not match Release

The version defined in ext_emconf.php is still 1.0.0 instead of 1.1.0 which would be the latest release.

Reduce the amount of dev-dependencies

Remove those we don't need to run the extension.

chore: upgrade rector to >0.14

the typo3 rector configuration got moved out of rector/rector and all configuration changed in 0.14

Performance Issues

Can this extension lead to performance issues? And If so, how can we mitigate them?

Customizability for other extenions

Other extensions should have an option to register e.G. their own metrics by subscribing to a custom event.

feat: transaction support for CLI processes

Followup for 0970039 and #35.

This change deactivated transaction support for cli processes.

Tasks

• Start transaction for cli
• Stop transaction for cli
  The middleware doesn't get executed. We need to find another way to finish the transaction in cli context.

Allow Configuration through TYPO3 Extension configuration

TYPO3 Documentation: https://docs.typo3.org/m/typo3/reference-coreapi/master/en-us/ExtensionArchitecture/ConfigurationOptions/Index.html

feat: add a dashboard to display stats from sentry

Can we push scheduler data as crons to sentry

Based on this package, everyone can implement cron monitoring themself, but can we build it in a generic way that automatically triggers for every Scheduler Task?

https://docs.sentry.io/product/crons/

chore: cleanup dev-dependencies

make use of typo3/minmal like EXT:loki

Settings a propper error message

Currently, the message for is always empty

"message":""

this prevents e.G. Inbound Filters to work properly.

Release on extensions.typo3.org

• #47
• GH-Actions workflow for auto publish to TER
• Publish a new release

Respect Log-Levels as configured in TYPO3

Improve test Suite

• Run agains PHP 7.4, 8.0 and 8.1
• Searate Linting and testing into multiple workflows / jobs

feat: add an easy way to test the integration

There should be an option to send a example exception to Sentry from the Backend.

Two options

1. A Button in the extension configuration
2. A Button in the "Clear Cache" dropdown

In the case of Option 2, should the permission to test the integration be configurable to prevent abuse.

Match PHP Version constrain of `typo3/typo3`

TYPO3 11 itself uses "php": "^7.4 || ^8.0" we should match that.

Update Version number in ext_emconf.php

Add option to disable sentry

This should be possible with ext_conf_template and environment variables

Make use of rector

Rector: https://github.com/rectorphp/rector
TYPO3 "Extension": https://github.com/sabbelasichon/typo3-rector

feat: add sentry status in system information

chore: setup proper extension testing

Setup the intended TYPO3 Extension testing with docker-composer.

The setup should run locally and in GHA.

See: https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/Testing/ExtensionTesting.html

feat: user feedback

Sentry allows for User Feedback, we should integrate that.
This needs to be configurable due to GDPR.

See: https://docs.sentry.io/product/user-feedback/

Switch license to GPL-2.0-or-later

See jop-software/typo3-loki

Refactor configuration management

tbd

PHPStan

Install and configure phpstan/phpstan.
PHPStan should also run in pipelines for each push / pull-request.

Attach Sentry to the TYPO3 logger

TYPO3 Documentation: https://docs.typo3.org/m/typo3/reference-coreapi/10.4/en-us/ApiOverview/Logging/Logger/Index.html

bug: The parsedUri "http:///var/www/html/vendor/bin/typo3" appears to be malformed in CLI

Uncaught TYPO3 Exception #1436717322: The parsedUri "http:///var/www/html/vendor/bin/typo3" appears to be malformed
thrown in file /var/www/html/public/typo3/sysext/core/Classes/Http/Uri.php
in line 125

Deactivating the extension helps.
I first recognized that on the scheduler:run task of the typo cli.

Add basic unit-tests

There is currently not much to test but we should at least bootstrap them.

feat: blacklist exceptions

There should be an options to blacklist exceptions.

Introduce a new system configuration that contains a regex that gets matches agains every exception FQCN of the exception.

TYPO3 11.5 Compatability

Check and ensure TYPO3 11.5 (LTS) Compatability

chore: check if `EXT:adminpanel` has usefull information for our transactions

chore: run CI with `--prefer-lowest`

This ensures we don't mess up our lower constraints

TYPO3 10.4 compatability

I guess it wouldn't be that hard to ensure compatability with TYPO3 11.4

Performance Monitoring

Sentry documentation: https://docs.sentry.io/platforms/php/performance/

We need to basically change two things:

• Initialize Sentry on every request
• Pass the required configuration to the Sentry Client