Store build.log in log directory #818
Conversation
With this commit we move Rally's build log from a race-specific directory to its log directory. This file captures Gradle's output when users are benchmarking a source build of Elasticsearch. By moving this file to the log directory it is better visible to users (already in the same location as other log files).
danielmitterdorfer
added
enhancement
|
Marked as breaking as the build log file moves and thus it may have an impact on users. |
| @@ -135,6 +135,18 @@ The log file will not be rotated automatically as this is problematic due to Ral | |||
| notifempty # don't attempt to rotate empty ones | |||
| } | |||
|
|
|||
| 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:: | |||
There was a problem hiding this comment.
When reading this first time, it may not be entirely clear what the logrotate config is for, I suggest we rephrase:
you can use the following
logrotateconfiguration as a starting point::
to
you can use the following
logrotateconfiguration to restrict the volume of the log file::
There was a problem hiding this comment.
I thought that can be inferred based on context (i.e. reading the paragraph above about rally.log).
docs/configuration.rst
Outdated
| 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 |
There was a problem hiding this comment.
In-line comments don't work. They should be in a separate line.
(From man logrotate
Note that comments may appear anywhere in the config file as long as the first non-whitespace character on the line is a #.
)
We need to update also the example for rally.log.
There was a problem hiding this comment.
addressed in dd68f38.
|
Thanks! |
With this commit we continously override a potentially existing Elasticsearch build log. Keeping a history of build logs is not necessary as it is only relevant to investigate on failures. Thus a history only adds complexity (e.g. log rotation setup) for little value. Relates elastic#818
With this commit we move Rally's build log from a race-specific
directory to its log directory. This file captures Gradle's output when
users are benchmarking a source build of Elasticsearch. By moving this
file to the log directory it is better visible to users (already in the
same location as other log files).