Tree View of Call Graph for Services and Simple Methods

[James Yong-2]

Hi All,

Would like implement a feature to log a tree view of services, simple methods, events that are called during a request.
Something like:
-> Service A
        -> Simple Method B
                -> Service C (Async)
        -> Simple Method D

All feedback is greatly appreciated.

Regards,
James Yong

[Jacques Le Roux]

Hi James,

I think it deserves a POC in a Jira

+1

Jacques


Le 23/12/2017 à 17:37, James Yong a écrit :

> Hi All,
>
> Would like implement a feature to log a tree view of services, simple methods, events that are called during a request.
> Something like:
> -> Service A
>          -> Simple Method B
>                  -> Service C (Async)
>          -> Simple Method D
>
> All feedback is greatly appreciated.
>
> Regards,
> James Yong
>

[Paul Foxworthy]

Hi James,

I have been pondering something like this.

I suggest the output should be in a structured format like XML, JSON or
YAML, so it can be parsed by tools. Maybe YAML because it's intended to
give wiki-like human readability.

I suggest the ability to capture parameter values. You might make that
optional, with "summary" and "verbose" options. Parameter values would only
be logged if the "verbose" option is enabled.

With both of these in place, one could use this to capture a series of
steps to generate a reproducible unit test, or to compose existing services
into a super-service.

The minilang <trace> element and its implementation might have some
relevance.

Cheers

Paul Foxworthy


On 24 December 2017 at 03:37, James Yong <[hidden email]> wrote:

> Hi All,
>
> Would like implement a feature to log a tree view of services, simple
> methods, events that are called during a request.
> Something like:
> -> Service A
>         -> Simple Method B
>                 -> Service C (Async)
>         -> Simple Method D
>
> All feedback is greatly appreciated.
>
> Regards,
> James Yong
>

--
Coherent Software Australia Pty Ltd
PO Box 2773
Cheltenham Vic 3192
Australia

Phone: [phone]
Web: http://www.coherentsoftware.com.au/
Email: [hidden email]

[Jacques Le Roux]

+1 for YAML

Jacques


Le 03/01/2018 à 01:22, Paul Foxworthy a écrit :

> Hi James,
>
> I have been pondering something like this.
>
> I suggest the output should be in a structured format like XML, JSON or
> YAML, so it can be parsed by tools. Maybe YAML because it's intended to
> give wiki-like human readability.
>
> I suggest the ability to capture parameter values. You might make that
> optional, with "summary" and "verbose" options. Parameter values would only
> be logged if the "verbose" option is enabled.
>
> With both of these in place, one could use this to capture a series of
> steps to generate a reproducible unit test, or to compose existing services
> into a super-service.
>
> The minilang <trace> element and its implementation might have some
> relevance.
>
> Cheers
>
> Paul Foxworthy
>
>
> On 24 December 2017 at 03:37, James Yong <[hidden email]> wrote:
>
>> Hi All,
>>
>> Would like implement a feature to log a tree view of services, simple
>> methods, events that are called during a request.
>> Something like:
>> -> Service A
>>          -> Simple Method B
>>                  -> Service C (Async)
>>          -> Simple Method D
>>
>> All feedback is greatly appreciated.
>>
>> Regards,
>> James Yong
>>
>
>

[taher]

Hmm, I'm not sure it would be a great idea to introduce a new data
format to OFBiz. It would mean adding new libraries to the framework
and thus more complexity.

I know XML is not the greatest data format in the world, but it is
what OFBiz uses, and so we should always try to stay consistent in our
approach.

On Wed, Jan 3, 2018 at 1:24 PM, Jacques Le Roux
<[hidden email]> wrote:

> +1 for YAML
>
> Jacques
>
>
>
> Le 03/01/2018 à 01:22, Paul Foxworthy a écrit :
>>
>> Hi James,
>>
>> I have been pondering something like this.
>>
>> I suggest the output should be in a structured format like XML, JSON or
>> YAML, so it can be parsed by tools. Maybe YAML because it's intended to
>> give wiki-like human readability.
>>
>> I suggest the ability to capture parameter values. You might make that
>> optional, with "summary" and "verbose" options. Parameter values would
>> only
>> be logged if the "verbose" option is enabled.
>>
>> With both of these in place, one could use this to capture a series of
>> steps to generate a reproducible unit test, or to compose existing
>> services
>> into a super-service.
>>
>> The minilang <trace> element and its implementation might have some
>> relevance.
>>
>> Cheers
>>
>> Paul Foxworthy
>>
>>
>> On 24 December 2017 at 03:37, James Yong <[hidden email]> wrote:
>>
>>> Hi All,
>>>
>>> Would like implement a feature to log a tree view of services, simple
>>> methods, events that are called during a request.
>>> Something like:
>>> -> Service A
>>>          -> Simple Method B
>>>                  -> Service C (Async)
>>>          -> Simple Method D
>>>
>>> All feedback is greatly appreciated.
>>>
>>> Regards,
>>> James Yong
>>>
>>
>>
>

[Paul Foxworthy]

Hi Taher,

Yes, that had occurred to me. How about a capture format of XML and an XSLT
transform to HTML and/or plain text for human readability?

Cheers

Paul Foxworthy


On 4 January 2018 at 04:55, Taher Alkhateeb <[hidden email]>
wrote:

> Hmm, I'm not sure it would be a great idea to introduce a new data
> format to OFBiz. It would mean adding new libraries to the framework
> and thus more complexity.
>
> I know XML is not the greatest data format in the world, but it is
> what OFBiz uses, and so we should always try to stay consistent in our
> approach.
>
> On Wed, Jan 3, 2018 at 1:24 PM, Jacques Le Roux
> <[hidden email]> wrote:
> > +1 for YAML
> >
> > Jacques
> >
> >
> >
> > Le 03/01/2018 à 01:22, Paul Foxworthy a écrit :
> >>
> >> Hi James,
> >>
> >> I have been pondering something like this.
> >>
> >> I suggest the output should be in a structured format like XML, JSON or
> >> YAML, so it can be parsed by tools. Maybe YAML because it's intended to
> >> give wiki-like human readability.
> >>
> >> I suggest the ability to capture parameter values. You might make that
> >> optional, with "summary" and "verbose" options. Parameter values would
> >> only
> >> be logged if the "verbose" option is enabled.
> >>
> >> With both of these in place, one could use this to capture a series of
> >> steps to generate a reproducible unit test, or to compose existing
> >> services
> >> into a super-service.
> >>
> >> The minilang <trace> element and its implementation might have some
> >> relevance.
> >>
> >> Cheers
> >>
> >> Paul Foxworthy
> >>
> >>
> >> On 24 December 2017 at 03:37, James Yong <[hidden email]> wrote:
> >>
> >>> Hi All,
> >>>
> >>> Would like implement a feature to log a tree view of services, simple
> >>> methods, events that are called during a request.
> >>> Something like:
> >>> -> Service A
> >>>          -> Simple Method B
> >>>                  -> Service C (Async)
> >>>          -> Simple Method D
> >>>
> >>> All feedback is greatly appreciated.
> >>>
> >>> Regards,
> >>> James Yong
> >>>
> >>
> >>
> >
>

--
Coherent Software Australia Pty Ltd
PO Box 2773
Cheltenham Vic 3192
Australia

Phone: [phone]
Web: http://www.coherentsoftware.com.au/
Email: [hidden email]

[taher]

Yeah that sounds reasonable and we will not need any new libraries or
logic, just one or few xslt docs.

On Jan 4, 2018 2:00 AM, "Paul Foxworthy" <[hidden email]> wrote:

Hi Taher,

Yes, that had occurred to me. How about a capture format of XML and an XSLT
transform to HTML and/or plain text for human readability?

Cheers

Paul Foxworthy


On 4 January 2018 at 04:55, Taher Alkhateeb <[hidden email]>
wrote:

> Hmm, I'm not sure it would be a great idea to introduce a new data
> format to OFBiz. It would mean adding new libraries to the framework
> and thus more complexity.
>
> I know XML is not the greatest data format in the world, but it is
> what OFBiz uses, and so we should always try to stay consistent in our
> approach.
>
> On Wed, Jan 3, 2018 at 1:24 PM, Jacques Le Roux
> <[hidden email]> wrote:
> > +1 for YAML
> >
> > Jacques
> >
> >
> >
> > Le 03/01/2018 à 01:22, Paul Foxworthy a écrit :
> >>
> >> Hi James,
> >>
> >> I have been pondering something like this.
> >>
> >> I suggest the output should be in a structured format like XML, JSON or
> >> YAML, so it can be parsed by tools. Maybe YAML because it's intended to
> >> give wiki-like human readability.
> >>
> >> I suggest the ability to capture parameter values. You might make that
> >> optional, with "summary" and "verbose" options. Parameter values would
> >> only
> >> be logged if the "verbose" option is enabled.
> >>
> >> With both of these in place, one could use this to capture a series of
> >> steps to generate a reproducible unit test, or to compose existing
> >> services
> >> into a super-service.
> >>
> >> The minilang <trace> element and its implementation might have some
> >> relevance.
> >>
> >> Cheers
> >>
> >> Paul Foxworthy
> >>
> >>
> >> On 24 December 2017 at 03:37, James Yong <[hidden email]> wrote:
> >>
> >>> Hi All,
> >>>
> >>> Would like implement a feature to log a tree view of services, simple
> >>> methods, events that are called during a request.
> >>> Something like:
> >>> -> Service A
> >>>          -> Simple Method B
> >>>                  -> Service C (Async)
> >>>          -> Simple Method D
> >>>
> >>> All feedback is greatly appreciated.
> >>>
> >>> Regards,
> >>> James Yong
> >>>
> >>
> >>
> >
>

--
Coherent Software Australia Pty Ltd
PO Box 2773
Cheltenham Vic 3192
Australia

Phone: [phone]
Web: http://www.coherentsoftware.com.au/
Email: [hidden email]

[Jacques Le Roux]

I thought about that too, what about http://yaml.org/xml.html ?

Jacques


Le 04/01/2018 à 00:13, Taher Alkhateeb a écrit :

> Yeah that sounds reasonable and we will not need any new libraries or
> logic, just one or few xslt docs.
>
> On Jan 4, 2018 2:00 AM, "Paul Foxworthy" <[hidden email]> wrote:
>
> Hi Taher,
>
> Yes, that had occurred to me. How about a capture format of XML and an XSLT
> transform to HTML and/or plain text for human readability?
>
> Cheers
>
> Paul Foxworthy
>
>
> On 4 January 2018 at 04:55, Taher Alkhateeb <[hidden email]>
> wrote:
>
>> Hmm, I'm not sure it would be a great idea to introduce a new data
>> format to OFBiz. It would mean adding new libraries to the framework
>> and thus more complexity.
>>
>> I know XML is not the greatest data format in the world, but it is
>> what OFBiz uses, and so we should always try to stay consistent in our
>> approach.
>>
>> On Wed, Jan 3, 2018 at 1:24 PM, Jacques Le Roux
>> <[hidden email]> wrote:
>>> +1 for YAML
>>>
>>> Jacques
>>>
>>>
>>>
>>> Le 03/01/2018 à 01:22, Paul Foxworthy a écrit :
>>>> Hi James,
>>>>
>>>> I have been pondering something like this.
>>>>
>>>> I suggest the output should be in a structured format like XML, JSON or
>>>> YAML, so it can be parsed by tools. Maybe YAML because it's intended to
>>>> give wiki-like human readability.
>>>>
>>>> I suggest the ability to capture parameter values. You might make that
>>>> optional, with "summary" and "verbose" options. Parameter values would
>>>> only
>>>> be logged if the "verbose" option is enabled.
>>>>
>>>> With both of these in place, one could use this to capture a series of
>>>> steps to generate a reproducible unit test, or to compose existing
>>>> services
>>>> into a super-service.
>>>>
>>>> The minilang <trace> element and its implementation might have some
>>>> relevance.
>>>>
>>>> Cheers
>>>>
>>>> Paul Foxworthy
>>>>
>>>>
>>>> On 24 December 2017 at 03:37, James Yong <[hidden email]> wrote:
>>>>
>>>>> Hi All,
>>>>>
>>>>> Would like implement a feature to log a tree view of services, simple
>>>>> methods, events that are called during a request.
>>>>> Something like:
>>>>> -> Service A
>>>>>           -> Simple Method B
>>>>>                   -> Service C (Async)
>>>>>           -> Simple Method D
>>>>>
>>>>> All feedback is greatly appreciated.
>>>>>
>>>>> Regards,
>>>>> James Yong
>>>>>
>>>>
>
>
> --
> Coherent Software Australia Pty Ltd
> PO Box 2773
> Cheltenham Vic 3192
> Australia
>
> Phone: [phone]
> Web: http://www.coherentsoftware.com.au/
> Email: [hidden email]
>

[Paul Foxworthy]

On 4 January 2018 at 19:47, Jacques Le Roux <[hidden email]>
wrote:

> I thought about that too, what about http://yaml.org/xml.html ?
>

So the point of the XML binding for YAML is that it is XML, but can be
transformed to YAML?

If the XML is the capture format, transforming to any other format would be
purely for the purpose of human readability, yes?

If so, what's the benefit of YAML compared to plain text?

Cheers

Paul Foxworthy

--
Coherent Software Australia Pty Ltd
PO Box 2773
Cheltenham Vic 3192
Australia

Phone: [phone]
Web: http://www.coherentsoftware.com.au/
Email: [hidden email]

[Jacques Le Roux]

Le 05/01/2018 à 01:08, Paul Foxworthy a écrit :

> On 4 January 2018 at 19:47, Jacques Le Roux <[hidden email]>
> wrote:
>
>> I thought about that too, what about http://yaml.org/xml.html ?
>>
> So the point of the XML binding for YAML is that it is XML, but can be
> transformed to YAML?
>
> If the XML is the capture format, transforming to any other format would be
> purely for the purpose of human readability, yes?
>
> If so, what's the benefit of YAML compared to plain text?
>
> Cheers
>
> Paul Foxworthy
>

Actually none :)

Jacques

[James Yong-2]

Hi all,

I have uploaded a patch for POC.

Thanks,
James Yong

On 2017/12/29 20:53:37, Jacques Le Roux <[hidden email]> wrote:

> Hi James,
>
> I think it deserves a POC in a Jira
>
> +1
>
> Jacques
>
>
> Le 23/12/2017 à 17:37, James Yong a écrit :
> > Hi All,
> >
> > Would like implement a feature to log a tree view of services, simple methods, events that are called during a request.
> > Something like:
> > -> Service A
> >          -> Simple Method B
> >                  -> Service C (Async)
> >          -> Simple Method D
> >
> > All feedback is greatly appreciated.
> >
> > Regards,
> > James Yong
> >
>
>

[James Yong-2]

Hi Paul and all,

Currently the output is logged directly in the console.
Haven't looked into the capturing of parameter values but I think is a good idea.

Feedbacks welcome for further usability and improvement.

Regards,
James Yong

On 2018/01/03 00:22:26, Paul Foxworthy <[hidden email]> wrote:

> Hi James,
>
> I have been pondering something like this.
>
> I suggest the output should be in a structured format like XML, JSON or
> YAML, so it can be parsed by tools. Maybe YAML because it's intended to
> give wiki-like human readability.
>
> I suggest the ability to capture parameter values. You might make that
> optional, with "summary" and "verbose" options. Parameter values would only
> be logged if the "verbose" option is enabled.
>
> With both of these in place, one could use this to capture a series of
> steps to generate a reproducible unit test, or to compose existing services
> into a super-service.
>
> The minilang <trace> element and its implementation might have some
> relevance.
>
> Cheers
>
> Paul Foxworthy
>
>
> On 24 December 2017 at 03:37, James Yong <[hidden email]> wrote:
>
> > Hi All,
> >
> > Would like implement a feature to log a tree view of services, simple
> > methods, events that are called during a request.
> > Something like:
> > -> Service A
> >         -> Simple Method B
> >                 -> Service C (Async)
> >         -> Simple Method D
> >
> > All feedback is greatly appreciated.
> >
> > Regards,
> > James Yong
> >
>
>
>
> --
> Coherent Software Australia Pty Ltd
> PO Box 2773
> Cheltenham Vic 3192
> Australia
>
> Phone: [phone]
> Web: http://www.coherentsoftware.com.au/
> Email: [hidden email]
>

[Swapnil Mane]

Hi James,

Thanks for your contribution.
I have applied the patch locally and functionality wise it is working
really nice! :)


- Best Regards,
Swapnil M Mane
www.hotwaxsystems.com

On Thu, Apr 19, 2018 at 11:56 AM, James Yong <[hidden email]> wrote:

> Hi all,
>
> I have uploaded a patch for POC.
>
> Thanks,
> James Yong
>
> On 2017/12/29 20:53:37, Jacques Le Roux <[hidden email]>
> wrote:
> > Hi James,
> >
> > I think it deserves a POC in a Jira
> >
> > +1
> >
> > Jacques
> >
> >
> > Le 23/12/2017 à 17:37, James Yong a écrit :
> > > Hi All,
> > >
> > > Would like implement a feature to log a tree view of services, simple
> methods, events that are called during a request.
> > > Something like:
> > > -> Service A
> > >          -> Simple Method B
> > >                  -> Service C (Async)
> > >          -> Simple Method D
> > >
> > > All feedback is greatly appreciated.
> > >
> > > Regards,
> > > James Yong
> > >
> >
> >
>

[James Yong-2]

Hi Swapnil,

Thanks for testing the patch.

Regards,
James Yong

On 2018/04/19 10:36:37, Swapnil Mane <[hidden email]> wrote:

> Hi James,
>
> Thanks for your contribution.
> I have applied the patch locally and functionality wise it is working
> really nice! :)
>
>
> - Best Regards,
> Swapnil M Mane
> www.hotwaxsystems.com
>
> On Thu, Apr 19, 2018 at 11:56 AM, James Yong <[hidden email]> wrote:
>
> > Hi all,
> >
> > I have uploaded a patch for POC.
> >
> > Thanks,
> > James Yong
> >
> > On 2017/12/29 20:53:37, Jacques Le Roux <[hidden email]>
> > wrote:
> > > Hi James,
> > >
> > > I think it deserves a POC in a Jira
> > >
> > > +1
> > >
> > > Jacques
> > >
> > >
> > > Le 23/12/2017 à 17:37, James Yong a écrit :
> > > > Hi All,
> > > >
> > > > Would like implement a feature to log a tree view of services, simple
> > methods, events that are called during a request.
> > > > Something like:
> > > > -> Service A
> > > >          -> Simple Method B
> > > >                  -> Service C (Async)
> > > >          -> Simple Method D
> > > >
> > > > All feedback is greatly appreciated.
> > > >
> > > > Regards,
> > > > James Yong
> > > >
> > >
> > >
> >
>

[James Yong-2]

Hi all,

POC at https://issues.apache.org/jira/projects/OFBIZ/issues/OFBIZ-10351

Regards,
James

On 2018/04/19 06:26:50, James Yong <[hidden email]> wrote:

> Hi all,
>
> I have uploaded a patch for POC.
>
> Thanks,
> James Yong
>
> On 2017/12/29 20:53:37, Jacques Le Roux <[hidden email]> wrote:
> > Hi James,
> >
> > I think it deserves a POC in a Jira
> >
> > +1
> >
> > Jacques
> >
> >
> > Le 23/12/2017 à 17:37, James Yong a écrit :
> > > Hi All,
> > >
> > > Would like implement a feature to log a tree view of services, simple methods, events that are called during a request.
> > > Something like:
> > > -> Service A
> > >          -> Simple Method B
> > >                  -> Service C (Async)
> > >          -> Simple Method D
> > >
> > > All feedback is greatly appreciated.
> > >
> > > Regards,
> > > James Yong
> > >
> >
> >
>