NXLOG Community Edition Reference Manual for V2.9.1716 I
Total Page:16
File Type:pdf, Size:1020Kb
Ed. v2.9.1716 NXLOG Community Edition Reference Manual for v2.9.1716 i NXLOG Community Edition Reference Manual for v2.9.1716 Ed. v2.9.1716 Ed. v2.9.1716 NXLOG Community Edition Reference Manual for v2.9.1716 ii Copyright © 2009-2014 NXLog Ltd. Ed. v2.9.1716 NXLOG Community Edition Reference Manual for v2.9.1716 iii Contents 1 Introduction 1 1.1 Overview . .1 1.2 Features . .1 1.2.1 Multiplatform . .1 1.2.2 Modular architecture . .1 1.2.3 Client-server mode . .2 1.2.4 Log message sources and destinations . .2 1.2.5 Importance of security . .2 1.2.6 Scalable multi-threaded architecture . .2 1.2.7 High performance I/O . .2 1.2.8 Message buffering . .2 1.2.9 Prioritized processing . .3 1.2.10 Avoiding lost messages . .3 1.2.11 Apache-style configuration syntax . .3 1.2.12 Built-in config language . .3 1.2.13 Scheduled tasks . .3 1.2.14 Log rotation . .3 1.2.15 Different log message formats . .4 1.2.16 Advanced message processing capabilites . .4 1.2.17 Offline processing mode . .4 1.2.18 Character set and i18n support . .4 2 Installation and quickstart 5 2.1 Microsoft Windows . .5 2.2 GNU/Linux . .6 2.2.1 Installing from DEB packages (Debian, Ubuntu) . .6 2.2.2 Installing from RPM packages (CentOS, RedHat) . .6 2.2.3 Configuring nxlog on GNU/Linux . .6 Ed. v2.9.1716 NXLOG Community Edition Reference Manual for v2.9.1716 iv 3 Architecture and concepts 7 3.1 History . .7 3.2 Concepts . .7 3.3 Architecture . .8 4 Configuration 9 4.1 File inclusion . .9 4.2 Constant and macro definitions . .9 4.3 Global directives . 10 4.4 Modules . 11 4.4.1 Common module directives . 12 4.4.1.1 Module . 12 4.4.1.2 FlowControl . 12 4.4.1.3 Schedule . 12 4.4.1.4 Exec . 13 4.4.1.5 Processors . 14 4.4.1.6 InputType . 14 4.4.1.7 OutputType . 15 4.5 Routes . 16 4.5.1 Priority . 16 4.5.2 Path . 17 5 Language 19 5.1 Types ......................................................... 19 5.2 Expressions . 20 5.2.1 Literals . 20 5.2.2 Fields . 21 5.2.3 Operations . 21 5.2.3.1 Unary operations . 22 5.2.3.2 Binary operations . 22 5.2.4 Functions . 26 5.3 Statements . 27 5.3.1 Assignment . 27 5.3.2 Block . 27 5.3.3 Procedures . 27 5.3.4 If-Else . 27 5.4 Variables . 28 5.5 Statistical counters . 29 5.6 List of available functions and procedures . 30 5.6.1 Functions and procedures exported by core . 30 5.6.1.1 Functions exported by core . 30 5.6.1.2 Procedures exported by core . 35 5.6.2 Functions and procedures exported by modules . 38 Ed. v2.9.1716 NXLOG Community Edition Reference Manual for v2.9.1716 v 6 Modules 39 6.1 Extension modules . 39 6.1.1 CSV (xm_csv) . 39 6.1.1.1 Configuration . 39 6.1.1.1.1 Specifying characters for quote, escape and delimiter . 40 6.1.1.2 Functions and procedures exported by xm_csv . 41 6.1.1.2.1 Functions exported by xm_csv . 41 6.1.1.2.2 Procedures exported by xm_csv . 41 6.1.1.3 Configuration examples . 42 6.1.2 JSON (xm_json) . 42 6.1.2.1 Configuration . ..