[maven-release-plugin] prepare for next development iteration
[lwes-journaller-java/github-mirror.git] / README
blobe1af064e79681034b84226538cdc9c2b43b4ae24
1 This is a journaller and dejournaller written in java for the Lightweight event system.
3 You will need to install maven 2.x in order to build:
5 % mvn clean package
7 To build a release:
9 % mvn --batch-mode release:prepare release:perform
11 Running
13 To start the journaller:
14 % bin/lwes-journaller -m <multicast_addr> -p <multicast_port> -f <filename>
16 To stop the journaller:
17 NOTE: To stop this journaller, you can't just control-c it or kill -9 it. If you do that, the
18 Java shutdown hook may not catch the signal and the file won't get closed properly. Use the
19 lwes-journaller-stop script or use kill -15.
21 % bin/lwes-journaller-stop
23 To tell the journaller to rotate the log file (you will probably want a cron job for this):
25 % bin/lwes-rotate-log -m <multicast_addr> -p <multicast_port>
27 If you are getting bad throughput as far as number of events per second you can process
28 before you see loss, make sure your operating system udp buffer is set to a reasonable number:
30 Linux               sysctl -w net.core.rmem_max=8388608
31 Solaris             ndd -set /dev/udp udp_max_buf 8388608
32 FreeBSD, Darwin     sysctl -w kern.ipc.maxsockbuf=8388608
33 AIX                 no -o sb_max=8388608
35 You can also increase the read buffer on the multicast socket by setting the lwes specific
36 system property MulticastReceiveBufferSize. For example,
38 java -DMulticastReceiveBufferSize=8388608 ...
40 There is a dejournaller utility to view the contents of the files. To run this:
42 % java -jar dejournaller-[version].jar -f <file_name> [-g]
44 It will output events one per line so you can grep/awk/perl them.