jcabrerizo commented on a change in pull request #324:
URL: https://github.com/apache/brooklyn-docs/pull/324#discussion_r693077545
##########
File path: guide/ops/logging.md
##########
@@ -73,24 +73,43 @@ For example (on mac):
mv $LOG_FILE /path/to/archive/brooklyn.debug-$TIMESTAMP.log.zip
-## Logging aggregators
+## Logging Aggregators
Integration with systems like Logstash and Splunk is possible using standard
log4j configuration.
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`:
+in `etc/org.ops4j.pax.logging.cfg`. The logbook can be configured against
different log aggregation sources by setting the
+`brooklyn.logbook.logStore` parameter in `brooklyn.cfg`, and depending which
backend is used, other parameters.
-* plain log files
+For example to use the local log files written by Apache Brooklyn, you could
configure:
Review comment:
This is also the default configuration
##########
File path: guide/ops/logging.md
##########
@@ -73,24 +73,43 @@ For example (on mac):
mv $LOG_FILE /path/to/archive/brooklyn.debug-$TIMESTAMP.log.zip
-## Logging aggregators
+## Logging Aggregators
Integration with systems like Logstash and Splunk is possible using standard
log4j configuration.
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`:
+in `etc/org.ops4j.pax.logging.cfg`. The logbook can be configured against
different log aggregation sources by setting the
+`brooklyn.logbook.logStore` parameter in `brooklyn.cfg`, and depending which
backend is used, other parameters.
-* plain log files
+For example to use the local log files written by Apache Brooklyn, you could
configure:
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
+In production environments where log data is desired to be retained, Apache
Brooklyn supports Elasticsearch backends.
+This can be a dedicated ES environment for use by Apache Brooklyn or a
shared/managed ES facility that handles many logs,
+or -- for lightweight usage -- a simple local ES server running on the same
instance as Apache Brooklyn.
+As with any log storage requirement, the sizing, scaling, backup and
maintenance of the logging environment
+requires careful attention. Elasticsearch includes numerous options to
configure these, with one suggested configuration
+outlined in more detail below.
+
+By default, only users with the `root` entitlement or an explicit `logViewer`
entitlement are able to see log info through Apache Brooklyn.
Review comment:
`root` **or** `powerUser`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
