[APM] Improved PHP stack trace formatting

[SergeyKleyman]

The way to format stack trace that is idiomatic to PHP (for example it's the way stack trace is formatted by PHP's debug_print_backtrace()):

#<index> <function> called at [<filename>:<lineno>]

and for exceptions (for example it's the way stack trace is formatted by PHP's Throwable::getTraceAsString()):

#<index> <filename>(<lineno>): <function>

An example of stack trace for a method:

#0    MyNamespace\ClassWithStaticMethod::MyNamespace\{closure}() called at [C:\Elastic\Dev\PHP_Agent\MiSC\samples\stack_trace_for_method.php:41]


#1    MyNamespace\ClassWithStaticMethod::myStaticMethod() called at [C:\Elastic\Dev\PHP_Agent\MiSC\samples\stack_trace_for_method.php:49]


#2    MyNamespace\ClassWithInstanceMethod->myInstanceMethod() called at [C:\Elastic\Dev\PHP_Agent\MiSC\samples\stack_trace_for_method.php:58]


#3    MyNamespace\ClassWithClosureInConstructor->MyNamespace\{closure}() called at [C:\Elastic\Dev\PHP_Agent\MiSC\samples\stack_trace_for_method.php:61]


#4    MyNamespace\ClassWithClosureInConstructor->__construct() called at [C:\Elastic\Dev\PHP_Agent\MiSC\samples\stack_trace_for_method.php:67]
elastic/kibana#5   MyNamespace\myFreeStandingFunc() called at [C:\Elastic\Dev\PHP_Agent\MiSC\samples\stack_trace_for_method.php:70]

An example of stack trace for an exception:

MyNamespace\MyException: My exception message (arg1: 1, arg2: my arg2) in /mnt/hgfs/Elastic_Dev/PHP_Agent/MiSC/samples/formatted_stack_trace.php:19
Stack trace:


#0   /mnt/hgfs/Elastic_Dev/PHP_Agent/MiSC/samples/formatted_stack_trace.php(27): MyNamespace\MyClassA::methodA()
elastic/kibana#1  /mnt/hgfs/Elastic_Dev/PHP_Agent/MiSC/samples/formatted_stack_trace.php(36): MyNamespace\MyClassB->methodB()
elastic/kibana#2  /mnt/hgfs/Elastic_Dev/PHP_Agent/MiSC/samples/formatted_stack_trace.php(53): MyNamespace\MyClassC->methodC()
elastic/kibana#3  /mnt/hgfs/Elastic_Dev/PHP_Agent/MiSC/samples/formatted_stack_trace.php(56): MyNamespace\myFreeStandingFunc()
elastic/kibana#4  {main}

References

• [APM] Language specific stack frame formatting #49467 - [APM] Language specific stack frame formatting)

[elasticmachine]

Pinging @elastic/apm-ui (Team:apm)

[sorenlouv]

For the next person who picks this up: The various language-specific renderers are defined here:

kibana/x-pack/plugins/apm/public/components/shared/stacktrace/frame_heading.tsx

Lines 49 to 65 in 88f12fd

	switch (codeLanguage?.toString().toLowerCase()) {
	case 'c#':
	Renderer = CSharpFrameHeadingRenderer;
	break;
	case 'java':
	Renderer = JavaFrameHeadingRenderer;
	break;
	case 'javascript':
	Renderer = JavaScriptFrameHeadingRenderer;
	break;
	case 'ruby':
	Renderer = RubyFrameHeadingRenderer;
	break;
	default:
	Renderer = DefaultFrameHeadingRenderer;
	break;
	}