Skip to content

Commit cf0d8e7

Browse files
update docs (#252)
Built in regex pattern Legend and gridline config in dashboards Env var for shared memtable Partial data error in dashboards Explore and analyze feature Incorporate changes after aggregation cache and streaming aggregation are removed from UI
1 parent 8c56bb4 commit cf0d8e7

33 files changed

+502
-86
lines changed

docs/environment-variables.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,19 @@ In high-load environments, alerts or reports might run large, resource-intensive
8787
| ZO_FILE_MOVE_FIELDS_LIMIT | 2000 | Field count threshold per WAL file. If exceeded, merging is skipped on the ingester. |
8888
| ZO_MEM_TABLE_MAX_SIZE | 0 | Total size limit of all memtables. Multiple memtables exist for different organizations and stream types. Each memtable cannot exceed ZO_MAX_FILE_SIZE_IN_MEMORY, and the combined size cannot exceed this limit. If exceeded, the system returns a MemoryTableOverflowError to prevent out-of-memory conditions. Default is 50 percent of total memory. |
8989
| ZO_MEM_PERSIST_INTERVAL | 5 | Interval in seconds at which immutable memtables are persisted from memory to disk. Default is 5 seconds. |
90-
90+
| ZO_FEATURE_SHARED_MEMTABLE_ENABLED | false | When set to true, it turns on the shared memtable feature and several organizations can use the same in-memory table instead of each organization creating its own. This helps reduce memory use when many organizations send data at the same time. It also works with older non-shared write-ahead log (WAL) files. |
91+
| ZO_MEM_TABLE_BUCKET_NUM | 1 | This setting controls how many in-memory tables OpenObserve creates, and works differently depending on whether shared memtable is enabled or disabled. <br>
92+
**When ZO_FEATURE_SHARED_MEMTABLE_ENABLED is true (shared memtable enabled)**:
93+
<br>
94+
OpenObserve creates the specified number of shared in-memory tables that all organizations use together. <br> **If the number is higher**: OpenObserve creates more shared tables. Each table holds data from fewer organizations. This can make data writing faster because each table handles less data. However, it also uses more memory. <br>
95+
**If the number is lower**: OpenObserve creates fewer shared tables. Each table holds data from more organizations. This saves memory but can make data writing slightly slower when many organizations send data at the same time.
96+
<br>
97+
**When ZO_FEATURE_SHARED_MEMTABLE_ENABLED is false (shared memtable disabled)**:
98+
<br>
99+
Each organization creates its own set of in-memory tables based on the ZO_MEM_TABLE_BUCKET_NUM value.
100+
<br>
101+
For example, if ZO_MEM_TABLE_BUCKET_NUM is set to 4, each organization will create 4 separate in-memory tables.
102+
This is particularly useful when you have only one organization, as creating multiple in-memory tables for that single organization can improve ingestion performance.|
91103

92104
## Indexing
93105
| Environment Variable | Default Value | Description |

docs/images/analyze-results.png

128 KB
Loading
642 KB
Loading
842 KB
Loading

docs/images/execution-tree.png

152 KB
Loading

docs/images/explain-query.png

658 KB
Loading

docs/images/filter-by-tags.png

379 KB
Loading

docs/images/gridlines-off.png

720 KB
Loading
323 KB
Loading
700 KB
Loading

0 commit comments

Comments
 (0)