3
3
- [ Logstash Integration] ( #logstash-integration )
4
4
- [ Overview] ( #overview )
5
5
- [ Installation] ( #installation )
6
- - [ Logstash Plugin Manager] ( #logstash-plugin-manager )
7
- - [ Manual installation] ( #manual-installation )
8
- - [ Local-only Installation] ( #local-only-installation )
9
6
- [ Configuration] ( #configuration )
10
7
11
8
## Overview
12
9
13
10
Log Courier is built to work seamlessly with [ Logstash] ( http://logstash.net ) . It
14
11
communicates via an input plugin called "courier".
15
12
16
- An output plugin is also available to allow Logstash instances to communicate
17
- with each other using the same reliable and efficient protocol as Log Courier.
13
+ (NOTE: An output plugin exists for Logstash to Logstash transmission but is archived
14
+ and no longer maintained and its use is not advised.)
18
15
19
16
## Installation
20
17
21
- ### Logstash Plugin Manager
22
-
23
- Logstash 1.5 introduces a new plugin manager that makes installing additional
24
- plugins extremely easy.
25
-
26
18
Simply run the following commands as the user Logstash was installed with to
27
- install the latest stable version of the Log Courier plugins. If you are only
28
- receiving events, you only need to install the input plugin.
29
-
30
- cd /path/to/logstash
31
- bin/plugin install logstash-input-courier
32
- bin/plugin install logstash-output-courier
33
-
34
- Once the installation is complete, you can start using the plugins!
35
-
36
- * Note: If you receive a Plugin Conflict error, try updating the zeromq output
37
- plugin first using ` bin/plugin update logstash-output-zeromq ` *
38
-
39
- ### Manual installation
40
-
41
- For Logstash 1.4.x the plugins and dependencies need to be installed manually.
42
-
43
- First build the Log Courier gem the plugins require. The file you will need will
44
- be called log-courier-X.X.gem, where X.X is the version of Log Courier you have.
45
-
46
- git clone https://github.com/driskell/log-courier
47
- cd log-courier
48
- make gem
49
-
50
- Switch to the Logstash installation directory as the user Logstash was installed
51
- with and install the gem. Note that because this is JRuby it may take a minute
52
- to finish the install. The ffi-rzmq-core and ffi-rzmq gems bundled with Logstash
53
- will be upgraded during the installation, which will require an internet
54
- connection.
19
+ install the latest stable version of the Log Courier plugin.
55
20
56
21
cd /path/to/logstash
57
- export GEM_HOME=vendor/bundle/jruby/1.9
58
- java -jar vendor/jar/jruby-complete-1.7.11.jar -S gem install /path/to/the.gem
59
-
60
- The remaining step is to manually install the Logstash plugins.
61
-
62
- cd /path/to/log-courier
63
- cp -rvf lib/logstash /path/to/logstash/lib
64
-
65
- ### Local-only Installation
22
+ ./bin/logstash-plugin install logstash-input-courier
66
23
67
- If you need to install the gem and plugins on a server without an internet
68
- connection, you can download the gem dependencies from the rubygems site and
69
- transfer them across. Follow the instructions for Manual Installation and
70
- install the dependency gems first using the same instructions as for the Log
71
- Courier gem.
72
-
73
- - < https://rubygems.org/gems/ffi-rzmq-core >
74
- - < https://rubygems.org/gems/ffi-rzmq >
75
- - < https://rubygems.org/gems/multi_json >
24
+ Once the installation is complete, you can start using the plugin!
76
25
77
26
## Configuration
78
27
79
- The 'courier' input and output plugins will now be available. An example
80
- configuration for the input plugin follows.
28
+ The 'courier' input plugin will now be available. An example configuration follows.
81
29
82
30
input {
83
31
courier {
@@ -87,7 +35,7 @@ configuration for the input plugin follows.
87
35
}
88
36
}
89
37
90
- The following options are available for the input plugin :
38
+ The following options are available:
91
39
92
40
- transport - "tcp", "tls", "plainzmq" or "zmq" (default: "tls")
93
41
- address - Interface address to listen on (defaults to all interfaces)
@@ -100,26 +48,9 @@ The following options are available for the input plugin:
100
48
(tls)
101
49
- ssl_verify_ca - Path to an SSL CA certificate to use for client certificate
102
50
verification (tls)
103
- - curve_secret_key - CurveZMQ secret key for the server (zmq)
51
+ - min_tls_version - Sets the minimum TLS version when transport is "tls", defaults to 1.2, minimum is 1.0 and maximum 1.3
104
52
- max_packet_size - The maximum packet size to accept (default 10485760,
105
53
corresponds to Log Courier's ` "spool max bytes" ` )
106
54
- peer_recv_queue - The size of the internal queue for each peer
107
55
- add_peer_fields - Add "peer" field to events that identifies source host, and
108
56
"peer_ssl_dn" for TLS peers with client certificates
109
-
110
- The following options are available for the output plugin:
111
-
112
- - addresses - Address to connect to in array format (only the first address will
113
- be used at the moment)
114
- - port - Port to connect to
115
- - ssl_ca - Path to SSL certificate to verify server certificate
116
- - ssl_certificate - Path to client SSL certificate (optional)
117
- - ssl_key - Path to client SSL private key (optional)
118
- - ssl_key_passphrase - Password for ssl_key (optional)
119
- - spool_size - Maximum number of events to spool before a flush is forced
120
- (default 1024)
121
- - idle_timeout - Maximum time in seconds to wait for a full spool before
122
- flushing anyway (default 5)
123
-
124
- NOTE: The tcp, plainzmq and zmq transports are not implemented in the output
125
- plugin at this time. It supports only the tls transport.
0 commit comments