summaryrefslogtreecommitdiffstats
path: root/source/rainerscript/functions/mo-http_request.rst
diff options
context:
space:
mode:
Diffstat (limited to 'source/rainerscript/functions/mo-http_request.rst')
-rw-r--r--source/rainerscript/functions/mo-http_request.rst39
1 files changed, 39 insertions, 0 deletions
diff --git a/source/rainerscript/functions/mo-http_request.rst b/source/rainerscript/functions/mo-http_request.rst
new file mode 100644
index 0000000..a0b0f22
--- /dev/null
+++ b/source/rainerscript/functions/mo-http_request.rst
@@ -0,0 +1,39 @@
+************
+HTTP-Request
+************
+
+Purpose
+=======
+
+http_request(str)
+
+Performs a http request to target and returns the result of said request.
+
+.. note::
+
+ this function is very slow and therefore we suggest using it only seldomly
+ to insure adequate performance.
+
+
+Example
+=======
+
+The following example performs a http request and writes the returned value
+to a file.
+
+
+.. code-block:: none
+
+ module(load="../plugins/imtcp/.libs/imtcp")
+ module(load="../plugins/fmhttp/.libs/fmhttp")
+ input(type="imtcp" port="13514")
+
+ template(name="outfmt" type="string" string="%$!%\n")
+
+ if $msg contains "msgnum:" then {
+ set $.url = "http://www.rsyslog.com/testbench/echo-get.php?content=" & ltrim($msg);
+ set $!reply = http_request($.url);
+ action(type="omfile" file="rsyslog.out.log" template="outfmt")
+ }
+
+