Skip to content

Commit

Permalink
[drouting] add docs on the provided Status/Report identifiers
Browse files Browse the repository at this point in the history
  • Loading branch information
bogdan-iancu committed Feb 10, 2022
1 parent dea72f1 commit 3b79864
Showing 1 changed file with 54 additions and 0 deletions.
54 changes: 54 additions & 0 deletions modules/drouting/doc/drouting_admin.xml
Expand Up @@ -2607,6 +2607,60 @@ Status:: 0
</section>


<section id="sr_identifiers" xreflabel="Status/Report Identifiers">
<title>Provided Status/Report Identifiers</title>

<para>
The module provides the "drouting" Status/Report group, where each
routing partition is defined as a separate SR idenifier.
</para>
<para>
The status of these identifiers reflects the readiness/status of the
cached data (if available or not when being loaded from DB):
</para>
<itemizedlist>
<listitem><para>
<emphasis>-2</emphasis> - no data at all (initial status)
</para></listitem>
<listitem><para>
<emphasis>-1</emphasis> - no data, initial loading in progress
</para></listitem>
<listitem><para>
<emphasis>1</emphasis> - data loaded, partition ready
</para></listitem>
<listitem><para>
<emphasis>2</emphasis> - data available, a reload in progress
</para></listitem>
</itemizedlist>

<para>
In terms of reports/logs, the following events will be reported:
</para>
<itemizedlist>
<listitem><para>
starting DB data loading
</para></listitem>
<listitem><para>
DB data loading failed, discarding
</para></listitem>
<listitem><para>
DB data loading successfully completed
</para></listitem>
<listitem><para>
N gateways loaded (N discarded), N carriers loaded (N discarded), N rules loaded (N discarded)
</para></listitem>
</itemizedlist>

<para>
For how to access and use the Status/Report information, please see
<ulink url='>https://www.opensips.org/Documentation/Interface-StatusReport-3-3'>https://www.opensips.org/Documentation/Interface-StatusReport-3-3</ulink>.
</para>

</section>




<section>
<title>Installation</title>
<para>
Expand Down

0 comments on commit 3b79864

Please sign in to comment.