Missing Sentry features

[LordSimal]

This issue should track the missing features of this plugin which could technically be implemented:

Insights - Requests

Cake's HTTP client could rather easily be hooked up to the this feature since events have been added to CakePHP 5.1

Insights - Assets

If assets are served via the AssetMiddleware they could be tracked via the Assets feature of sentry since they are not statically served via the webserver directly.

There is just no event or hook to currently trigger such logic

Insights - Caches

As far as I can tell there is no event or hook present to easily trace each cache set/get call. The DebugKit can only show how many hits/fails a specific cache pool got but thats not granular enough for what the sentry API requires

Insights - Queues

This should work indipendently on which queue plugin someone uses (either cakephp/queue or e.g. dereuromark/cakephp-queue)

Looking at the docs this is primarily something that needs to be implemented in the worker/runner side of the queue library, not in here.

Cron

See #11

[LordSimal]

HTTP Client Tracing: #18

[LordSimal]

Logging Feature: https://docs.sentry.io/platforms/php/logs/ => #36

[LordSimal]

CakePHP Caching Events: cakephp/cakephp#18956 => #41

[dereuromark]

For queue I opened dereuromark/cakephp-queue#449
Let me know if thats what you had in mind - and if that works for Sentry

[LordSimal]

My main question would be if its my responsibility to do all plugin integrations or if its the plugin's responsibility to integrate sentry features.

Aka should I now listen to your events to trigger the sentry calls or should you just check if the CakeSentry plugin is active and then do the calls like its described here

[dereuromark]

Well, both could be valid.
The first just throws the events in the plugin and would need docs on how to set this up for sentry.

I guess the latter would be more convenient for users. If the plugin is active, directly trigger the correct events.
Not sure if the generic ones anyone would listen to anyway^^

[LordSimal]

I could definitely listen to your queue events, but just the fact, that you pass down an instance of your Job entity is very specific to your plugin. So if e.g. we add events to our cakephp-queue plugin I'd need to make a separate implementation for that one as well.

I'd rather prepare a few event listeneres with a specific set of data, so each plugin just has to call these events with the proper data set. Then its fairly agnostic.

[dereuromark]

Updated the PR to include both approaches:

1. Generic events for any listener - Queue.Job.created, Queue.Job.started, Queue.Job.completed, Queue.Job.failed

2. Built-in Sentry integration when Queue.sentry => true is configured - automatically creates producer/consumer spans with trace propagation

The built-in integration is opt-in so it won't interfere with existing setups. Users just need to enable it in config and have Sentry initialized (e.g., via cakephp-sentry).

See: dereuromark/cakephp-queue#449