Merge pull request #319 from iuliana/feature/trace-log
Added mention of the trace configuration being provided
diff --git a/guide/ops/logging.md b/guide/ops/logging.md
index b87691d..ef6d3c5 100644
--- a/guide/ops/logging.md
+++ b/guide/ops/logging.md
@@ -79,6 +79,62 @@
Log4j can be configured to write to syslog using the SyslogAppender
which can then [feed its logs to Logstash](http://www.logstash.net/docs/1.4.2/inputs/syslog).
+## Logbook
+
+The logbook offers the possibility to query and view logs in the UI. By default, logs are stored in files as per configuration
+in `etc/org.ops4j.pax.logging.cfg`. The logbook can be configured against different log aggregation sources by adding the
+following parameters in `brooklyn.cfg`:
+
+* plain log files
+
+ brooklyn.logbook.logStore=org.apache.brooklyn.util.core.logbook.file.FileLogStore
+ brooklyn.logbook.fileLogStore.path=/var/logs/brooklyn/brooklyn.debug.log
+
+* or Elasticsearch released under the Apache License, version 2.0 fork created by AWS
+
+ brooklyn.logbook.logStore=org.apache.brooklyn.util.core.logbook.opensearch.OpenSearchLogStore
+ brooklyn.logbook.openSearchLogStore.host=https://localhost:9200
+ brooklyn.logbook.openSearchLogStore.index=brooklyn
+ brooklyn.logbook.openSearchLogStore.user=admin
+ brooklyn.logbook.openSearchLogStore.password=admin
+ brooklyn.logbook.openSearchLogStore.verifySsl=false
+
+Users with `root` entitlement only can query and view logs in the logbook.
+
+Logbook UI widget can be found in About section where all logs can be viewed, as well as in App Inspector Entity view and
+Activity view where logs filtered by entity ID and activity ID respectively.
+
+### Elasticsearch setup
+
+Refer to the [official documentation](https://opendistro.github.io/for-elasticsearch/downloads.html#try) for
+ installation guide. [Fluentd](https://www.fluentd.org/download) daemon can be configured to read the log files
+for Elasticsearch. See example of Fluentd `td-agent.conf` below:
+
+```
+<source>
+ @type tail
+ @id input_tail_brooklyn
+ @log_level debug
+ <parse>
+ @type multiline
+ format1 /^(?<timestamp>\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}) (?<taskId>\S+)?-(?<entityIds>\S+)? (?<level>\w{4} |\w{5})\W{1,4}(?<bundleId>\d{1,3}) (?<class>(?:\S\.)*\S*) \[(?<threadName>\S+)\] (?<message>.*)/
+ time_format %Y-%m-%dT%H:%M:%S,%L
+ </parse>
+ path /var/logs/brooklyn/brooklyn.debug.log
+ pos_file /var/log/td-agent/brooklyn.debug.log.pos
+ tag td.apachebrokyn.debug
+</source>
+<match td.apachebrokyn.*>
+ @type elasticsearch
+ hosts https://localhost:9200
+ user admin
+ password admin
+ ssl_verify false
+ logstash_format false
+ index_name brooklyn
+</match>
+```
+
## For More Information
The following resources may be useful when configuring logging:
