Permalink
Browse files

Update README.md

  • Loading branch information...
1 parent 10d7976 commit 2453a1aa36e11f67b9f0ac9d0e21ce6f2195258d @SHSE committed Jul 1, 2013
Showing with 31 additions and 9 deletions.
  1. +31 −9 README.md
View
@@ -14,16 +14,40 @@ LogWatch allows you to view output from NLog and Log4Net loggers.
## Features
* Designed to handle large log files (hundreds of megabytes, it doesn't read all the data into memory)
* Live file streaming support (view files that are currently being updated by the logger)
-* Accepts log files in CSV or Log4J XML formats
+* Built-in support for CSV and Log4J XML formats
* Automatic log format selection
* Receives log records via network
* Provides quick jump to a next Trace/Debug/Info/Warn/Error/Fatal record functionality
* Search using simple text search or regular expressions (press Ctrol+F to activate)
-* Custom log parser using [Lex](http://dinosaur.compilertools.net/lex) syntax
+* Ability to define custom log parser using [Lex](http://dinosaur.compilertools.net/lex) syntax
-## File source
+## Sources
-NLog configuration for CSV format:
+LogWatch has built-in support for the following log sources:
+* File source
+* UDP source
+
+When using file source LogWatch sets a monitor on the file and provides live updates on the records.
+
+## Formats
+
+The application supports the following log formats out of the box:
+* CSV format (with some limitations)
+* Log4J XML format
+* [Custom parser (defined using Lex syntax)](//github.com/SHSE/LogWatch/wiki/Lex-Parser)
+
+LogWatch automatically determines format of the source.
+
+CSV delimeter can be `;` or `,`. The log file must have header with some of the following feillds (case sensitive):
+```
+time
+message
+logger
+level
+exception
+```
+
+Here is an example configuration of CSV layout for NLog:
```xml
<target name="file" xsi:type="File" encoding="utf-8" fileName="mylog.log">
<layout xsi:type="CsvLayout">
@@ -36,16 +60,14 @@ NLog configuration for CSV format:
</target>
```
-## Network source
-
-LogWatch accepts log records via UDP protocol in Log4J XML format (the same format as NLogViewer).
-
-NLog configuration:
+Log4J XML is the default format for NLogViewer. Here is an example configuration for NLog:
```xml
<target name="viewer" xsi:type="NLogViewer" address="udp://127.0.0.1:13370" includeNLogData="true">
<parameter name="exception" layout="${exception:format=ToString}"/>
</target>
```
+`NLogViewer` sends records via UDP in Log4J XML format.
+
## TODO

0 comments on commit 2453a1a

Please sign in to comment.