You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
New docs: Query recommendations and Histogram caching. Update docs: Env variables page, Schema settings... (#251)
* update docs (#250)
* 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
Copy file name to clipboardExpand all lines: docs/environment-variables.md
+20-3Lines changed: 20 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,6 +15,11 @@ OpenObserve is configured using the following environment variables.
15
15
| ZO_LOCAL_MODE | true | If local mode is set to true, OpenObserve becomes single node deployment.If it is set to false, it indicates cluster mode deployment which supports multiple nodes with different roles. For local mode one needs to configure SQLite DB, for cluster mode one needs to configure PostgreSQL (recommended) or MySQL. |
16
16
| ZO_LOCAL_MODE_STORAGE | disk | Applicable only for local mode. By default, local disk is used as storage. OpenObserve supports both disk and S3 in local mode. |
17
17
| ZO_NODE_ROLE | all | Node role assignment. Possible values are ingester, querier, router, compactor, alertmanager, and all. A single node can have multiple roles by specifying them as a comma-separated list. For example, compactor, alertmanager. |
18
+
| ZO_NODE_ROLE_GROUP | "" | Each query-processing node can be assigned to a specific group using ZO_NODE_ROLE_GROUP. <br>
19
+
**interactive**: Handles queries triggered directly by users through the UI. <br>
20
+
**background**: Handles automated or scheduled queries, such as alerts and reports. <br>
21
+
**empty string** (default): Handles all query types. <br>
22
+
In high-load environments, alerts or reports might run large, resource-intensive queries. By assigning dedicated groups, administrators can prevent such queries from blocking or slowing down real-time user searches. |
18
23
| ZO_NODE_HEARTBEAT_TTL | 30 | Time-to-live (TTL) for node heartbeats in seconds. |
19
24
| ZO_INSTANCE_NAME | - | In the cluster mode, each node has a instance name. Default is instance hostname. |
20
25
| ZO_CLUSTER_COORDINATOR | nats | Defines how nodes in the cluster discover each other. |
@@ -82,7 +87,19 @@ OpenObserve is configured using the following environment variables.
82
87
| ZO_FILE_MOVE_FIELDS_LIMIT | 2000 | Field count threshold per WAL file. If exceeded, merging is skipped on the ingester. |
83
88
| 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. |
84
89
| ZO_MEM_PERSIST_INTERVAL | 5 | Interval in seconds at which immutable memtables are persisted from memory to disk. Default is 5 seconds. |
85
-
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.|
86
103
87
104
## Indexing
88
105
| Environment Variable | Default Value | Description |
@@ -573,9 +590,9 @@ OpenObserve is configured using the following environment variables.
573
590
| Environment Variable | Default Value | Description |
| ZO_QUICK_MODE_ENABLED | false | Indicates if quick mode is enabled. |
576
-
| ZO_QUICK_MODE_NUM_FIELDS | 500 | The number of fields to consider for quick mode. |
577
593
| ZO_QUICK_MODE_STRATEGY || Possible values are `first`, `last`, `both`. |
578
-
| ZO_QUICK_MODE_FORCE_ENABLED | true ||
594
+
| ZO_QUICK_MODE_FORCE_ENABLED | true | Enables automatic activation of Quick Mode from the backend. When set to true, OpenObserve applies Quick Mode automatically if the number of fields in a stream exceeds the limit defined by `ZO_QUICK_MODE_NUM_FIELDS`, even when the Quick Mode toggle in the UI is turned off.|
595
+
| ZO_QUICK_MODE_NUM_FIELDS | 500 | This defines the number of fields beyond which the quick mode will be force enabled. |
579
596
580
597
## Miscellaneous
581
598
| Environment Variable | Default Value | Description |
0 commit comments