]> git.ipfire.org Git - people/ms/suricata.git/commitdiff
lua output doc: Add explaining introduction text
authorRichard Sailer <richard_siegfried@systemli.org>
Fri, 16 Mar 2018 17:39:07 +0000 (18:39 +0100)
committerVictor Julien <victor@inliniac.net>
Fri, 30 Mar 2018 07:41:38 +0000 (09:41 +0200)
doc/userguide/output/lua-output.rst

index bd844cdc3ea9497c928dc9e33051897bcbc5011b..9688b685569b37f01378dd09c4abf0be44a9934c 100644 (file)
@@ -1,17 +1,25 @@
 Lua Output
 ==========
 
-Lua scripts can be used to generate output from Suricata.
+Suricata offers the possibility to get more detailed output on specific kinds of
+network traffic via pluggable lua scripts. You can write these scripts yourself and only need to
+define four hook functions.
+
+For lua output scripts suricata offers a wide range of lua functions.
+They all return information on specific engine internals and aspects of the network traffic.
+They are described in the following sections, grouped by the event/traffic type.
+But let's start with a example explaining the four hook functions, and how to make
+suricata load a lua output script.
 
 Script structure
 ----------------
 
-A script defines 4 functions: init, setup, log, deinit
+A lua output script needs to define 4 hook functions: init(), setup(), log(), deinit()
 
-* init -- registers where the script hooks into the output engine
-* setup -- does per output thread setup
-* log -- logging function
-* deinit -- clean up function
+* init() -- registers where the script hooks into the output engine
+* setup() -- does per output thread setup
+* log() -- logging function
+* deinit() -- clean up function
 
 Example: