From a04bc8061c5dacbc8e42c3415db43e1a7cc78cd1 Mon Sep 17 00:00:00 2001 From: Martyn Taylor Date: Thu, 17 Dec 2015 15:12:20 +0000 Subject: [PATCH] Added documentation for thread-pool-files config --- docs/user-manual/en/configuration-index.md | 2 +- docs/user-manual/en/perf-tuning.md | 17 ++++++++++++----- 2 files changed, 13 insertions(+), 6 deletions(-) diff --git a/docs/user-manual/en/configuration-index.md b/docs/user-manual/en/configuration-index.md index d819d13fd7..175a5dc658 100644 --- a/docs/user-manual/en/configuration-index.md +++ b/docs/user-manual/en/configuration-index.md @@ -54,7 +54,7 @@ Name | Description [journal-file-size](persistence.md) | the size (in bytes) of each journal file. Default=10485760 (10 MB) [journal-max-io](persistence.md#configuring.message.journal.journal-max-io) | the maximum number of write requests that can be in the AIO queue at any one time. Default is 500 for AIO and 1 for NIO. [journal-min-files](persistence.md#configuring.message.journal.journal-min-files) | how many journal files to pre-create. Default=2 -[journal-pool-files](persistence.md#configuring.message.journal.journal-pool-files) | -1 (default) means no Limit. The system will create as many files as needed however when reclaiming files it will shrink back to the `journal-pool-files` +[journal-pool-files](persistence.md#configuring.message.journal.journal-pool-files) | The upper theshold of the journal file pool,-1 (default) means no Limit. The system will create as many files as needed however when reclaiming files it will shrink back to the `journal-pool-files` [journal-sync-non-transactional](persistence.md) | if true wait for non transaction data to be synced to the journal before returning response to client. Default=true [journal-sync-transactional](persistence.md) | if true wait for transaction data to be synchronized to the journal before returning response to client. Default=true [journal-type](persistence.md) | the type of journal to use. Default=ASYNCIO diff --git a/docs/user-manual/en/perf-tuning.md b/docs/user-manual/en/perf-tuning.md index beb387baaf..9cf6dab1ae 100644 --- a/docs/user-manual/en/perf-tuning.md +++ b/docs/user-manual/en/perf-tuning.md @@ -16,11 +16,18 @@ performance. on separate volumes too. - Minimum number of journal files. Set `journal-min-files` to a number - of files that would fit your average sustainable rate. If you see - new files being created on the journal data directory too often, - i.e. lots of data is being persisted, you need to increase the - minimal number of files, this way the journal would reuse more files - instead of creating new data files. + of files that would fit your average sustainable rate. This number + represents the lower threshold of the journal file pool. + +- To set the upper threshold of the journal file pool. (`journal-min-files` being + the lower threshold). Set `journal-pool-files` to a number that represents + something near your maximum expected load. The journal will spill over + the pool should it need to, but will shrink back to the upper threshold, + when possible. This allows reuse of files, without taking up more disk + space than required. If you see new files being created on the journal + data directory too often, i.e. lots of data is being persisted, + you need to increase the journal-pool-size, this way the journal would + reuse more files instead of creating new data files, increasing performance - Journal file size. The journal file size should be aligned to the capacity of a cylinder on the disk. The default value 10MiB should