You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@bookkeeper.apache.org by ch...@apache.org on 2023/03/06 07:02:07 UTC

[bookkeeper] branch master updated: Add directIO entry logger settings documents (#3789)

This is an automated email from the ASF dual-hosted git repository.

chenhang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/bookkeeper.git


The following commit(s) were added to refs/heads/master by this push:
     new 3199fbe4d6 Add directIO entry logger settings documents (#3789)
3199fbe4d6 is described below

commit 3199fbe4d60cc392f58850e8a572d0211c296d9d
Author: Hang Chen <ch...@apache.org>
AuthorDate: Mon Mar 6 15:01:56 2023 +0800

    Add directIO entry logger settings documents (#3789)
    
    ### Motivation
    We have support DirectIO entry logger, but we don't have any user guides to show how to enable and configure the DirectIO entry logger.
    
    ### Modifications
    Add DirectIO Entry logger settings documents.
---
 .github/workflows/website-pr-validation.yml |  5 +++++
 site3/website/docs/reference/config.md      | 13 ++++++++++++-
 2 files changed, 17 insertions(+), 1 deletion(-)

diff --git a/.github/workflows/website-pr-validation.yml b/.github/workflows/website-pr-validation.yml
index 14c115ae04..426552432f 100644
--- a/.github/workflows/website-pr-validation.yml
+++ b/.github/workflows/website-pr-validation.yml
@@ -43,6 +43,11 @@ jobs:
           distribution: 'temurin'
           java-version: 11
 
+      - name: Set up Maven
+        uses: apache/pulsar-test-infra/setup-maven@master
+        with:
+          maven-version: 3.8.7
+
       - name: Setup NodeJS
         uses: actions/setup-node@v2
         with:
diff --git a/site3/website/docs/reference/config.md b/site3/website/docs/reference/config.md
index dcab231f5e..77db2bf1a6 100644
--- a/site3/website/docs/reference/config.md
+++ b/site3/website/docs/reference/config.md
@@ -142,7 +142,7 @@ The table below lists parameters that you can set to configure bookies. All conf
 | allowStorageExpansion | Allow the expansion of bookie storage capacity. Newly added ledger and index directories must be empty. | false | 
 
 
-## Entry log settings
+## Default Entry log settings
 
 | Parameter | Description | Default
 | --------- | ----------- | ------- | 
@@ -156,6 +156,17 @@ The table below lists parameters that you can set to configure bookies. All conf
 | maximumNumberOfActiveEntryLogs | in entryLogPerLedger feature, this specifies the maximum number of entrylogs that can be active at a given point in time. If there are more number of active entryLogs then the maximumNumberOfActiveEntryLogs then the entrylog will be evicted from the cache. | 500 | 
 | entryLogPerLedgerCounterLimitsMultFactor | in EntryLogManagerForEntryLogPerLedger, this config value specifies the metrics cache size limits in multiples of entrylogMap cache size limits. | 10 | 
 
+## DirectIO Entry log settings (Only support DbLedgerStorage)
+
+| Parameter | Description                                                                                                                                                               | Default
+| --------- |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| ------- | 
+| dbStorage_directIOEntryLogger | Enable/Disable directIO entry logger.                                                                                                                                     | false |
+| dbStorage_directIOEntryLoggerTotalWriteBufferSizeMB | Total write buffer size in megabytes for all the entry directories. The write buffer size of each entry directory needs to be divided by the number of entry directories. | 1/8 of max direct memory |
+| dbStorage_directIOEntryLoggerTotalReadBufferSizeMB | Total read buffer size in megabytes for all the entry directories. The read buffer size of each entry directory needs to be divided by the number of entry directories.   | 1/8 of max direct memory |
+| dbStorage_directIOEntryLoggerReadBufferSizeMB | The buffer size, in megabytes, for each direct reader to read data from the entry log file. An entry log file will have only one direct reader.                           | 8 |
+| dbStorage_directIOEntryLoggerMaxFdCacheTimeSeconds | Maximum cache time after a direct reader is accessed.                                                                                                                     | 300 |
+| logSizeLimit | Max file size of entry logger, in bytes. A new entry log file will be created when the old one reaches the file size limitation.                                          | 2147483648 |  
+
 
 ## Entry log compaction settings