[drouting] improve README with reporting samples

OpenSIPS · May 17, 2022 · 41ddb49 · 41ddb49
1 parent c0428d5
commit 41ddb49
Show file tree

Hide file tree

Showing 2 changed files with 90 additions and 2 deletions.
diff --git a/modules/drouting/README b/modules/drouting/README
@@ -1771,14 +1771,40 @@ Status:: 0
      * 1 - data loaded, partition ready
      * 2 - data available, a reload in progress
 
-   In terms of reports/logs, the following events will be
+   Reload reporting:
+
+   In terms of data reloading, the following logs will be
    reported:
      * starting DB data loading
      * DB data loading failed, discarding
      * DB data loading successfully completed
      * N gateways loaded (N discarded), N carriers loaded (N
        discarded), N rules loaded (N discarded)
 
+    {
+        "Name": "Default",
+        "Reports": [
+            {
+                "Timestamp": 1652353940,
+                "Date": "Thu May 12 14:12:20 2022",
+                "Log": "starting DB data loading"
+            },
+            {
+                "Timestamp": 1652353940,
+                "Date": "Thu May 12 14:12:20 2022",
+                "Log": "DB data loading successfully completed"
+            },
+            {
+                "Timestamp": 1652353940,
+                "Date": "Thu May 12 14:12:20 2022",
+                "Log": "2 gateways loaded (0 discarded), 2 carriers load
+ed (0 discarded), 1 rules loaded (0 discarded)"
+            }
+        ]
+    }
+
+   GW/Carrier switching reporting:
+
    For reporting events related to the state changes of the
    gateways and carriers, the module provides separate identifiers
    (still one per partition). Why separate ones? The reports on
@@ -1791,6 +1817,23 @@ Status:: 0
    and carriers, along with the reason of the change. This
    identifiers have a 200 records history before discarding the
    old ones.
+    {
+        "Name": "Default;events",
+        "Reports": [
+            {
+                "Timestamp": 1652353976,
+                "Date": "Thu May 12 14:12:56 2022",
+                "Log": "GW <gw1_1>/127.0.1.1 switched to [inactive] due
+probing reply\n"
+            },
+            {
+                "Timestamp": 1652353976,
+                "Date": "Thu May 12 14:12:56 2022",
+                "Log": "GW <gw2_1>/127.0.1.2 switched to [inactive] due
+probing reply\n"
+            }
+        ]
+    }
 
    For how to access and use the Status/Report information, please
    see

diff --git a/modules/drouting/doc/drouting_admin.xml b/modules/drouting/doc/drouting_admin.xml
@@ -2650,7 +2650,10 @@ Status:: 0
 	</itemizedlist>
 
 	<para>
-	In terms of reports/logs, the following events will be reported:
+	Reload reporting:
+	</para>
+	<para>
+	In terms of data reloading, the following logs will be reported:
 	</para>
 	<itemizedlist>
 		<listitem><para>
@@ -2666,7 +2669,32 @@ Status:: 0
 		N gateways loaded (N discarded), N carriers loaded (N discarded), N rules loaded (N discarded)
 		</para></listitem>
 	</itemizedlist>
+	<programlisting  format="linespecific">
+    {
+        "Name": "Default",
+        "Reports": [
+            {
+                "Timestamp": 1652353940,
+                "Date": "Thu May 12 14:12:20 2022",
+                "Log": "starting DB data loading"
+            },
+            {
+                "Timestamp": 1652353940,
+                "Date": "Thu May 12 14:12:20 2022",
+                "Log": "DB data loading successfully completed"
+            },
+            {
+                "Timestamp": 1652353940,
+                "Date": "Thu May 12 14:12:20 2022",
+                "Log": "2 gateways loaded (0 discarded), 2 carriers loaded (0 discarded), 1 rules loaded (0 discarded)"
+            }
+        ]
+    }
+	</programlisting>
 
+	<para>
+	GW/Carrier switching reporting:
+	</para>
 	<para>
 	For reporting events related to the state changes of the
 	gateways and carriers, the module provides separate identifiers (still
@@ -2681,6 +2709,23 @@ Status:: 0
 	of the change. This identifiers have a 200 records history before 
 	discarding the old ones.
 	</para>
+	<programlisting>
+    {
+        "Name": "Default;events",
+        "Reports": [
+            {
+                "Timestamp": 1652353976,
+                "Date": "Thu May 12 14:12:56 2022",
+                "Log": "GW &lt;gw1_1&gt;/127.0.1.1 switched to [inactive] due probing reply\n"
+            },
+            {
+                "Timestamp": 1652353976,
+                "Date": "Thu May 12 14:12:56 2022",
+                "Log": "GW &lt;gw2_1&gt;/127.0.1.2 switched to [inactive] due probing reply\n"
+            }
+        ]
+    }
+	</programlisting>
 
 	<para>
 	For how to access and use the Status/Report information, please see