yeti-switch · dmitry-sinina · Apr 7, 2025 · Mar 15, 2025 · Apr 7, 2025 · Apr 7, 2025
diff --git a/en/best-practices/images/troubleshooting_cdr_page_trace_link.png b/en/best-practices/images/troubleshooting_cdr_page_trace_link.png
diff --git a/en/best-practices/images/troubleshooting_cdr_trace_link.png b/en/best-practices/images/troubleshooting_cdr_trace_link.png
diff --git a/en/best-practices/troubleshooting.rst b/en/best-practices/troubleshooting.rst
@@ -0,0 +1,63 @@
+
+.. _troubleshooting:
+
+===============
+Troubleshooting
+===============
+
+
+Routing simulation
+==================
+
+In case of unexpected routing behavior - when yeti choosing unexpected Customer auth, Destinations, Dialpeers or Gateways Routing Simulation tools allow to collect routing logs.
+
+There are two ways how to use Routing Simulation tool:
+
+    - Manually from Routing -> Routing Simulation menu - In this case operator have to enter all call attributes manually.
+    - From CDR. When you want to reproduce call routing of specific call - you can click on "Routing Simulation" button on CDR Show page. In this call all call attributes will be copied from CDR automatically.
+
+
+.. _troubleshooting_tracing:
+
+Trace capturing
+===============
+
+For troubleshooting issues related to SIP signaling or RTP processing Yeti provides mechanism to capture traces in pcap format. There are few places where operator can enable this mechanism:
+
+    * Dump Level in Customer auth object
+    * Dump Level in Termination gateway object
+
+Possible Dump Level values:
+
+    * Capture nothing - Tracing disabled
+    * Capture signaling traffic - SIP signaling traffic will be written to pcap file
+    * Capture RTP traffic - RTP media traffic will be written to pcap file
+    * Capture all traffic - Both - SIP and RTP media traffic will be written to pcap file
+
+.. warning:: To save system resources it is recommended to use as low Dump Level as possible and disable tracing when it not needed
+
+During enabling tracing Yeti will use maximum Dump Level value across Customer auth objects and all Termination gw that present in routing results.
+
+
+In case of enabled trace CDR for call will contain link to pcap file on CDR->CDR History page:
+
+..  figure:: images/troubleshooting_cdr_trace_link.png
+    :width: 540
+    :align: center
+    :alt: Trace Download link
+
+|
+
+Alternatively it is possible to download trace by clicking trace button on CDR Show page:
+
+..  figure:: images/troubleshooting_cdr_page_trace_link.png
+    :width: 940
+    :align: center
+    :alt: Trace Download button
+
+|
+
+It is recommended to use `Wireshark <https://www.wireshark.org/>`_ to analyze pcap traces.
+
+.. note:: Traces are not captured by sniffer on network level but written by SEMS SIP stack by mirroring data sent and received to/from sockets.
+
diff --git a/en/index.rst b/en/index.rst
@@ -37,6 +37,7 @@ Welcome to Yeti's documentation!
    best-practices/numbers-translations.rst
    best-practices/teams-direct-routing.rst
    best-practices/using-routing-tags.rst
+   best-practices/troubleshooting.rst
 
 .. toctree::
    :maxdepth: 2

diff --git a/en/web-interface/cdr/cdr-history.rst b/en/web-interface/cdr/cdr-history.rst
@@ -95,11 +95,7 @@ Is Last CDR
     This field should be "yes" ("true") for last routing attempt for the call ("no"("false") otherwise).
 
 Dump Level
-    Level of capturing of call to PCAP (Packet Capture) files that was chosen in the :ref:`Dump Level <customer_auth_dump_level>` attribute of :ref:`Customers Auth <customer_auth>` that is related to this call: |br|
-    **Capture nothing** - Information didn't capture to pcap-file for this call. |br|
-    **Capture signaling traffic** - Only signaling information had been captured to pcap-file for this call. |br|
-    **Capture rtp traffic** - Only RTP traffic had been captured to pcap-file for this call. |br|
-    **Capture all traffic** - Only signaling information & RTP traffic had been captured to pcap-file for this call. |br|
+    Tracing level applied to this call. Read more in :ref:`Call tracing feature documentation <troubleshooting_tracing>`.
 
 Orig GW
     Value of the :ref:`*Name* <gateway_name>` attribute of Gateway that was used as Originator for the call.

diff --git a/en/web-interface/equipment/gateways.rst b/en/web-interface/equipment/gateways.rst
@@ -306,6 +306,12 @@ Incoming auth password
 Signaling (Termination) attributes
 ==================================
 
+Settings in this sections only works when gateways acts as termination gateway for call.
+
+
+Dump Level
+    Dump Level for call tracing mechanism. Read more in :ref:`Call tracing feature documentation <troubleshooting_tracing>`.
+
 Transport protocol
     Transport protocol that is used
 

diff --git a/en/web-interface/routing/customers-auths.rst b/en/web-interface/routing/customers-auths.rst
@@ -195,12 +195,9 @@ General attributes
         You may apply Src Numberlist (Source) and check B-numbers, by prefix or
         full-match, then reject it or allow.
 
-    .. _customer_auth_dump_level:
-
     Dump Level
-        It is possible to capture calls to PCAP files, using this option.
-        You may choose what kind of information should be captured.
-        Possible values are: Capture nothing, Capture signalling traffic, Capture RTP traffic, Capture all traffic.
+        Dump Level for call tracing mechanism. Read more in :ref:`Call tracing feature documentation <troubleshooting_tracing>`.
+
     Enable Audio Recording
         If checked, the media for calls passing through this Customer Auth will be stored
         in WAV files.