Re: [Tarantool-patches] [PATCH] box: rfc for stacked diagnostic area

[Nikita Pettik <korablev@tarantool.org>]

On 28 Jan 01:23, Vladislav Shpilevoy wrote:
> Hi! Thanks for the fixes!
> 
> It is not a second review. I just wanted to say that I am
> going to spend less time on reviewes to the end of this
> week due to intensive preparations to FOSDEM. I will get
> back to this RFC as soon as I can, I didn't forget.
> 
> Just one comment for now, below.
> 
> >>> +* **Issues**: [#1148](https://github.com/tarantool/<repository\>/issues/1148)
> >>> +
> >>
> >> 2. You missed 'Summary' section.
> > 
> > I believe it is redundant for such brief RFC. 
> >  
> 
> Nevertheless, please, add it. If that RFC is so simpler,
> then it should not be a problem to make it match the
> RFC template. Template says:
> 
>     "Short description what, why and how is implemented."
> 
> So just say something like
> 
>     The document describes a stacked diagnostics feature. The
>     feature is needed for the cases, when there is a complex and
>     big callstack with different subsystems in it, and sometimes
>     the most lowlevel error is not descriptive enough. So it is
>     wanted to be able to look at errors along the whole callstack
>     from the place where a first error happened. The feature
>     implementation is going to change a fiber's error object to a
>     list of objects, a stack. Its first element will always be
>     created by the deepest and the most basic errors.
> 
> Or anything you think would be better here.

Ok, as you wish. A bit reformulated your description:

diff --git a/doc/rfc/1148-stacked-diagnostics.md b/doc/rfc/1148-stacked-diagnostics.md
index 0d1d07dc3..d57e040ba 100644
--- a/doc/rfc/1148-stacked-diagnostics.md
+++ b/doc/rfc/1148-stacked-diagnostics.md
@@ -6,6 +6,18 @@
                Pettik Nikita @Korablev77 korablev@tarantool.org
 * **Issues**: [#1148](https://github.com/tarantool/<repository\>/issues/1148)
 
+
+## Summary
+
+The document describes a stacked diagnostics feature. It is needed for the cases,
+when there is a complex and huge call stack with variety of subsystems in it.
+It may turn out that the most low-level error is not descriptive enough. In turn
+user may want to be able to look at errors along the whole call stack from the
+place where a first error happened. In terms of implementation single fiber's
+error object is going to be replaced with a list of objects forming diagnostic
+stack. Its first element will always be created by the deepest and the most
+basic error. Both C and Lua APIs are extended to support adding errors in stack.
+