Skip to content

Commit

Permalink
Update README.md for first release.
Browse files Browse the repository at this point in the history
  • Loading branch information
markrmiller committed May 3, 2015
1 parent 3a9e330 commit ad7f737
Showing 1 changed file with 23 additions and 10 deletions.
33 changes: 23 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

Early days. Crunches and summarizes Solr log files.

**SolrLogReader [file or folder path] {TextMatchAspect} {TextMatchAspect} {-o outputdir}...**
**java -jar slr.jar [file or folder path] {TextMatchAspect} {TextMatchAspect} {-o outputdir}...**

Example: **SolrLogReader /solr/logs**
Example: **java -jar slr.jar /solr/logs**

An optional TextMatchAspect will pull out any logs with matching text, for example: SolrLogReader /solr/logs org.apache.solr.cloud
An optional TextMatchAspect will pull out any logs with matching text, for example: **java -jar slr.jar /solr/logs org.apache.solr.cloud**

If you specify an outputdir, more verbose summaries are dumped to files in that folder as well as an html error chart.

Expand All @@ -19,12 +19,13 @@ Logs that look like they come from different servers will be summarized separate

### Getting Started

**wget https://github.com/markrmiller/SolrLogReader/archive/master.zip**

**unzip master.zip**
**cd SolrLogReader-master**
**javac -cp lib/* src/main/java/*.java**
**java -cp lib/*:src/main/java SolrLogReader /path/to/logs**
Download SolrLogReader.

Extract it.

Run it.

**java -jar slr.jar /path/to/logs**


### Timestamp Patterns
Expand All @@ -42,4 +43,16 @@ Entries will be tried until one matches.
### FAQ

**Q**: Can I just process the Solr logs in a deep directory hierarchy with lots of log files?
**A**: SolrLogReader /solr/logs/solr* A filename with a glob pattern will be used to match against file names for all files under the /solr/logs directory hierarchy.
**A**: SolrLogReader /solr/logs/solr* A filename with a glob pattern will be used to match against file names for all files under the /solr/logs directory hierarchy.


#### Developer Help

I use eclipse to develop and run SolrLogReader. Here is how you might run it command line.

**wget https://github.com/markrmiller/SolrLogReader/archive/master.zip**

**unzip master.zip**
**cd SolrLogReader-master**
**javac -cp lib/* src/main/java/*.java**
**java -cp lib/*:src/main/java SolrLogReader /path/to/logs**

0 comments on commit ad7f737

Please sign in to comment.