[proto_ws] regenerate readme concerning tracing

modules/proto_ws/README

@@ -24,6 +24,7 @@ Razvan Crainea
               1.3.1. ws_port (integer)
               1.3.2. ws_send_timeout (integer)
               1.3.3. ws_max_msg_chunks (integer)
+              1.3.4. trace_destination (string)
 
    2. Frequently Asked Questions
 
@@ -32,6 +33,7 @@ Razvan Crainea
    1.1. Set ws_port parameter
    1.2. Set ws_send_timeout parameter
    1.3. Set ws_max_msg_chunks parameter
+   1.4. Set trace_destination parameter
 
 Chapter 1. Admin Guide
 
@@ -133,17 +135,40 @@ modparam("proto_ws", "ws_send_timeout", 200)
 modparam("proto_ws", "ws_max_msg_chunks", 8)
 ...
 
+1.3.4. trace_destination (string)
+
+   Trace destination as defined in the tracing module. Currently
+   the only tracing module is proto_hep. Network events such as
+   connect, accept and connection closed events shall be traced
+   along with errors that could appear in the process. For each
+   connection that is created an event containing information
+   about http request and reply belonging to web socket protocol
+   handshake and network layer information shall be sent.
+
+   WARNING: A tracing module must be loaded in order for this
+   parameter to work. (for example proto_hep).
+
+   Default value is none(not defined).
+
+   Example 1.4. Set trace_destination parameter
+...
+modparam("proto_hep", "trace_destination", "[hep_dest]10.0.0.2;transport
+=tcp;version=3")
+
+modparam("proto_wss", "trace_destination", "hep_dest")
+...
+
 Chapter 2. Frequently Asked Questions
 
    2.1.
 
-       Can OpenSIPS act as a WebSocket client?
+   Can OpenSIPS act as a WebSocket client?
 
-       Yes, starting with OpenSIPS 2.2, it can act as a WebSocket
-       client.
+   Yes, starting with OpenSIPS 2.2, it can act as a WebSocket
+   client.
 
    2.2.
 
-       Does OpenSIPS support WebSocket message fragmentation?
+   Does OpenSIPS support WebSocket message fragmentation?
 
-       No, WebSocket fragmentation mechanism is not supported.
+   No, WebSocket fragmentation mechanism is not supported.

modules/proto_ws/doc/proto_ws_admin.xml

@@ -21,7 +21,7 @@
 	to act as SIP clients for the &osips; proxy.
 	</para>
 	<para>
-	The current implementation acts both as WebSocket server and client, thus it can 
+	The current implementation acts both as WebSocket server and client, thus it can
 	accept connections from WebSocket clients and can also initiate connections to another
 	WebSocket server. After the connection is established, messages can flow  in
 	both directions.
@@ -159,6 +159,40 @@ modparam("proto_ws", "ws_max_msg_chunks", 8)
 </programlisting>
 		</example>
 	</section>
+	<section>
+		<title><varname>trace_destination</varname> (string)</title>
+		<para>
+			Trace destination as defined in the tracing module. Currently
+		the only tracing module is <emphasis role="bold">proto_hep</emphasis>.
+		Network events such as connect, accept and connection closed events
+		shall be traced along with errors that could appear in the process.
+		For each connection that is created an event containing information
+		about http request and reply belonging to  web socket protocol
+		handshake and network layer information shall be sent.
+		</para>
+		<para>
+			<emphasis role="bold">WARNING: </emphasis>A tracing module must be
+			loaded in order for this parameter to work. (for example
+			<emphasis role="bold">proto_hep</emphasis>).
+		</para>
+		<para>
+		<emphasis>
+			Default value is none(not defined).
+		</emphasis>
+		</para>
+		<example>
+		<title>Set <varname>trace_destination</varname> parameter</title>
+		<programlisting format="linespecific">
+...
+modparam("proto_hep", "trace_destination", "[hep_dest]10.0.0.2;transport=tcp;version=3")
+
+modparam("proto_wss", "trace_destination", "hep_dest")
+...
+</programlisting>
+		</example>
+	</section>
+
+
 	</section>
 
 </chapter>