Skip to content

Commit 84e9f31

Browse files
committed
chore: update docs
1 parent f00f122 commit 84e9f31

File tree

4 files changed

+25
-2
lines changed

4 files changed

+25
-2
lines changed

app.example.ini

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ EnableHTTPS = false
1010
EnableH2 = false
1111
EnableH3 = false
1212

13-
1413
[database]
1514
Name = database
1615

@@ -72,7 +71,7 @@ IndexPath =
7271
; This controls how often nginx-ui scans access logs for new data and performs
7372
; incremental indexing. Lower values keep analytics closer to real-time but
7473
; increase background CPU usage. Higher values reduce CPU usage at the cost
75-
; of more stale analytics data.
74+
; of more stale analytics data. Values <= 0 fall back to the default 15 minutes.
7675
IncrementalIndexInterval = 15
7776

7877
[node]

docs/guide/config-nginx-log.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,14 @@ When `IndexingEnabled` is set to `false`, Nginx UI still discovers log entries f
2828
- By default, Bleve index files are stored in the `log-index` directory located under your Nginx UI config directory (for example, `/usr/local/nginx-ui/log-index`).
2929
- If the config directory cannot be determined, the fallback path is `./log-index` relative to the application.
3030

31+
### IncrementalIndexInterval
32+
33+
- Type: `int` (minutes)
34+
- Default: `15` when the value is `0` or negative
35+
- Version: `>= v2.2.0`
36+
37+
Controls how frequently the incremental indexing job scans access logs for new entries. Lower values keep analytics closer to real time but increase background CPU usage; higher values reduce CPU load at the cost of staler analytics data. Set `0` or a negative value to use the safe default of 15 minutes.
38+
3139
## System Requirements
3240

3341
### Minimum Requirements

docs/zh_CN/guide/config-nginx-log.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,14 @@
2828
- 默认情况下,Bleve 索引文件存放在 Nginx UI 配置目录下的 `log-index` 目录(例如:`/usr/local/nginx-ui/log-index`)。
2929
- 如果无法确定配置目录,回退路径为应用相对路径的 `./log-index`
3030

31+
### IncrementalIndexInterval
32+
33+
- 类型:`int`(分钟)
34+
- 默认值:当配置为 `0` 或负数时使用 `15`
35+
- 版本:`>= v2.2.0`
36+
37+
控制增量索引任务扫描访问日志的频率。数值越小,分析数据越接近实时,但后台 CPU 占用越高;数值越大则降低 CPU 占用,但分析数据更新会更滞后。配置为 `0` 或负数时会自动回退到安全的默认 15 分钟。
38+
3139
## 系统要求
3240

3341
### 最低要求

docs/zh_TW/guide/config-nginx-log.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,14 @@
2828
- 預設情況下,Bleve 索引檔存放於 Nginx UI 設定目錄下的 `log-index` 目錄(例如:`/usr/local/nginx-ui/log-index`)。
2929
- 若無法判定設定目錄,則回退至應用相對路徑的 `./log-index`
3030

31+
### IncrementalIndexInterval
32+
33+
- 類型:`int`(分鐘)
34+
- 預設值:設定為 `0` 或負數時使用 `15`
35+
- 版本:`>= v2.2.0`
36+
37+
控制增量索引任務掃描存取日誌的頻率。數值越小,分析資料越接近即時,但背景 CPU 使用率越高;數值越大則降低 CPU 負載,但分析資料更新會更滯後。設定為 `0` 或負數時會自動回退到安全的預設 15 分鐘。
38+
3139

3240
## 系統需求
3341

0 commit comments

Comments
 (0)