[sr-dev] git:master:ba2d0e17: influxdbc: docs for several parameters and functions

Module: kamailio Branch: master Commit: ba2d0e171b0171ba98bc7219a420dcda7677d366 URL: https://github.com/kamailio/kamailio/commit/ba2d0e171b0171ba98bc7219a420dcd… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: 2024-02-05T16:19:20+01:00 influxdbc: docs for several parameters and functions --- Modified: src/modules/influxdbc/doc/influxdbc_admin.xml --- Diff: https://github.com/kamailio/kamailio/commit/ba2d0e171b0171ba98bc7219a420dcd… Patch: https://github.com/kamailio/kamailio/commit/ba2d0e171b0171ba98bc7219a420dcd… --- diff --git a/src/modules/influxdbc/doc/influxdbc_admin.xml b/src/modules/influxdbc/doc/influxdbc_admin.xml index c59fe92a126..a02af97e048 100644 --- a/src/modules/influxdbc/doc/influxdbc_admin.xml +++ b/src/modules/influxdbc/doc/influxdbc_admin.xml @@ -68,6 +68,44 @@ ... modparam("influxdbc", "server", "127.0.0.1") ... +</programlisting> + </example> + </section> + <section id="influxdbc.p.port"> + <title><varname>port</varname> (int)</title> + <para> + Address of InfluxDB server. + </para> + <para> + <emphasis> + Default value is 8086. + </emphasis> + </para> + <example> + <title>Set <varname>port</varname> parameter</title> + <programlisting format="linespecific"> +... +modparam("influxdbc", "port", 8808) +... +</programlisting> + </example> + </section> + <section id="influxdbc.p.database"> + <title><varname>database</varname> (int)</title> + <para> + Database of InfluxDB server. + </para> + <para> + <emphasis> + Default value is empty. + </emphasis> + </para> + <example> + <title>Set <varname>database</varname> parameter</title> + <programlisting format="linespecific"> +... +modparam("influxdbc", "database", "stats") +... </programlisting> </example> </section> @@ -86,7 +124,7 @@ modparam("influxdbc", "server", "127.0.0.1") This function can be used from ANY_ROUTE. </para> <example> - <title><function>async_route</function> usage</title> + <title><function>influxdbc_measure()</function> usage</title> <programlisting format="linespecific"> ... request_route { @@ -95,6 +133,53 @@ request_route { ... } ... +</programlisting> + </example> + </section> + <section id="influxdb.f.influxdbc_measureend"> + <title> + <function moreinfo="none">influxdbc_measureend()</function> + </title> + <para> + End the current measure group. + </para> + <para> + This function can be used from ANY_ROUTE. + </para> + <example> + <title><function>influxdbc_measureend()</function> usage</title> + <programlisting format="linespecific"> +... +request_route { + ... + influxdbc_measureend(); + ... +} +... +</programlisting> + </example> + </section> + <section id="influxdb.f.influxdbc_lomg"> + <title> + <function moreinfo="none">influxdbc_long(name, value)</function> + </title> + <para> + Save the pair with provided name and value. Both parameters can + have variables. + </para> + <para> + This function can be used from ANY_ROUTE. + </para> + <example> + <title><function>influxdbc_long()</function> usage</title> + <programlisting format="linespecific"> +... +request_route { + ... + influxdbc_long("active", "$shv(active)"); + ... +} +... </programlisting> </example> </section>