summaryrefslogtreecommitdiffstats
path: root/doc/dev_oplugins.html
diff options
context:
space:
mode:
authorRainer Gerhards <rgerhards@adiscon.com>2012-08-29 09:56:49 +0200
committerRainer Gerhards <rgerhards@adiscon.com>2012-08-29 09:56:49 +0200
commit901270418eca404a1f05c2b5ace66954b8b690b1 (patch)
treeec09bf6364f099ebb1d1a80661547e629dc70f27 /doc/dev_oplugins.html
parent7348da7e02fae85ad24dd496f1cd8f6385cfcfa8 (diff)
downloadrsyslog-901270418eca404a1f05c2b5ace66954b8b690b1.tar.gz
rsyslog-901270418eca404a1f05c2b5ace66954b8b690b1.tar.xz
rsyslog-901270418eca404a1f05c2b5ace66954b8b690b1.zip
add OMSR_TPL_AS_JSON mode for output modules (interface only)
This patch does NOT contain any implementation, this will happen next. Thanks to Miloslav Trmac, who suggested a similar mode, which I based the JSON idea on.
Diffstat (limited to 'doc/dev_oplugins.html')
-rw-r--r--doc/dev_oplugins.html5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/dev_oplugins.html b/doc/dev_oplugins.html
index 63c186a3..b33b67f9 100644
--- a/doc/dev_oplugins.html
+++ b/doc/dev_oplugins.html
@@ -143,6 +143,11 @@ omstdout, you can see how a plugin may deal with the situation.
array-passing capability not blindly be used.</b> In such cases, we can not guard the
plugin from segfaulting and if the plugin (as currently always) is run within
rsyslog's process space, that results in a segfault for rsyslog. So do not do this.
+<p>Another possible mode is OMSR_TPL_AS_JSON, where instead of the template
+a json-c memory object tree is passed to the module. The module can extract data
+via json-c API calls. It MUST NOT modify the provided structure. This mode is
+primarily aimed at plugins that need to process tree-like data, as found
+for example in MongoDB or ElasticSearch.
<h3>Batching of Messages</h3>
<p>Starting with rsyslog 4.3.x, batching of output messages is supported. Previously, only
a single-message interface was supported.