diff --git a/docs/hpfeeds-logger.md b/docs/hpfeeds-logger.md index 89386b3..3b38c1d 100644 --- a/docs/hpfeeds-logger.md +++ b/docs/hpfeeds-logger.md @@ -20,18 +20,28 @@ First, include this stanza in the docker-compose.yml file for CHN-server: ``` Next, add the following hpfeeds-logger.sysconfig configuration file: ```bash -# This file is read from /etc/sysconfig/hpfeeds-cif +# This file is read from /etc/sysconfig/hpfeeds-logger # or /etc/default/hpfeeds-logger, depending on the distro version # # Defaults here are for containers, but can be adjusted # after install for a regular server or to customize the containers -MONGODB_HOST='mongodb' +MONGODB_HOST="mongodb" MONGODB_PORT=27017 -# Log to local file -FILELOG_ENABLED=true -LOG_FILE=/var/log/hpfeeds-logger/chn-splunk.log +# Log to local file; the path is internal to the container and the host filesystem +# location is controlled by volume mapping in the docker-compose.yml +FILELOG_ENABLED="true" +LOG_FILE="/var/log/hpfeeds-logger/chn-splunk.log" + +# Choose to rotate the log file based on 'size'(default) or 'time' +ROTATION_STRATEGY="size" + +# If rotating by 'size', the number of MB to rotate at +ROTATION_SIZE_MAX=100 + +# If rotating by 'time', the number of hours to rotate at +ROTATION_TIME_MAX=24 # Log to syslog SYSLOG_ENABLED=false @@ -52,7 +62,6 @@ FORMATTER_NAME=splunk HPFEEDS_HOST='hpfeeds' HPFEEDS_PORT=10000 - ``` Once the docker-compose.yml is updated and the hpfeeds-logger.sysconfig file is present, start logging with: