Skip to content

Commit

Permalink
Fix logrotate comments
Browse files Browse the repository at this point in the history
  • Loading branch information
danielmitterdorfer committed Nov 19, 2019
1 parent c4d2574 commit dd68f38
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 14 deletions.
21 changes: 14 additions & 7 deletions docs/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -145,13 +145,20 @@ The log file will not be rotated automatically as this is problematic due to Ral
If you are benchmarking source builds of Elasticsearch, Rally will write the log output of the build to ``~/.rally/logs/build.log``. Similarly to the configuration for ``rally.log``, you can use the following ``logrotate`` configuration as a starting point::

/home/user/.rally/logs/build.log {
daily # rotate daily
rotate 7 # keep the last seven log files
maxage 14 # remove logs older than 14 days
compress # compress old logs ...
delaycompress # ... after moving them
missingok # ignore missing log files
notifempty # don't attempt to rotate empty ones
# rotate daily
daily
# keep the last seven log files
rotate 7
# remove logs older than 14 days
maxage 14
# compress old logs ...
compress
# ... after moving them
delaycompress
# ignore missing log files
missingok
# don't attempt to rotate empty ones
notifempty
}

Example
Expand Down
21 changes: 14 additions & 7 deletions docs/migrate.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,20 @@ Build logs are stored in Rally's log directory
If you benchmark source builds of Elasticsearch, Rally has previously stored the build output log in a race-specific directory. With this release, Rally will store build logs in ``/home/user/.rally/logs/build.log``. We recommend to rotate logs with `logrotate <https://linux.die.net/man/8/logrotate>`_. See the following example as a starting point for your own ``logrotate`` configuration and ensure to replace the path ``/home/user/.rally/logs/build.log`` with the proper one::

/home/user/.rally/logs/build.log {
daily # rotate daily
rotate 7 # keep the last seven log files
maxage 14 # remove logs older than 14 days
compress # compress old logs ...
delaycompress # ... after moving them
missingok # ignore missing log files
notifempty # don't attempt to rotate empty ones
# rotate daily
daily
# keep the last seven log files
rotate 7
# remove logs older than 14 days
maxage 14
# compress old logs ...
compress
# ... after moving them
delaycompress
# ignore missing log files
missingok
# don't attempt to rotate empty ones
notifempty
}

Index size and Total Written are not included in the command line report
Expand Down

0 comments on commit dd68f38

Please sign in to comment.