[PATCH] usertools: telemetry json support pretty print

[PATCH] usertools: telemetry json support pretty print

[Chengwen Feng]

Currently, the dpdk-telemetry.py show json in raw format, which is not
good for human reading.

E.g. The command '/ethdev/xstats,0' will outupt:
{"/ethdev/xstats": {"rx_good_packets": 0, "tx_good_packets": 0,
"rx_good_bytes": 0, "tx_good_bytes": 0, "rx_missed_errors": 0,
"rx_errors": 0, "tx_errors": 0, "rx_mbuf_allocation_errors": 0,
"rx_q0_packets": 0,...}}

This patch supports json pretty print by adding extra indent=4
parameter, so the same command will output:
{
    "/ethdev/xstats": {
        "rx_good_packets": 0,
        "tx_good_packets": 0,
        "rx_good_bytes": 0,
        "tx_good_bytes": 0,
        "rx_missed_errors": 0,
        "rx_errors": 0,
        "tx_errors": 0,
        "rx_mbuf_allocation_errors": 0,
        "rx_q0_packets": 0,
        ...
    }
}

Signed-off-by: Chengwen Feng <fengchengwen@huawei.com>
---
 usertools/dpdk-telemetry.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/usertools/dpdk-telemetry.py b/usertools/dpdk-telemetry.py
index a81868a547..315f78fb8f 100755
--- a/usertools/dpdk-telemetry.py
+++ b/usertools/dpdk-telemetry.py
@@ -33,7 +33,7 @@ def read_socket(sock, buf_len, echo=True):
         sock.close()
         raise
     if echo:
-        print(json.dumps(ret))
+        print(json.dumps(ret, indent=4))
     return ret
 
 
-- 
2.17.1

[PATCH v2] usertools: telemetry json support pretty print

[Chengwen Feng]

Currently, the dpdk-telemetry.py show json in raw format, which is not
good for human reading.

E.g. The command '/ethdev/xstats,0' will output:
{"/ethdev/xstats": {"rx_good_packets": 0, "tx_good_packets": 0,
"rx_good_bytes": 0, "tx_good_bytes": 0, "rx_missed_errors": 0,
"rx_errors": 0, "tx_errors": 0, "rx_mbuf_allocation_errors": 0,
"rx_q0_packets": 0,...}}

This patch supports json pretty print by adding extra indent=4
parameter, so the same command will output:
{
    "/ethdev/xstats": {
        "rx_good_packets": 0,
        "tx_good_packets": 0,
        "rx_good_bytes": 0,
        "tx_good_bytes": 0,
        "rx_missed_errors": 0,
        "rx_errors": 0,
        "tx_errors": 0,
        "rx_mbuf_allocation_errors": 0,
        "rx_q0_packets": 0,
        ...
    }
}

Signed-off-by: Chengwen Feng <fengchengwen@huawei.com>

---
v2: fix typo of output.

---
 usertools/dpdk-telemetry.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/usertools/dpdk-telemetry.py b/usertools/dpdk-telemetry.py
index a81868a547..315f78fb8f 100755
--- a/usertools/dpdk-telemetry.py
+++ b/usertools/dpdk-telemetry.py
@@ -33,7 +33,7 @@ def read_socket(sock, buf_len, echo=True):
         sock.close()
         raise
     if echo:
-        print(json.dumps(ret))
+        print(json.dumps(ret, indent=4))
     return ret
 
 
-- 
2.17.1

Re: [PATCH v2] usertools: telemetry json support pretty print

[David Marchand]

On Fri, Oct 14, 2022 at 5:31 AM Chengwen Feng <fengchengwen@huawei.com> wrote:
>
> Currently, the dpdk-telemetry.py show json in raw format, which is not
> good for human reading.
>
> E.g. The command '/ethdev/xstats,0' will output:
> {"/ethdev/xstats": {"rx_good_packets": 0, "tx_good_packets": 0,
> "rx_good_bytes": 0, "tx_good_bytes": 0, "rx_missed_errors": 0,
> "rx_errors": 0, "tx_errors": 0, "rx_mbuf_allocation_errors": 0,
> "rx_q0_packets": 0,...}}
>
> This patch supports json pretty print by adding extra indent=4
> parameter, so the same command will output:
> {
>     "/ethdev/xstats": {
>         "rx_good_packets": 0,
>         "tx_good_packets": 0,
>         "rx_good_bytes": 0,
>         "tx_good_bytes": 0,
>         "rx_missed_errors": 0,
>         "rx_errors": 0,
>         "tx_errors": 0,
>         "rx_mbuf_allocation_errors": 0,
>         "rx_q0_packets": 0,
>         ...
>     }
> }
>
> Signed-off-by: Chengwen Feng <fengchengwen@huawei.com>

It's indeed easier to read, but maybe 4 chars is too much.
2 chars seem enough to me.

In any case I like the idea:
Acked-by: David Marchand <david.marchand@redhat.com>


-- 
David Marchand

RE: [PATCH v2] usertools: telemetry json support pretty print

[Power, Ciara]

Hi Chengwen,

> -----Original Message-----
> From: David Marchand <david.marchand@redhat.com>
> Sent: Friday 14 October 2022 10:50
> To: Chengwen Feng <fengchengwen@huawei.com>
> Cc: thomas@monjalon.net; dev@dpdk.org; Power, Ciara
> <ciara.power@intel.com>
> Subject: Re: [PATCH v2] usertools: telemetry json support pretty print
> 
> On Fri, Oct 14, 2022 at 5:31 AM Chengwen Feng <fengchengwen@huawei.com>
> wrote:
> >
> > Currently, the dpdk-telemetry.py show json in raw format, which is not
> > good for human reading.
> >
> > E.g. The command '/ethdev/xstats,0' will output:
> > {"/ethdev/xstats": {"rx_good_packets": 0, "tx_good_packets": 0,
> > "rx_good_bytes": 0, "tx_good_bytes": 0, "rx_missed_errors": 0,
> > "rx_errors": 0, "tx_errors": 0, "rx_mbuf_allocation_errors": 0,
> > "rx_q0_packets": 0,...}}
> >
> > This patch supports json pretty print by adding extra indent=4
> > parameter, so the same command will output:
> > {
> >     "/ethdev/xstats": {
> >         "rx_good_packets": 0,
> >         "tx_good_packets": 0,
> >         "rx_good_bytes": 0,
> >         "tx_good_bytes": 0,
> >         "rx_missed_errors": 0,
> >         "rx_errors": 0,
> >         "tx_errors": 0,
> >         "rx_mbuf_allocation_errors": 0,
> >         "rx_q0_packets": 0,
> >         ...
> >     }
> > }
> >
> > Signed-off-by: Chengwen Feng <fengchengwen@huawei.com>
> 
> It's indeed easier to read, but maybe 4 chars is too much.
> 2 chars seem enough to me.
[CP] 
+1 on using 2 chars

> 
> In any case I like the idea:
> Acked-by: David Marchand <david.marchand@redhat.com>
 
Acked-by: Ciara Power <ciara.power@intel.com>

Re: [PATCH v2] usertools: telemetry json support pretty print

[Bruce Richardson]

On Fri, Oct 14, 2022 at 12:44:33PM +0000, Power, Ciara wrote:
> Hi Chengwen,
> 
> > -----Original Message-----
> > From: David Marchand <david.marchand@redhat.com>
> > Sent: Friday 14 October 2022 10:50
> > To: Chengwen Feng <fengchengwen@huawei.com>
> > Cc: thomas@monjalon.net; dev@dpdk.org; Power, Ciara
> > <ciara.power@intel.com>
> > Subject: Re: [PATCH v2] usertools: telemetry json support pretty print
> > 
> > On Fri, Oct 14, 2022 at 5:31 AM Chengwen Feng <fengchengwen@huawei.com>
> > wrote:
> > >
> > > Currently, the dpdk-telemetry.py show json in raw format, which is not
> > > good for human reading.
> > >
> > > E.g. The command '/ethdev/xstats,0' will output:
> > > {"/ethdev/xstats": {"rx_good_packets": 0, "tx_good_packets": 0,
> > > "rx_good_bytes": 0, "tx_good_bytes": 0, "rx_missed_errors": 0,
> > > "rx_errors": 0, "tx_errors": 0, "rx_mbuf_allocation_errors": 0,
> > > "rx_q0_packets": 0,...}}
> > >
> > > This patch supports json pretty print by adding extra indent=4
> > > parameter, so the same command will output:
> > > {
> > >     "/ethdev/xstats": {
> > >         "rx_good_packets": 0,
> > >         "tx_good_packets": 0,
> > >         "rx_good_bytes": 0,
> > >         "tx_good_bytes": 0,
> > >         "rx_missed_errors": 0,
> > >         "rx_errors": 0,
> > >         "tx_errors": 0,
> > >         "rx_mbuf_allocation_errors": 0,
> > >         "rx_q0_packets": 0,
> > >         ...
> > >     }
> > > }
> > >
> > > Signed-off-by: Chengwen Feng <fengchengwen@huawei.com>
> > 
> > It's indeed easier to read, but maybe 4 chars is too much.
> > 2 chars seem enough to me.
> [CP] 
> +1 on using 2 chars
> 
> > 
> > In any case I like the idea:

I like it too, for interactive use. However, we also have some hooks in the
code for when the app is being run non-interactively i.e. from a script. In
that case, we probably want the indent to be unused.

The function "handle_socket()" tracks if the output is a tty via the "prompt"
variable. That could be passed through to the "read_socket()" call to
optionally not-indent the output.

/Bruce

Re: [PATCH v2] usertools: telemetry json support pretty print

[Stephen Hemminger]

On Fri, 14 Oct 2022 14:02:10 +0100
Bruce Richardson <bruce.richardson@intel.com> wrote:

> On Fri, Oct 14, 2022 at 12:44:33PM +0000, Power, Ciara wrote:
> > Hi Chengwen,
> >   
> > > -----Original Message-----
> > > From: David Marchand <david.marchand@redhat.com>
> > > Sent: Friday 14 October 2022 10:50
> > > To: Chengwen Feng <fengchengwen@huawei.com>
> > > Cc: thomas@monjalon.net; dev@dpdk.org; Power, Ciara
> > > <ciara.power@intel.com>
> > > Subject: Re: [PATCH v2] usertools: telemetry json support pretty print
> > > 
> > > On Fri, Oct 14, 2022 at 5:31 AM Chengwen Feng <fengchengwen@huawei.com>
> > > wrote:  
> > > >
> > > > Currently, the dpdk-telemetry.py show json in raw format, which is not
> > > > good for human reading.
> > > >
> > > > E.g. The command '/ethdev/xstats,0' will output:
> > > > {"/ethdev/xstats": {"rx_good_packets": 0, "tx_good_packets": 0,
> > > > "rx_good_bytes": 0, "tx_good_bytes": 0, "rx_missed_errors": 0,
> > > > "rx_errors": 0, "tx_errors": 0, "rx_mbuf_allocation_errors": 0,
> > > > "rx_q0_packets": 0,...}}
> > > >
> > > > This patch supports json pretty print by adding extra indent=4
> > > > parameter, so the same command will output:
> > > > {
> > > >     "/ethdev/xstats": {
> > > >         "rx_good_packets": 0,
> > > >         "tx_good_packets": 0,
> > > >         "rx_good_bytes": 0,
> > > >         "tx_good_bytes": 0,
> > > >         "rx_missed_errors": 0,
> > > >         "rx_errors": 0,
> > > >         "tx_errors": 0,
> > > >         "rx_mbuf_allocation_errors": 0,
> > > >         "rx_q0_packets": 0,
> > > >         ...
> > > >     }
> > > > }
> > > >
> > > > Signed-off-by: Chengwen Feng <fengchengwen@huawei.com>  
> > > 
> > > It's indeed easier to read, but maybe 4 chars is too much.
> > > 2 chars seem enough to me.  
> > [CP] 
> > +1 on using 2 chars
> >   
> > > 
> > > In any case I like the idea:  
> 
> I like it too, for interactive use. However, we also have some hooks in the
> code for when the app is being run non-interactively i.e. from a script. In
> that case, we probably want the indent to be unused.
> 
> The function "handle_socket()" tracks if the output is a tty via the "prompt"
> variable. That could be passed through to the "read_socket()" call to
> optionally not-indent the output.
> 
> /Bruce

Convention in other tools is a -p flag for "pretty output"

Re: [PATCH v2] usertools: telemetry json support pretty print

[Bruce Richardson]

On Fri, Oct 14, 2022 at 08:01:11AM -0700, Stephen Hemminger wrote:
> On Fri, 14 Oct 2022 14:02:10 +0100
> Bruce Richardson <bruce.richardson@intel.com> wrote:
> 
> > On Fri, Oct 14, 2022 at 12:44:33PM +0000, Power, Ciara wrote:
> > > Hi Chengwen,
> > >   
> > > > -----Original Message-----
> > > > From: David Marchand <david.marchand@redhat.com>
> > > > Sent: Friday 14 October 2022 10:50
> > > > To: Chengwen Feng <fengchengwen@huawei.com>
> > > > Cc: thomas@monjalon.net; dev@dpdk.org; Power, Ciara
> > > > <ciara.power@intel.com>
> > > > Subject: Re: [PATCH v2] usertools: telemetry json support pretty print
> > > > 
> > > > On Fri, Oct 14, 2022 at 5:31 AM Chengwen Feng <fengchengwen@huawei.com>
> > > > wrote:  
> > > > >
> > > > > Currently, the dpdk-telemetry.py show json in raw format, which is not
> > > > > good for human reading.
> > > > >
> > > > > E.g. The command '/ethdev/xstats,0' will output:
> > > > > {"/ethdev/xstats": {"rx_good_packets": 0, "tx_good_packets": 0,
> > > > > "rx_good_bytes": 0, "tx_good_bytes": 0, "rx_missed_errors": 0,
> > > > > "rx_errors": 0, "tx_errors": 0, "rx_mbuf_allocation_errors": 0,
> > > > > "rx_q0_packets": 0,...}}
> > > > >
> > > > > This patch supports json pretty print by adding extra indent=4
> > > > > parameter, so the same command will output:
> > > > > {
> > > > >     "/ethdev/xstats": {
> > > > >         "rx_good_packets": 0,
> > > > >         "tx_good_packets": 0,
> > > > >         "rx_good_bytes": 0,
> > > > >         "tx_good_bytes": 0,
> > > > >         "rx_missed_errors": 0,
> > > > >         "rx_errors": 0,
> > > > >         "tx_errors": 0,
> > > > >         "rx_mbuf_allocation_errors": 0,
> > > > >         "rx_q0_packets": 0,
> > > > >         ...
> > > > >     }
> > > > > }
> > > > >
> > > > > Signed-off-by: Chengwen Feng <fengchengwen@huawei.com>  
> > > > 
> > > > It's indeed easier to read, but maybe 4 chars is too much.
> > > > 2 chars seem enough to me.  
> > > [CP] 
> > > +1 on using 2 chars
> > >   
> > > > 
> > > > In any case I like the idea:  
> > 
> > I like it too, for interactive use. However, we also have some hooks in the
> > code for when the app is being run non-interactively i.e. from a script. In
> > that case, we probably want the indent to be unused.
> > 
> > The function "handle_socket()" tracks if the output is a tty via the "prompt"
> > variable. That could be passed through to the "read_socket()" call to
> > optionally not-indent the output.
> > 
> > /Bruce
> 
> Convention in other tools is a -p flag for "pretty output"

Since we already support detecting interactive use, I think having the
pretty output by default in that case is probably good. For non-interactive
use a -p flag might make sense, but even then I'm not sure it's hugely
worthwhile.

/Bruce

RE: [PATCH v2] usertools: telemetry json support pretty print

[Morten Brørup]

> From: Bruce Richardson [mailto:bruce.richardson@intel.com]
> Sent: Friday, 14 October 2022 17.30
> 
> On Fri, Oct 14, 2022 at 08:01:11AM -0700, Stephen Hemminger wrote:
> > On Fri, 14 Oct 2022 14:02:10 +0100
> > Bruce Richardson <bruce.richardson@intel.com> wrote:
> >
> > > On Fri, Oct 14, 2022 at 12:44:33PM +0000, Power, Ciara wrote:
> > > > Hi Chengwen,
> > > >
> > > > > -----Original Message-----
> > > > > From: David Marchand <david.marchand@redhat.com>
> > > > > Sent: Friday 14 October 2022 10:50
> > > > > To: Chengwen Feng <fengchengwen@huawei.com>
> > > > > Cc: thomas@monjalon.net; dev@dpdk.org; Power, Ciara
> > > > > <ciara.power@intel.com>
> > > > > Subject: Re: [PATCH v2] usertools: telemetry json support
> pretty print
> > > > >
> > > > > On Fri, Oct 14, 2022 at 5:31 AM Chengwen Feng
> <fengchengwen@huawei.com>
> > > > > wrote:
> > > > > >
> > > > > > Currently, the dpdk-telemetry.py show json in raw format,
> which is not
> > > > > > good for human reading.
> > > > > >
> > > > > > E.g. The command '/ethdev/xstats,0' will output:
> > > > > > {"/ethdev/xstats": {"rx_good_packets": 0, "tx_good_packets":
> 0,
> > > > > > "rx_good_bytes": 0, "tx_good_bytes": 0, "rx_missed_errors":
> 0,
> > > > > > "rx_errors": 0, "tx_errors": 0, "rx_mbuf_allocation_errors":
> 0,
> > > > > > "rx_q0_packets": 0,...}}
> > > > > >
> > > > > > This patch supports json pretty print by adding extra
> indent=4
> > > > > > parameter, so the same command will output:
> > > > > > {
> > > > > >     "/ethdev/xstats": {
> > > > > >         "rx_good_packets": 0,
> > > > > >         "tx_good_packets": 0,
> > > > > >         "rx_good_bytes": 0,
> > > > > >         "tx_good_bytes": 0,
> > > > > >         "rx_missed_errors": 0,
> > > > > >         "rx_errors": 0,
> > > > > >         "tx_errors": 0,
> > > > > >         "rx_mbuf_allocation_errors": 0,
> > > > > >         "rx_q0_packets": 0,
> > > > > >         ...
> > > > > >     }
> > > > > > }
> > > > > >
> > > > > > Signed-off-by: Chengwen Feng <fengchengwen@huawei.com>
> > > > >
> > > > > It's indeed easier to read, but maybe 4 chars is too much.
> > > > > 2 chars seem enough to me.
> > > > [CP]
> > > > +1 on using 2 chars

+1 to 2 spaces, following the convention of the rte_<lib>_dump() functions in DPDK.

> > > >
> > > > >
> > > > > In any case I like the idea:
> > >
> > > I like it too, for interactive use. However, we also have some
> hooks in the
> > > code for when the app is being run non-interactively i.e. from a
> script. In
> > > that case, we probably want the indent to be unused.
> > >
> > > The function "handle_socket()" tracks if the output is a tty via
> the "prompt"
> > > variable. That could be passed through to the "read_socket()" call
> to
> > > optionally not-indent the output.
> > >
> > > /Bruce
> >
> > Convention in other tools is a -p flag for "pretty output"
> 
> Since we already support detecting interactive use, I think having the
> pretty output by default in that case is probably good.

+1 to pretty by default.

> For non-
> interactive
> use a -p flag might make sense, but even then I'm not sure it's hugely
> worthwhile.

+1 to Bruce's comment about not being worthwhile. And we would need the inverse of -p. :-)

Closely related:

If we agree that the JSON output is either for human or machine consumption, why don't we give JANSSON the JSON_COMPACT flag to save some spaces?

Re: [PATCH v2] usertools: telemetry json support pretty print

[fengchengwen]

Hi all,

On 2022/10/15 0:10, Morten Brørup wrote:
>> From: Bruce Richardson [mailto:bruce.richardson@intel.com]
>> Sent: Friday, 14 October 2022 17.30
>>
>> On Fri, Oct 14, 2022 at 08:01:11AM -0700, Stephen Hemminger wrote:
>>> On Fri, 14 Oct 2022 14:02:10 +0100
>>> Bruce Richardson <bruce.richardson@intel.com> wrote:
>>>
>>>> On Fri, Oct 14, 2022 at 12:44:33PM +0000, Power, Ciara wrote:
>>>>> Hi Chengwen,
>>>>>
>>>>>> -----Original Message-----
>>>>>> From: David Marchand <david.marchand@redhat.com>
>>>>>> Sent: Friday 14 October 2022 10:50
>>>>>> To: Chengwen Feng <fengchengwen@huawei.com>
>>>>>> Cc: thomas@monjalon.net; dev@dpdk.org; Power, Ciara
>>>>>> <ciara.power@intel.com>
>>>>>> Subject: Re: [PATCH v2] usertools: telemetry json support
>> pretty print
>>>>>>
>>>>>> On Fri, Oct 14, 2022 at 5:31 AM Chengwen Feng
>> <fengchengwen@huawei.com>
>>>>>> wrote:
>>>>>>>
>>>>>>> Currently, the dpdk-telemetry.py show json in raw format,
>> which is not
>>>>>>> good for human reading.
>>>>>>>
>>>>>>> E.g. The command '/ethdev/xstats,0' will output:
>>>>>>> {"/ethdev/xstats": {"rx_good_packets": 0, "tx_good_packets":
>> 0,
>>>>>>> "rx_good_bytes": 0, "tx_good_bytes": 0, "rx_missed_errors":
>> 0,
>>>>>>> "rx_errors": 0, "tx_errors": 0, "rx_mbuf_allocation_errors":
>> 0,
>>>>>>> "rx_q0_packets": 0,...}}
>>>>>>>
>>>>>>> This patch supports json pretty print by adding extra
>> indent=4
>>>>>>> parameter, so the same command will output:
>>>>>>> {
>>>>>>>     "/ethdev/xstats": {
>>>>>>>         "rx_good_packets": 0,
>>>>>>>         "tx_good_packets": 0,
>>>>>>>         "rx_good_bytes": 0,
>>>>>>>         "tx_good_bytes": 0,
>>>>>>>         "rx_missed_errors": 0,
>>>>>>>         "rx_errors": 0,
>>>>>>>         "tx_errors": 0,
>>>>>>>         "rx_mbuf_allocation_errors": 0,
>>>>>>>         "rx_q0_packets": 0,
>>>>>>>         ...
>>>>>>>     }
>>>>>>> }
>>>>>>>
>>>>>>> Signed-off-by: Chengwen Feng <fengchengwen@huawei.com>
>>>>>>
>>>>>> It's indeed easier to read, but maybe 4 chars is too much.
>>>>>> 2 chars seem enough to me.
>>>>> [CP]
>>>>> +1 on using 2 chars
> 
> +1 to 2 spaces, following the convention of the rte_<lib>_dump() functions in DPDK.

Already fix in v3.

> 
>>>>>
>>>>>>
>>>>>> In any case I like the idea:
>>>>
>>>> I like it too, for interactive use. However, we also have some
>> hooks in the
>>>> code for when the app is being run non-interactively i.e. from a
>> script. In
>>>> that case, we probably want the indent to be unused.
>>>>
>>>> The function "handle_socket()" tracks if the output is a tty via
>> the "prompt"
>>>> variable. That could be passed through to the "read_socket()" call
>> to
>>>> optionally not-indent the output.

The v3 support indent only under interactive mode.

>>>>
>>>> /Bruce
>>>
>>> Convention in other tools is a -p flag for "pretty output"
>>
>> Since we already support detecting interactive use, I think having the
>> pretty output by default in that case is probably good.
> 
> +1 to pretty by default.
> 
>> For non-
>> interactive
>> use a -p flag might make sense, but even then I'm not sure it's hugely
>> worthwhile.
> 
> +1 to Bruce's comment about not being worthwhile. And we would need the inverse of -p. :-)

+1 for not being worthwhile.

> 
> Closely related:
> 
> If we agree that the JSON output is either for human or machine consumption, why don't we give JANSSON the JSON_COMPACT flag to save some spaces?
> 
> 
> .
> 

[PATCH v3] usertools: telemetry pretty print in interactive mode

[Chengwen Feng]

Currently, the dpdk-telemetry.py show json in raw format under
interactive mode, which is not good for human reading.

E.g. The command '/ethdev/xstats,0' will output:
{"/ethdev/xstats": {"rx_good_packets": 0, "tx_good_packets": 0,
"rx_good_bytes": 0, "tx_good_bytes": 0, "rx_missed_errors": 0,
"rx_errors": 0, "tx_errors": 0, "rx_mbuf_allocation_errors": 0,
"rx_q0_packets": 0,...}}

This patch supports json pretty print by adding extra indent=2
parameter under interactive mode, so the same command will output:
{
  "/ethdev/xstats": {
    "rx_good_packets": 0,
    "tx_good_packets": 0,
    "rx_good_bytes": 0,
    "tx_good_bytes": 0,
    "rx_missed_errors": 0,
    "rx_errors": 0,
    "rx_mbuf_allocation_errors": 0,
    "rx_q0_packets": 0,
    ...
  }
}

Note: the non-interactive mode is made machine-readable and remains the
original way (it means don't use indent to pretty print).

Signed-off-by: Chengwen Feng <fengchengwen@huawei.com>
Acked-by: David Marchand <david.marchand@redhat.com>
Acked-by: Ciara Power <ciara.power@intel.com>

---
v3: indent modify to 2 and make sure indent under interactive mode
according comments.
v2: fix typo of output.

---
 usertools/dpdk-telemetry.py | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/usertools/dpdk-telemetry.py b/usertools/dpdk-telemetry.py
index a81868a547..568f222a03 100755
--- a/usertools/dpdk-telemetry.py
+++ b/usertools/dpdk-telemetry.py
@@ -23,7 +23,7 @@
 CMDS = []
 
 
-def read_socket(sock, buf_len, echo=True):
+def read_socket(sock, buf_len, echo=True, pretty=False):
     """ Read data from socket and return it in JSON format """
     reply = sock.recv(buf_len).decode()
     try:
@@ -33,7 +33,8 @@ def read_socket(sock, buf_len, echo=True):
         sock.close()
         raise
     if echo:
-        print(json.dumps(ret))
+        indent = 2 if pretty else None
+        print(json.dumps(ret, indent=indent))
     return ret
 
 
@@ -127,7 +128,7 @@ def handle_socket(args, path):
         else:
             list_fp()
         return
-    json_reply = read_socket(sock, 1024, prompt)
+    json_reply = read_socket(sock, 1024, prompt, prompt)
     output_buf_len = json_reply["max_output_len"]
     app_name = get_app_name(json_reply["pid"])
     if app_name and prompt:
@@ -143,7 +144,7 @@ def handle_socket(args, path):
         while text != "quit":
             if text.startswith('/'):
                 sock.send(text.encode())
-                read_socket(sock, output_buf_len)
+                read_socket(sock, output_buf_len, pretty=prompt)
             text = input(prompt).strip()
     except EOFError:
         pass
-- 
2.17.1

Re: [PATCH v3] usertools: telemetry pretty print in interactive mode

[Bruce Richardson]

On Mon, Oct 17, 2022 at 07:41:02AM +0000, Chengwen Feng wrote:
> Currently, the dpdk-telemetry.py show json in raw format under
> interactive mode, which is not good for human reading.
> 
> E.g. The command '/ethdev/xstats,0' will output:
> {"/ethdev/xstats": {"rx_good_packets": 0, "tx_good_packets": 0,
> "rx_good_bytes": 0, "tx_good_bytes": 0, "rx_missed_errors": 0,
> "rx_errors": 0, "tx_errors": 0, "rx_mbuf_allocation_errors": 0,
> "rx_q0_packets": 0,...}}
> 
> This patch supports json pretty print by adding extra indent=2
> parameter under interactive mode, so the same command will output:
> {
>   "/ethdev/xstats": {
>     "rx_good_packets": 0,
>     "tx_good_packets": 0,
>     "rx_good_bytes": 0,
>     "tx_good_bytes": 0,
>     "rx_missed_errors": 0,
>     "rx_errors": 0,
>     "rx_mbuf_allocation_errors": 0,
>     "rx_q0_packets": 0,
>     ...
>   }
> }
> 
> Note: the non-interactive mode is made machine-readable and remains the
> original way (it means don't use indent to pretty print).
> 
> Signed-off-by: Chengwen Feng <fengchengwen@huawei.com>
> Acked-by: David Marchand <david.marchand@redhat.com>
> Acked-by: Ciara Power <ciara.power@intel.com>
> 
Tested-by: Bruce Richardson <bruce.richardson@intel.com>

Re: [PATCH v3] usertools: telemetry pretty print in interactive mode

[Thomas Monjalon]

17/10/2022 11:15, Bruce Richardson:
> On Mon, Oct 17, 2022 at 07:41:02AM +0000, Chengwen Feng wrote:
> > Currently, the dpdk-telemetry.py show json in raw format under
> > interactive mode, which is not good for human reading.
> > 
> > E.g. The command '/ethdev/xstats,0' will output:
> > {"/ethdev/xstats": {"rx_good_packets": 0, "tx_good_packets": 0,
> > "rx_good_bytes": 0, "tx_good_bytes": 0, "rx_missed_errors": 0,
> > "rx_errors": 0, "tx_errors": 0, "rx_mbuf_allocation_errors": 0,
> > "rx_q0_packets": 0,...}}
> > 
> > This patch supports json pretty print by adding extra indent=2
> > parameter under interactive mode, so the same command will output:
> > {
> >   "/ethdev/xstats": {
> >     "rx_good_packets": 0,
> >     "tx_good_packets": 0,
> >     "rx_good_bytes": 0,
> >     "tx_good_bytes": 0,
> >     "rx_missed_errors": 0,
> >     "rx_errors": 0,
> >     "rx_mbuf_allocation_errors": 0,
> >     "rx_q0_packets": 0,
> >     ...
> >   }
> > }
> > 
> > Note: the non-interactive mode is made machine-readable and remains the
> > original way (it means don't use indent to pretty print).
> > 
> > Signed-off-by: Chengwen Feng <fengchengwen@huawei.com>
> > Acked-by: David Marchand <david.marchand@redhat.com>
> > Acked-by: Ciara Power <ciara.power@intel.com>
> > 
> Tested-by: Bruce Richardson <bruce.richardson@intel.com>

Applied, thanks.