[4.x] Add model hydrations to model watcher #1000

paras-malhotra · 2020-12-12T18:48:20Z

Motivation

Re-attempt of #999 without a separate tab or watcher.

This PR adds the ability to record model hydrations within the Model Watcher (without a separate tab or watcher). This would help to know how many models are being hydrated for a request - something that can have a significant on performance / memory usage. Inspired from a similar popular feature of Debugbar: barryvdh/laravel-debugbar#947.

There are no breaking changes with this PR. To enable recording of model hydrations, we would need to enable the hydrations flag in the config/telescope.php file like so:

Watchers\ModelWatcher::class => [
    'enabled' => env('TELESCOPE_MODEL_WATCHER', true),
    'events' => ['eloquent.*'],
    'hydrations' => true,
],

Index Screen (The retrieved is the one for model hydrations)

Preview Screen

Related Entries

Note

This PR would need a re-build and I haven't committed the compiled files (just the source) as per the contribution guidelines.

gboquizosanchez · 2021-01-17T02:24:48Z

src/Watchers/ModelWatcher.php

+
+            Telescope::recordModelEvent($this->hydrationEntries[$modelClass]);
+        } else {
+            $this->hydrationEntries[$modelClass]->content['count']++;


I'm getting an "Illegal string offset 'count'" in this line. I think is because for some reason... content doesn't have an array in some models...

It can be prevent by

if (! is_array($this->hydrationEntries[$modelClass]->content)) { $this->hydrationEntries[$modelClass]->content = json_decode($this->hydrationEntries[$modelClass]->content, true); } $this->hydrationEntries[$modelClass]->content['count']++;

paras-malhotra · 2021-01-17T07:23:15Z

@gboquizosanchez content always seems to be an array. Refer

telescope/src/IncomingEntry.php

Lines 66 to 82 in de59dbe

    
               /** 
        
                * Create a new incoming entry instance. 
        
                * 
        
                * @param  array  $content 
        
                * @param  string|null  $uuid 
        
                * @return void 
        
                */ 
        
               public function __construct(array $content, $uuid = null) 
        
               { 
        
                   $this->uuid = $uuid ?: (string) Str::orderedUuid(); 
        
                   $this->recordedAt = now(); 
        
                   $this->content = array_merge($content, ['hostname' => gethostname()]); 
        
                   // $this->tags = ['hostname:'.gethostname()]; 
        
               }

Can you open an issue with some steps to replicate your error?

gboquizosanchez · 2021-01-17T13:33:51Z

Yeah, sure, I'll test in a fresh installation with same parameters and if I can reproduce the issue, I'll post it.

azaricstefan · 2021-02-09T22:05:34Z

@gboquizosanchez
@paras-malhotra

Laravel 8.25.0
Telescope 4.4.0

I am getting this error:

ERROR: Illegal string offset 'count'
[2021-02-09T20:36:41.095047+01:00] main-channel.ERROR: Illegal string offset 'count' {"exception":"[object] (ErrorException(code: 0): Illegal string offset 'count' at /var/www/vendor/laravel/telescope/src/Watchers/ModelWatcher.php:87)\n[previous exception] [object] (ErrorException(code: 0): Illegal string offset 'count' at /var/www/vendor/laravel/telescope/src/Watchers/ModelWatcher.php:87)"} []

paras-malhotra · 2021-02-10T08:07:45Z

@azaricstefan can you please share the full stack trace? I'm unable to reproduce this.

azaricstefan · 2021-02-10T23:16:59Z

Sure, @paras-malhotra.

Message
Illegal string offset 'count'
Level
ERROR

Here is the stack trace:

/var/www/vendor/laravel/telescope/src/Watchers/ModelWatcher.php:87
/var/www/vendor/laravel/telescope/src/Watchers/ModelWatcher.php:49
/var/www/vendor/laravel/framework/src/Illuminate/Events/Dispatcher.php:389
/var/www/vendor/laravel/framework/src/Illuminate/Events/Dispatcher.php:237
/var/www/vendor/laravel/framework/src/Illuminate/Database/Eloquent/Concerns/HasEvents.php:189
/var/www/vendor/laravel/framework/src/Illuminate/Database/Eloquent/Model.php:434
/var/www/vendor/laravel/framework/src/Illuminate/Database/Eloquent/Builder.php:328
:
/var/www/vendor/laravel/framework/src/Illuminate/Database/Eloquent/Builder.php:327
/var/www/vendor/laravel/framework/src/Illuminate/Support/Traits/ForwardsCalls.php:23
/var/www/vendor/laravel/framework/src/Illuminate/Database/Eloquent/Model.php:1885
/var/www/vendor/laravel/framework/src/Illuminate/Database/Eloquent/Builder.php:571
/var/www/vendor/laravel/framework/src/Illuminate/Database/Eloquent/Builder.php:555
/var/www/app/Jobs/SendExceptionNotificationToDevelopers.php:71
/var/www/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php:36
/var/www/vendor/laravel/framework/src/Illuminate/Container/Util.php:40
/var/www/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php:93
/var/www/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php:37
/var/www/vendor/laravel/framework/src/Illuminate/Container/Container.php:610
/var/www/vendor/laravel/framework/src/Illuminate/Bus/Dispatcher.php:128
/var/www/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php:128
/var/www/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php:103
/var/www/vendor/laravel/framework/src/Illuminate/Bus/Dispatcher.php:132
/var/www/vendor/laravel/framework/src/Illuminate/Queue/CallQueuedHandler.php:118
/var/www/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php:128
/var/www/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php:103
/var/www/vendor/laravel/framework/src/Illuminate/Queue/CallQueuedHandler.php:120
/var/www/vendor/laravel/framework/src/Illuminate/Queue/CallQueuedHandler.php:70
/var/www/vendor/laravel/framework/src/Illuminate/Queue/Jobs/Job.php:98
/var/www/vendor/laravel/framework/src/Illuminate/Queue/Worker.php:406
/var/www/vendor/laravel/framework/src/Illuminate/Queue/Worker.php:356
/var/www/vendor/laravel/framework/src/Illuminate/Queue/Worker.php:158
/var/www/vendor/laravel/framework/src/Illuminate/Queue/Console/WorkCommand.php:116
/var/www/vendor/laravel/framework/src/Illuminate/Queue/Console/WorkCommand.php:100
/var/www/vendor/laravel/horizon/src/Console/WorkCommand.php:50
/var/www/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php:36
/var/www/vendor/laravel/framework/src/Illuminate/Container/Util.php:40
/var/www/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php:93
/var/www/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php:37
/var/www/vendor/laravel/framework/src/Illuminate/Container/Container.php:610
/var/www/vendor/laravel/framework/src/Illuminate/Console/Command.php:136
/var/www/vendor/symfony/console/Command/Command.php:255
/var/www/vendor/laravel/framework/src/Illuminate/Console/Command.php:121
/var/www/vendor/symfony/console/Application.php:971
/var/www/vendor/symfony/console/Application.php:290
/var/www/vendor/symfony/console/Application.php:166
/var/www/vendor/laravel/framework/src/Illuminate/Console/Application.php:93
/var/www/vendor/laravel/framework/src/Illuminate/Foundation/Console/Kernel.php:129
/var/www/artisan:37

This command is linked to this exception in Telescope:
{
"command": "horizon:work",
"connection": "redis"
}
options:
{
"name": "default",
"delay": "0",
"backoff": "0",
"max-jobs": "0",
"max-time": "0",
"daemon": false,
"force": false,
"memory": "128",
"once": false,
"stop-when-empty": false,
"queue": "default",
"sleep": "3",
"supervisor": "a2f68ef99676-1BDs:supervisor",
"timeout": "60",
"tries": "3",
"help": false,
"quiet": false,
"verbose": false,
"version": false,
"ansi": false,
"no-ansi": false,
"no-interaction": false,
"env": null
}

This class SendExceptionNotificationToDevelopers.php takes exception details and send it via email.
In TelescopeServiceProvider that Job is dispatched.

        Telescope::afterStoring(function(array $entries, $batchId) {
            foreach ($entries as $entry) {
                /** @var IncomingExceptionEntry $entry */
                if ($entry instanceof IncomingExceptionEntry) {
                    dispatch(new SendExceptionNotificationToDevelopers($entry->uuid, $batchId,
                        $entry->exception->getMessage(),$entry->exception->getFile(), $entry->exception->getLine()));
                }
            }
        });

I hope this helps in the investigation.

paras-malhotra · 2021-02-11T11:25:10Z

@azaricstefan can you share what line 71 of SendExceptionNotificationToDevelopers is doing?

azaricstefan · 2021-02-11T11:29:44Z

Sure.
It's hardcoded for first 3 users (devs).

$devs = User::whereIn('id',[1,2,3],'OR')->get();

paras-malhotra · 2021-02-11T11:48:45Z

@azaricstefan, I am unable to reproduce this. I tried dispatching a job within the afterStoring Telescope callback. The job has the exact same query that you gave. But I still didn't get any exceptions.

It would really help if you can create a reproducible exception on a fresh Laravel install and open a new issue for that.

azaricstefan · 2021-02-11T12:12:39Z

Ok, I will try to reproduce it on a clean Laravel project.

paras-malhotra and others added 4 commits December 13, 2020 00:13

[4.x] Add model hydrations to model watcher

85c8a5f

fix styleci

8e01f61

dont record retrieved events by default for no breaking changes

1f202a9

Update preview.vue

1c715b1

taylorotwell merged commit 0ea1f65 into laravel:4.x Dec 13, 2020

paras-malhotra deleted the hydration_model_watcher branch December 13, 2020 20:43

paras-malhotra mentioned this pull request Dec 15, 2020

[8.x] Document hydrations option in Telescope model watcher laravel/docs#6666

Merged

gboquizosanchez reviewed Jan 17, 2021

View reviewed changes

driesvints mentioned this pull request Jan 31, 2022

[4.x] Attempt to fix model hydration #1174

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[4.x] Add model hydrations to model watcher #1000

[4.x] Add model hydrations to model watcher #1000

paras-malhotra commented Dec 12, 2020 •

edited

Loading

gboquizosanchez Jan 17, 2021

paras-malhotra commented Jan 17, 2021

gboquizosanchez commented Jan 17, 2021

azaricstefan commented Feb 9, 2021

paras-malhotra commented Feb 10, 2021

azaricstefan commented Feb 10, 2021

paras-malhotra commented Feb 11, 2021

azaricstefan commented Feb 11, 2021 •

edited

Loading

paras-malhotra commented Feb 11, 2021

azaricstefan commented Feb 11, 2021

[4.x] Add model hydrations to model watcher #1000

[4.x] Add model hydrations to model watcher #1000

Conversation

paras-malhotra commented Dec 12, 2020 • edited Loading

Motivation

Index Screen (The retrieved is the one for model hydrations)

Preview Screen

Related Entries

Note

gboquizosanchez Jan 17, 2021

Choose a reason for hiding this comment

paras-malhotra commented Jan 17, 2021

gboquizosanchez commented Jan 17, 2021

azaricstefan commented Feb 9, 2021

paras-malhotra commented Feb 10, 2021

azaricstefan commented Feb 10, 2021

paras-malhotra commented Feb 11, 2021

azaricstefan commented Feb 11, 2021 • edited Loading

paras-malhotra commented Feb 11, 2021

azaricstefan commented Feb 11, 2021

paras-malhotra commented Dec 12, 2020 •

edited

Loading

azaricstefan commented Feb 11, 2021 •

edited

Loading