From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <vipin.varghese@intel.com>
Received: from mga11.intel.com (mga11.intel.com [192.55.52.93])
 by dpdk.org (Postfix) with ESMTP id 2E1DA10A3
 for <dev@dpdk.org>; Wed, 16 Jan 2019 09:58:03 +0100 (CET)
X-Amp-Result: SKIPPED(no attachment in message)
X-Amp-File-Uploaded: False
Received: from orsmga006.jf.intel.com ([10.7.209.51])
 by fmsmga102.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384;
 16 Jan 2019 00:58:02 -0800
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.56,485,1539673200"; d="scan'208";a="108640111"
Received: from unknown (HELO saesrv02-S2600CWR.intel.com) ([10.224.122.203])
 by orsmga006.jf.intel.com with ESMTP; 16 Jan 2019 00:57:59 -0800
From: Vipin Varghese <vipin.varghese@intel.com>
To: dev@dpdk.org,
	shreyansh.jain@nxp.com,
	thomas@monjalon.net
Cc: john.mcnamara@intel.com, marko.kovacevic@intel.com, amol.patel@intel.com,
 sanjay.padubidri@intel.com, Vipin Varghese <vipin.varghese@intel.com>
Date: Wed, 16 Jan 2019 20:24:50 +0530
Message-Id: <20190116145452.53835-1-vipin.varghese@intel.com>
X-Mailer: git-send-email 2.17.1
In-Reply-To: <20181126070815.37501-2-vipin.varghese@intel.com>
References: <20181126070815.37501-2-vipin.varghese@intel.com>
Subject: [dpdk-dev] [PATCH v4 0/2] doci/howto: add debug and troubleshoot
	guide
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Wed, 16 Jan 2019 08:58:03 -0000

This patch series is an attempt to add how to guide for commonly seen
issues in various application scenario. It also tries to suggest a step
by step guide on how to debug and troubleshoot with available stats and
counters.

Motivation
==========

DPDK allows to build application on top of custom off the shelf
components for user scenarios that are modeled with single or multi stage.
Each module interacts with PMD or rings with either software or hardware
offloads. 

Identify the cause of issue or performance issues will be tedious and timie
consuming. The how to guide is an effort to consolidate such scenarios with
step by step focus to debug and troubleshoot.

Status
======

Reviews and changes accomadated. ACK received and udpated.

Future
======

1. Suggestion on vlan filters - 

Change Log:

Vipin Varghese (2):
  doc: add svg for debug and troubleshoot guide
  doc: add guide for debug and troubleshoot

 doc/guides/howto/debug_troubleshoot_guide.rst | 375 ++++++++++++++++++
 doc/guides/howto/img/dtg_consumer_ring.svg    |  19 +
 doc/guides/howto/img/dtg_crypto.svg           |  16 +
 .../howto/img/dtg_distributor_worker.svg      |  31 ++
 doc/guides/howto/img/dtg_mempool.svg          |  22 +
 doc/guides/howto/img/dtg_pdump.svg            |  28 ++
 doc/guides/howto/img/dtg_producer_ring.svg    |  19 +
 doc/guides/howto/img/dtg_qos_tx.svg           |  24 ++
 doc/guides/howto/img/dtg_rx_rate.svg          |  20 +
 doc/guides/howto/img/dtg_rx_tx_drop.svg       |  28 ++
 doc/guides/howto/img/dtg_sample_app_model.svg | 105 +++++
 doc/guides/howto/img/dtg_service.svg          |  15 +
 doc/guides/howto/index.rst                    |   1 +
 13 files changed, 703 insertions(+)
 create mode 100644 doc/guides/howto/debug_troubleshoot_guide.rst
 create mode 100644 doc/guides/howto/img/dtg_consumer_ring.svg
 create mode 100644 doc/guides/howto/img/dtg_crypto.svg
 create mode 100644 doc/guides/howto/img/dtg_distributor_worker.svg
 create mode 100644 doc/guides/howto/img/dtg_mempool.svg
 create mode 100644 doc/guides/howto/img/dtg_pdump.svg
 create mode 100644 doc/guides/howto/img/dtg_producer_ring.svg
 create mode 100644 doc/guides/howto/img/dtg_qos_tx.svg
 create mode 100644 doc/guides/howto/img/dtg_rx_rate.svg
 create mode 100644 doc/guides/howto/img/dtg_rx_tx_drop.svg
 create mode 100644 doc/guides/howto/img/dtg_sample_app_model.svg
 create mode 100644 doc/guides/howto/img/dtg_service.svg

V4:
 - Added suggestion and corrections - Shreyansh Jain

V3:
 - Reorder the commit order - Thomas Monjalon

V2:
 - Added ACK - Marko Kovacevic

-- 
2.17.1