debug_backtrace() from registered shutdown function in PHP

Question

While tinkering for an answer to this question, I found that debug_backtrace() doesn't trace beyond the function registered to register_shutdown_function(), when called from within it.

This was mentioned in this comment for register_shutdown_function() in the PHP docs, stating:

You may get the idea to call debug_backtrace or debug_print_backtrace from inside a shutdown function, to trace where a fatal error occurred. Unfortunately, these functions will not work inside a shutdown function.

Explained with a bit more detail, comments on this answer state:

Doesn't work. The shutdown function occurs after the stack has unwinded. There is no stack information to dump.

Is there any way to circumvent this, forcing PHP to hold the stack trace until the process has terminated altogether, or should we accept it as a given due to PHP internals?

powtac · Answer 1 · 2011-08-30T10:48:57.453

19

This is a very expensive solution. I never used register_tick_function() or tick and I'm not sure if it works as expected.

declare(ticks=1);

function tick_handler() {
    global $backtrace;
    $backtrace = debug_backtrace();
}
register_tick_function('tick_handler');



function shutdown() {
    global $backtrace;
    // do check if $backtrace contains a fatal error...
    var_dump($backtrace);
}
register_shutdown_function('shutdown');

edited Aug 30 '11 at 10:48

answered Aug 30 '11 at 10:43

powtac

40,542
28
115
170

2

Thanks @powtac - Great solution, however it didn't work. I certainly see where you were going with that. I fooled with it a bit, but with no success yet. – Dan Lugg Aug 30 '11 at 13:50
thats clever for sure. i didnt know about tick function – David Mann Jul 15 '16 at 01:05
2

Was searching for same and found this - https://gist.github.com/rmbl/5780995. Didn't try though. Note `declare(ticks=1);` at the end – Karmalakas Jan 24 '18 at 13:23
1

You need the `declare(ticks=1)` statement on every file of your project for this to work – Lucas Bustamante Oct 14 '21 at 17:53

score 9 · Accepted Answer · answered Aug 30 '11 at 12:08

9

Is there any way to circumvent this, forcing PHP to hold the stack trace

That's rather meaningless, when the registered function is invoked, all your defined functions have returned or been cleared down from the stack.

If you need to know where your code exited, then you need to instrument your code.

answered Aug 30 '11 at 12:08

symcbean

47,736
6
59
94

3

Thanks @symcbean - Given all other functions in a given execution have returned, and we've bubbled back up to global scope, of course; however, the part where incomplete function calls are being cleared from the stack (*given `exit` is called at some arbitrary depth of nested calls*) is what I find unfortunate, and not meaningless. I never use `exit` for execution control, favoring exceptions to handle my error logic; this was more of an academic inquiry, rather than real-world. Still though, it makes sense in my mind that the stack should be preserved until the process is killed completely. – Dan Lugg Aug 30 '11 at 13:55
Than what would happen when your registered shutdown function returned? – symcbean Aug 30 '11 at 15:57
Touche, sir; I just thought PHP would (*should*) keep the stack at script termination, check for handlers, execute handlers, wash-rinse-repeat until the queue is empty, and **then** end execution. – Dan Lugg Sep 11 '11 at 22:15
1

You can use [error_get_last](http://php.net/manual/en/function.error-get-last.php) to find where the error was raised, but it won't give you the stack. – Paul Jan 20 '12 at 05:50

score 7 · Answer 3 · answered Oct 13 '14 at 12:14

7

In XDebug extension, there is a xdebug_get_function_stack() function.

This one works similar to PHP's internal debug_backtrace(), but keeps the trace even in shutdown handler.

You won't get the exact exit point though, only the last executed function before the shutdown occured (triggered by die()/exit() call or error).

This is of course suitable only for development environment.

answered Oct 13 '14 at 12:14

oujesky

2,837
1
19
18

quirk: doesn't work for uncaught exceptions... unless a default exception handler has been set with [set_exception_handler](http://php.net/manual/en/function.set-exception-handler.php) – Brad Kent Sep 12 '17 at 03:40
quirk #2: `xdebug_get_function_stack()` begins with shutdown-function if there was a parse error – Brad Kent Sep 12 '17 at 16:14

score 5 · Answer 4 · answered Aug 30 '11 at 10:43

5

From my experience, the shutdown function starts with a clean stack, and it has no access to the "original" stack (as it no longer exists at that point).

Unfortunately, there is no way to save that original stack.

answered Aug 30 '11 at 10:43

Piskvor left the building

91,498
46
177
222

score 0 · Answer 5 · answered Jan 21 '19 at 01:33

0

Inside your registered shutdown function you can get backtrace by error_get_last function. Works for me in PHP7.

answered Jan 21 '19 at 01:33

zzmaster

318
1
5
16

2

This only gets the file and line where the error occurred - not the full backtrace. – Sinus the Tentacular Mar 12 '19 at 19:16

debug_backtrace() from registered shutdown function in PHP

5 Answers5

Linked