[v5,0/2] doc/howto: add debug and troubleshoot guide

Message ID 20190121104144.67365-1-vipin.varghese@intel.com
Headers show
Series
  • doc/howto: add debug and troubleshoot guide
Related show

Message

Varghese, Vipin Jan. 21, 2019, 10:41 a.m.
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 modelled 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 time
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 accommodated. ACK received and updated.

Future
======
1. Suggestion on vlan filters - Shreyansh Jain

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

V5:
 - Corrections is spelling -  Marko Kovacevic

V4:
 - Added suggestion and corrections - Shreyansh Jain

V3:
 - Reorder the commit order - Thomas Monjalon

V2:
 - Added ACK - Marko Kovacevic