Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/7298/?format=api
{ "id": 7298, "url": "https://patches.dpdk.org/api/patches/7298/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/patch/1443606022-13581-3-git-send-email-harry.van.haaren@intel.com/", "project": { "id": 1, "url": "https://patches.dpdk.org/api/projects/1/?format=api", "name": "DPDK", "link_name": "dpdk", "list_id": "dev.dpdk.org", "list_email": "dev@dpdk.org", "web_url": "http://core.dpdk.org", "scm_url": "git://dpdk.org/dpdk", "webscm_url": "http://git.dpdk.org/dpdk", "list_archive_url": "https://inbox.dpdk.org/dev", "list_archive_url_format": "https://inbox.dpdk.org/dev/{}", "commit_url_format": "" }, "msgid": "<1443606022-13581-3-git-send-email-harry.van.haaren@intel.com>", "list_archive_url": "https://inbox.dpdk.org/dev/1443606022-13581-3-git-send-email-harry.van.haaren@intel.com", "date": "2015-09-30T09:40:13", "name": "[dpdk-dev,v2,02/11] doc: add extended statistics to prog_guide", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": true, "hash": "4bea43f43dc72d9b11967bdfacb6420cf280c028", "submitter": { "id": 317, "url": "https://patches.dpdk.org/api/people/317/?format=api", "name": "Van Haaren, Harry", "email": "harry.van.haaren@intel.com" }, "delegate": null, "mbox": "https://patches.dpdk.org/project/dpdk/patch/1443606022-13581-3-git-send-email-harry.van.haaren@intel.com/mbox/", "series": [], "comments": "https://patches.dpdk.org/api/patches/7298/comments/", "check": "pending", "checks": "https://patches.dpdk.org/api/patches/7298/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@dpdk.org", "Delivered-To": "patchwork@dpdk.org", "Received": [ "from [92.243.14.124] (localhost [IPv6:::1])\n\tby dpdk.org (Postfix) with ESMTP id EA0FA8DB2;\n\tWed, 30 Sep 2015 11:40:55 +0200 (CEST)", "from mga11.intel.com (mga11.intel.com [192.55.52.93])\n\tby dpdk.org (Postfix) with ESMTP id AE4878D36\n\tfor <dev@dpdk.org>; Wed, 30 Sep 2015 11:40:53 +0200 (CEST)", "from fmsmga003.fm.intel.com ([10.253.24.29])\n\tby fmsmga102.fm.intel.com with ESMTP; 30 Sep 2015 02:40:52 -0700", "from sie-lab-212-222.ir.intel.com (HELO\n\tsilpixa00366884.ir.intel.com) ([10.237.212.222])\n\tby FMSMGA003.fm.intel.com with ESMTP; 30 Sep 2015 02:40:51 -0700" ], "X-ExtLoop1": "1", "X-IronPort-AV": "E=Sophos;i=\"5.17,611,1437462000\"; d=\"scan'208\";a=\"571197919\"", "From": "Harry van Haaren <harry.van.haaren@intel.com>", "To": "dev@dpdk.org", "Date": "Wed, 30 Sep 2015 10:40:13 +0100", "Message-Id": "<1443606022-13581-3-git-send-email-harry.van.haaren@intel.com>", "X-Mailer": "git-send-email 1.9.1", "In-Reply-To": "<1443606022-13581-1-git-send-email-harry.van.haaren@intel.com>", "References": "<1443606022-13581-1-git-send-email-harry.van.haaren@intel.com>", "Subject": "[dpdk-dev] [PATCH v2 02/11] doc: add extended statistics to\n\tprog_guide", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.15", "Precedence": "list", "List-Id": "patches and discussions about DPDK <dev.dpdk.org>", "List-Unsubscribe": "<http://dpdk.org/ml/options/dev>,\n\t<mailto:dev-request@dpdk.org?subject=unsubscribe>", "List-Archive": "<http://dpdk.org/ml/archives/dev/>", "List-Post": "<mailto:dev@dpdk.org>", "List-Help": "<mailto:dev-request@dpdk.org?subject=help>", "List-Subscribe": "<http://dpdk.org/ml/listinfo/dev>,\n\t<mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org", "Sender": "\"dev\" <dev-bounces@dpdk.org>" }, "content": "Add extended statistic section to the programmers\nguide, poll mode driver section. This section describes\nhow the strings stats are formatted, and how the client\ncode can use this to gather information about the stat.\n\nSigned-off-by: Harry van Haaren <harry.van.haaren@intel.com>\n---\n doc/guides/prog_guide/poll_mode_drv.rst | 51 ++++++++++++++++++++++++++++++++-\n 1 file changed, 50 insertions(+), 1 deletion(-)", "diff": "diff --git a/doc/guides/prog_guide/poll_mode_drv.rst b/doc/guides/prog_guide/poll_mode_drv.rst\nindex 8780ba3..44cc9ce 100644\n--- a/doc/guides/prog_guide/poll_mode_drv.rst\n+++ b/doc/guides/prog_guide/poll_mode_drv.rst\n@@ -1,5 +1,5 @@\n .. BSD LICENSE\n- Copyright(c) 2010-2014 Intel Corporation. All rights reserved.\n+ Copyright(c) 2010-2015 Intel Corporation. All rights reserved.\n All rights reserved.\n \n Redistribution and use in source and binary forms, with or without\n@@ -294,3 +294,52 @@ Ethernet Device API\n ~~~~~~~~~~~~~~~~~~~\n \n The Ethernet device API exported by the Ethernet PMDs is described in the *DPDK API Reference*.\n+\n+Extended Statistics API\n+~~~~~~~~~~~~~~~~~~~~~~~\n+\n+The extended statistics API allows each individual PMD to expose a unique set\n+of statistics. The client of the API provides an array of\n+``struct rte_eth_xstats`` type. Each ``struct rte_eth_xstats`` contains a\n+string and value pair. The amount of xstats exposed, and position of the\n+statistic in the array must remain constant during runtime.\n+\n+A naming scheme exists for the strings exposed to clients of the API. This is\n+to allow scraping of the API for statistics of interest. The naming scheme uses\n+strings split by a single underscore ``_``. The scheme is as follows:\n+\n+* direction\n+* detail 1\n+* detail 2\n+* detail n\n+* unit\n+\n+Examples of common statistics xstats strings, formatted to comply to the scheme\n+proposed above:\n+\n+* ``rx_bytes``\n+* ``rx_crc_errors``\n+* ``tx_multicast_packets``\n+\n+The scheme, although quite simple, allows flexibility in presenting and reading\n+information from the statistic strings. The following example illustrates the\n+naming scheme:``rx_packets``. In this example, the string is split into two\n+components. The first component ``rx`` indicates that the statistic is\n+associated with the receive side of the NIC. The second component ``packets``\n+indicates that the unit of measure is packets.\n+\n+A more complicated example: ``tx_size_128_to_255_packets``. In this example,\n+``tx`` indicates transmission, ``size`` is the first detail, ``128`` etc are\n+more details, and ``packets`` indicates that this is a packet counter.\n+\n+Some additions in the metadata scheme are as follows:\n+\n+* If the first part does not match ``rx`` or ``tx``, the statistic does not\n+ have an affinity with either recieve of transmit.\n+\n+* If the first letter of the second part is ``q`` and this ``q`` is followed\n+ by a number, this statistic is part of a specific queue.\n+\n+An example where queue numbers are used is as follows: ``tx_q7_bytes`` which\n+indicates this statistic applies to queue number 7, and represents the number\n+of transmitted bytes on that queue.\n", "prefixes": [ "dpdk-dev", "v2", "02/11" ] }