[sr-dev] git:master:51b18cbc: siptrace: hlog() documentation

[Camille Oudot]

Module: kamailio
Branch: master
Commit: 51b18cbc872e7ec5be95a4f8f4490220e749286a
URL: https://github.com/kamailio/kamailio/commit/51b18cbc872e7ec5be95a4f8f4490220e749286a

Author: Camille Oudot <camille.oudot at orange.com>
Committer: Camille Oudot <camille.oudot at orange.com>
Date: 2017-02-23T18:51:54+01:00

siptrace: hlog() documentation

---

Modified: src/modules/siptrace/doc/siptrace.xml
Modified: src/modules/siptrace/doc/siptrace_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/51b18cbc872e7ec5be95a4f8f4490220e749286a.diff
Patch: https://github.com/kamailio/kamailio/commit/51b18cbc872e7ec5be95a4f8f4490220e749286a.patch

---

diff --git a/src/modules/siptrace/doc/siptrace.xml b/src/modules/siptrace/doc/siptrace.xml
index 427eed6..74e0fc0 100644
--- a/src/modules/siptrace/doc/siptrace.xml
+++ b/src/modules/siptrace/doc/siptrace.xml
@@ -33,6 +33,11 @@
 		<surname>Vacca</surname>
 		<email>giacomo.vacca at gmail.com</email>
 	</editor>
+	<editor>
+		<firstname>Camille</firstname>
+		<surname>Oudot</surname>
+		<email>camille.oudot at orange.com</email>
+	</editor>
 	</authorgroup>
 	<copyright>
 	    <year>2010</year>
diff --git a/src/modules/siptrace/doc/siptrace_admin.xml b/src/modules/siptrace/doc/siptrace_admin.xml
index f1924ab..bceb752 100644
--- a/src/modules/siptrace/doc/siptrace_admin.xml
+++ b/src/modules/siptrace/doc/siptrace_admin.xml
@@ -557,6 +557,40 @@ sip_trace("sip:10.1.1.2:5085", "$ci-abc");
 		</example>
 	</section>
 
+	<section id="siptrace.f.hlog">
+		<title>
+		<function moreinfo="none">hlog([correlation_id,] message)</function>
+		</title>
+		<para>
+		Sends a log event as a HEP3 packet to the homer host configured in
+		<emphasis>duplicate_uri</emphasis>.
+		</para>
+		<para>Meaning of the parameters is as follows:</para>
+		<itemizedlist>
+			<listitem>
+			<para><emphasis>correlation_id</emphasis> (optional) - Homer correlation
+			ID for this event. If this parameter is not set, the current message's
+			call-id will be used. (This parameter may contain PVs)
+			</para>
+			</listitem>
+			<listitem>
+			<para><emphasis>message</emphasis> - The text to send to Homer as log
+			event. (This parameter may contain PVs)
+			</para>
+			</listitem>
+		</itemizedlist>
+		<example>
+		<title><function>hlog()</function> usage</title>
+		<programlisting format="linespecific">
+...
+hlog("[cfg:$cfg(line)] This is a log from kamailio to Homer");
+...
+hlog("$hdr(P-MyID)", "Another one with a custom correlation ID");
+...
+</programlisting>
+		</example>
+	</section>
+
 	</section>
 
     <section>