From: "Tahhan, Maryam" <maryam.tahhan@intel.com>
To: "Van Haaren, Harry" <harry.van.haaren@intel.com>,
"dev@dpdk.org" <dev@dpdk.org>
Subject: Re: [dpdk-dev] [PATCH v3 02/11] doc: add extended statistics to prog_guide
Date: Fri, 23 Oct 2015 14:29:35 +0000 [thread overview]
Message-ID: <1A27633A6DA49C4A92FCD5D4312DBF536A5D9398@IRSMSX109.ger.corp.intel.com> (raw)
In-Reply-To: <1445528914-27636-3-git-send-email-harry.van.haaren@intel.com>
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Harry van Haaren
> Sent: Thursday, October 22, 2015 4:48 PM
> To: dev@dpdk.org
> Subject: [dpdk-dev] [PATCH v3 02/11] doc: add extended statistics to
> prog_guide
>
> Add extended statistic section to the programmers guide, poll mode driver
> section. This section describes how the strings stats are formatted, and how
> the client code can use this to gather information about the stat.
>
> Signed-off-by: Harry van Haaren <harry.van.haaren@intel.com>
> ---
> doc/guides/prog_guide/poll_mode_drv.rst | 51
> ++++++++++++++++++++++++++++++++-
> 1 file changed, 50 insertions(+), 1 deletion(-)
>
> diff --git a/doc/guides/prog_guide/poll_mode_drv.rst
> b/doc/guides/prog_guide/poll_mode_drv.rst
> index 8780ba3..44cc9ce 100644
> --- a/doc/guides/prog_guide/poll_mode_drv.rst
> +++ b/doc/guides/prog_guide/poll_mode_drv.rst
> @@ -1,5 +1,5 @@
> .. BSD LICENSE
> - Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
> + Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
> All rights reserved.
>
> Redistribution and use in source and binary forms, with or without @@ -
> 294,3 +294,52 @@ Ethernet Device API ~~~~~~~~~~~~~~~~~~~
>
> The Ethernet device API exported by the Ethernet PMDs is described in the
> *DPDK API Reference*.
> +
> +Extended Statistics API
> +~~~~~~~~~~~~~~~~~~~~~~~
> +
> +The extended statistics API allows each individual PMD to expose a
> +unique set of statistics. The client of the API provides an array of
> +``struct rte_eth_xstats`` type. Each ``struct rte_eth_xstats`` contains
> +a string and value pair. The amount of xstats exposed, and position of
> +the statistic in the array must remain constant during runtime.
> +
> +A naming scheme exists for the strings exposed to clients of the API.
> +This is to allow scraping of the API for statistics of interest. The
> +naming scheme uses strings split by a single underscore ``_``. The scheme is
> as follows:
> +
> +* direction
> +* detail 1
> +* detail 2
> +* detail n
> +* unit
> +
> +Examples of common statistics xstats strings, formatted to comply to
> +the scheme proposed above:
> +
> +* ``rx_bytes``
> +* ``rx_crc_errors``
> +* ``tx_multicast_packets``
> +
> +The scheme, although quite simple, allows flexibility in presenting and
> +reading information from the statistic strings. The following example
> +illustrates the naming scheme:``rx_packets``. In this example, the
> +string is split into two components. The first component ``rx``
> +indicates that the statistic is associated with the receive side of the
> +NIC. The second component ``packets`` indicates that the unit of measure is
> packets.
> +
> +A more complicated example: ``tx_size_128_to_255_packets``. In this
> +example, ``tx`` indicates transmission, ``size`` is the first detail,
> +``128`` etc are more details, and ``packets`` indicates that this is a packet
> counter.
> +
> +Some additions in the metadata scheme are as follows:
> +
> +* If the first part does not match ``rx`` or ``tx``, the statistic does
> +not
> + have an affinity with either recieve of transmit.
> +
> +* If the first letter of the second part is ``q`` and this ``q`` is
> +followed
> + by a number, this statistic is part of a specific queue.
> +
> +An example where queue numbers are used is as follows: ``tx_q7_bytes``
> +which indicates this statistic applies to queue number 7, and
> +represents the number of transmitted bytes on that queue.
> --
> 1.9.1
Acked-by: Maryam Tahhan <maryam.tahhan@intel.com>
next prev parent reply other threads:[~2015-10-23 14:29 UTC|newest]
Thread overview: 77+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-09-30 9:40 [dpdk-dev] [PATCH v2 00/11] Port XStats Harry van Haaren
2015-09-30 9:40 ` [dpdk-dev] [PATCH v2 01/11] doc: add extended statistics notes Harry van Haaren
2015-10-22 15:48 ` [dpdk-dev] [PATCH v3 00/11] Port XStats Harry van Haaren
2015-10-22 15:48 ` [dpdk-dev] [PATCH v3 01/11] doc: add extended statistics notes Harry van Haaren
2015-10-30 11:36 ` [dpdk-dev] [PATCH v4 00/10] Port XStats Harry van Haaren
2015-10-30 11:36 ` [dpdk-dev] [PATCH v4 01/10] doc: add extended statistics to prog_guide Harry van Haaren
2015-11-02 10:18 ` [dpdk-dev] [PATCH v5 00/10] Port XStats Harry van Haaren
2015-11-02 10:18 ` [dpdk-dev] [PATCH v5 01/10] doc: add extended statistics to prog_guide Harry van Haaren
2015-11-02 10:18 ` [dpdk-dev] [PATCH v5 02/10] ethdev: update xstats_get() strings and Q handling Harry van Haaren
2015-11-02 10:19 ` [dpdk-dev] [PATCH v5 03/10] virtio: add xstats() implementation Harry van Haaren
2015-11-02 10:19 ` [dpdk-dev] [PATCH v5 04/10] igb: " Harry van Haaren
2015-11-02 10:19 ` [dpdk-dev] [PATCH v5 05/10] igbvf: " Harry van Haaren
2015-11-02 10:19 ` [dpdk-dev] [PATCH v5 06/10] ixgbe: add extended statistic strings Harry van Haaren
2015-11-02 22:31 ` Thomas Monjalon
2015-11-02 10:19 ` [dpdk-dev] [PATCH v5 07/10] ixgbevf: add xstats() implementation Harry van Haaren
2015-11-02 10:19 ` [dpdk-dev] [PATCH v5 08/10] i40e: " Harry van Haaren
2015-11-02 10:19 ` [dpdk-dev] [PATCH v5 09/10] i40evf: " Harry van Haaren
2015-11-02 10:19 ` [dpdk-dev] [PATCH v5 10/10] fm10k: " Harry van Haaren
2015-11-02 10:24 ` [dpdk-dev] [PATCH v5 00/10] Port XStats Van Haaren, Harry
2015-11-02 23:23 ` Thomas Monjalon
2015-10-30 11:36 ` [dpdk-dev] [PATCH v4 02/10] ethdev: update xstats_get() strings and Q handling Harry van Haaren
2015-11-02 7:59 ` Thomas Monjalon
2015-11-02 10:17 ` Van Haaren, Harry
2015-11-02 16:23 ` Thomas Monjalon
2015-10-30 11:36 ` [dpdk-dev] [PATCH v4 03/10] virtio: add xstats() implementation Harry van Haaren
2015-10-30 11:36 ` [dpdk-dev] [PATCH v4 04/10] igb: " Harry van Haaren
2015-10-30 11:36 ` [dpdk-dev] [PATCH v4 05/10] igbvf: " Harry van Haaren
2015-10-30 11:36 ` [dpdk-dev] [PATCH v4 06/10] ixgbe: add extended statistic strings Harry van Haaren
2015-10-30 11:36 ` [dpdk-dev] [PATCH v4 07/10] ixgbevf: add xstats() implementation Harry van Haaren
2015-10-30 11:36 ` [dpdk-dev] [PATCH v4 08/10] i40e: " Harry van Haaren
2015-10-30 11:36 ` [dpdk-dev] [PATCH v4 09/10] i40evf: " Harry van Haaren
2015-10-30 11:36 ` [dpdk-dev] [PATCH v4 10/10] fm10k: " Harry van Haaren
2015-10-30 13:21 ` [dpdk-dev] [PATCH v4 00/10] Port XStats Tahhan, Maryam
2015-11-02 8:04 ` Thomas Monjalon
2015-10-22 15:48 ` [dpdk-dev] [PATCH v3 02/11] doc: add extended statistics to prog_guide Harry van Haaren
2015-10-23 14:29 ` Tahhan, Maryam [this message]
2015-10-22 15:48 ` [dpdk-dev] [PATCH v3 03/11] ethdev: update xstats_get() strings and Q handling Harry van Haaren
2015-10-23 14:35 ` Tahhan, Maryam
2015-10-23 15:28 ` Tahhan, Maryam
2015-10-23 15:28 ` Tahhan, Maryam
2015-10-22 15:48 ` [dpdk-dev] [PATCH v3 04/11] virtio: add xstats() implementation Harry van Haaren
2015-10-29 16:19 ` Tahhan, Maryam
2015-10-22 15:48 ` [dpdk-dev] [PATCH v3 05/11] igb: " Harry van Haaren
2015-10-23 14:56 ` Tahhan, Maryam
2015-10-22 15:48 ` [dpdk-dev] [PATCH v3 06/11] igbvf: " Harry van Haaren
2015-10-28 12:17 ` Tahhan, Maryam
2015-10-22 15:48 ` [dpdk-dev] [PATCH v3 07/11] ixgbe: update statistic strings to scheme Harry van Haaren
2015-10-23 14:41 ` Tahhan, Maryam
2015-10-22 15:48 ` [dpdk-dev] [PATCH v3 08/11] ixgbevf: add xstats() functions to VF Harry van Haaren
2015-10-28 12:16 ` Tahhan, Maryam
2015-10-22 15:48 ` [dpdk-dev] [PATCH v3 09/11] i40e: add xstats() implementation Harry van Haaren
2015-10-23 15:11 ` Tahhan, Maryam
2015-10-22 15:48 ` [dpdk-dev] [PATCH v3 10/11] i40evf: " Harry van Haaren
2015-10-28 12:15 ` Tahhan, Maryam
2015-10-22 15:48 ` [dpdk-dev] [PATCH v3 11/11] fm10k: " Harry van Haaren
2015-10-29 16:41 ` Tahhan, Maryam
2015-10-28 17:35 ` [dpdk-dev] [PATCH v3 00/11] Port XStats Tom Crugnale
2015-10-28 21:32 ` Stephen Hemminger
2015-10-29 0:55 ` Tom Crugnale
2015-10-29 12:55 ` Kyle Larose
2015-10-29 13:10 ` Thomas Monjalon
2015-10-29 13:57 ` Kyle Larose
2015-10-29 14:01 ` Thomas Monjalon
2015-10-29 14:10 ` Kyle Larose
2015-10-29 13:17 ` Van Haaren, Harry
2015-09-30 9:40 ` [dpdk-dev] [PATCH v2 02/11] doc: add extended statistics to prog_guide Harry van Haaren
2015-09-30 9:40 ` [dpdk-dev] [PATCH v2 03/11] ethdev: update xstats_get() strings and Q handling Harry van Haaren
2015-09-30 9:40 ` [dpdk-dev] [PATCH v2 04/11] virtio: add xstats() implementation Harry van Haaren
2015-09-30 17:44 ` Stephen Hemminger
2015-10-01 8:00 ` Van Haaren, Harry
2015-09-30 9:40 ` [dpdk-dev] [PATCH v2 05/11] igb: " Harry van Haaren
2015-09-30 9:40 ` [dpdk-dev] [PATCH v2 06/11] igbvf: " Harry van Haaren
2015-09-30 9:40 ` [dpdk-dev] [PATCH v2 07/11] ixgbe: update statistic strings to scheme Harry van Haaren
2015-09-30 9:40 ` [dpdk-dev] [PATCH v2 08/11] ixgbevf: add xstats() functions to VF Harry van Haaren
2015-09-30 9:40 ` [dpdk-dev] [PATCH v2 09/11] i40e: add xstats() implementation Harry van Haaren
2015-09-30 9:40 ` [dpdk-dev] [PATCH v2 10/11] i40evf: " Harry van Haaren
2015-09-30 9:40 ` [dpdk-dev] [PATCH v2 11/11] fm10k: " Harry van Haaren
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1A27633A6DA49C4A92FCD5D4312DBF536A5D9398@IRSMSX109.ger.corp.intel.com \
--to=maryam.tahhan@intel.com \
--cc=dev@dpdk.org \
--cc=harry.van.haaren@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).