[tor-bugs] #20380 [Metrics/CollecTor]: Expand INSTALL.md to a more complete operator's guide

[Tor Bug Tracker & Wiki]

#20380: Expand INSTALL.md to a more complete operator's guide
-------------------------------+---------------------------------
 Reporter:  karsten            |          Owner:
     Type:  enhancement        |         Status:  needs_review
 Priority:  Medium             |      Milestone:  CollecTor 1.1.0
Component:  Metrics/CollecTor  |        Version:
 Severity:  Normal             |     Resolution:
 Keywords:                     |  Actual Points:
Parent ID:                     |         Points:
 Reviewer:                     |        Sponsor:
-------------------------------+---------------------------------

Comment (by iwakeh):

 Well, that's just a warning in debug mode, but it does choose the right
 file.  And, I would expect operators to ask very soon about logging config
 if we don't say anything about it.

 What about adding the urls for documentation?

 {{{
 ### Changing logging options

 Internally, CollecTor uses the Simple Logging Facade for Java (SLF4J) and
 ships with
 the Logback implementation for SLF4J. So, if you prefer another logging
 framework than
 Logback, you could provide and use that instead.

 In addition, CollecTor provides a default logging configuration (in
 `collector-<version>/src/main/resources/logback.xml`), which runs on info
 level and creates one logfile per module and a common log. It also expects
 a path where the logs should be written to, which is set on the java
 command line by adding `-DLOGBASE=<your-log-dir>`.

 If you want to adjust some logging parameters just copy the default
 configuration from
 `collector-<version>/src/main/resources/logback.xml` to your working
 directory,
 edit your copy, and execute the .jar file as follows:

 ```java -Xmx2g -DLOGBASE=<your-log-dir> -jar -cp .:collector-<version>.jar
 org.torproject.collector.Main```

 For more detailed information or if you have different logging needs,
 please refer to
 the Logback documentation:    http://logback.qos.ch/
 and for switching to a different framework to the SFL4J site:
 http://www.slf4j.org/

 }}}

--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/20380#comment:20>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online