Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 20 additions & 3 deletions docs/environment-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,11 @@ OpenObserve is configured using the following environment variables.
| 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. |
| 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. |
| 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. |
| ZO_NODE_ROLE_GROUP | "" | Each query-processing node can be assigned to a specific group using ZO_NODE_ROLE_GROUP. <br>
**interactive**: Handles queries triggered directly by users through the UI. <br>
**background**: Handles automated or scheduled queries, such as alerts and reports. <br>
**empty string** (default): Handles all query types. <br>
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. |
| ZO_NODE_HEARTBEAT_TTL | 30 | Time-to-live (TTL) for node heartbeats in seconds. |
| ZO_INSTANCE_NAME | - | In the cluster mode, each node has a instance name. Default is instance hostname. |
| ZO_CLUSTER_COORDINATOR | nats | Defines how nodes in the cluster discover each other. |
Expand Down Expand Up @@ -82,7 +87,19 @@ OpenObserve is configured using the following environment variables.
| ZO_FILE_MOVE_FIELDS_LIMIT | 2000 | Field count threshold per WAL file. If exceeded, merging is skipped on the ingester. |
| 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. |
| ZO_MEM_PERSIST_INTERVAL | 5 | Interval in seconds at which immutable memtables are persisted from memory to disk. Default is 5 seconds. |

| 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. |
| 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>
**When ZO_FEATURE_SHARED_MEMTABLE_ENABLED is true (shared memtable enabled)**:
<br>
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>
**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.
<br>
**When ZO_FEATURE_SHARED_MEMTABLE_ENABLED is false (shared memtable disabled)**:
<br>
Each organization creates its own set of in-memory tables based on the ZO_MEM_TABLE_BUCKET_NUM value.
<br>
For example, if ZO_MEM_TABLE_BUCKET_NUM is set to 4, each organization will create 4 separate in-memory tables.
This is particularly useful when you have only one organization, as creating multiple in-memory tables for that single organization can improve ingestion performance.|

## Indexing
| Environment Variable | Default Value | Description |
Expand Down Expand Up @@ -573,9 +590,9 @@ OpenObserve is configured using the following environment variables.
| Environment Variable | Default Value | Description |
| -------------------------------- | --------- | ------------------------------------------------------- |
| ZO_QUICK_MODE_ENABLED | false | Indicates if quick mode is enabled. |
| ZO_QUICK_MODE_NUM_FIELDS | 500 | The number of fields to consider for quick mode. |
| ZO_QUICK_MODE_STRATEGY | | Possible values are `first`, `last`, `both`. |
| ZO_QUICK_MODE_FORCE_ENABLED | true | |
| 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.|
| ZO_QUICK_MODE_NUM_FIELDS | 500 | This defines the number of fields beyond which the quick mode will be force enabled. |

## Miscellaneous
| Environment Variable | Default Value | Description |
Expand Down
Binary file added docs/images/add-new-fields.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/analyze-results.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/built-in-patterns-import.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/cached-ratio-dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/chart-align-options.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/dashboard-query-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/delete-fields.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/example-1-query-recommendations.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/example-2-query-recommendations.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/execution-tree.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/explain-query.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/field-name-data-type.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/filter-by-tags.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/gridlines-off.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/import-selected-patterns.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/legend-height-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/legend-position-bottom.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/legend-position-right.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/legend-type-plain.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/legend-type-scroll.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/legend-width-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/logical-plan.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/manage-patterns.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/pattern-detail-view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/physical-plan.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/search-patterns.png
Binary file added docs/images/select-patterns.png
Binary file modified docs/images/select-query-recommendations.png
Binary file added docs/images/update-settings.png
Binary file modified docs/images/use-query-recommendations.png
2 changes: 1 addition & 1 deletion docs/user-guide/.pages
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
nav:
- Concepts: concepts.md
- Log Search: logs
- Logs: logs
- Metrics: metrics
- Streams: streams
- Ingestion: ingestion
Expand Down
1 change: 1 addition & 0 deletions docs/user-guide/dashboards/.pages
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ nav:
- Filters: filters
- Comparison Against in Dashboards: comparison-against-in-dashboards.md
- Custom Charts: custom-charts
- Histogram Caching: histogram-caching.md



170 changes: 170 additions & 0 deletions docs/user-guide/dashboards/config/legend-and-gridline.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,170 @@
This document describes the legend and gridline configuration options available in OpenObserve dashboard panels.

## Overview
Dashboard panels include configuration options for controlling legend display and gridline visibility. These options help optimize chart readability and space usage.

## Legend configuration options
The following options are available in the panel configuration sidebar under the legend section.

### Legends positions

Controls the placement of the legend relative to the chart.

| Option | Description |
|--------|-------------|
| Auto | Places the legend at the bottom of the chart (default) |
| Right | Places the legend on the right side of the chart |
| Bottom | Places the legend below the chart |

**Example: Legend positioned on the right**

![Legend positioned on right side of chart](../../images/legend-position-right.png)

When set to **Right**, the legend appears vertically alongside the chart. This configuration is useful for charts with many data series.

**Example: Legend positioned at the bottom**

![Legend positioned at bottom of chart](../../images/legend-position-bottom.png)

When set to **Bottom**, the legend appears horizontally below the chart. This is the default position and works well for most chart types.

### Legends type

Controls the legend display behavior.

| Option | Description |
|--------|-------------|
| Auto | Automatically selects scroll behavior (default) |
| Plain | Displays all legend items in a static, non-scrollable layout |
| Scroll | Enables scrolling through legend items when space is limited |

**Plain behavior:**

- All legend items are visible simultaneously
- Legend height adjusts to fit all items
- No pagination controls

**Example: Plain legend type**

![Plain legend showing all items](./images/legend-type-plain.png)

The plain type displays all legend items in a fixed layout. All series are visible at once without scrolling.

**Scroll behavior:**

- Legend items can be scrolled
- Pagination indicator shows current page
- Navigation arrows allow moving between pages
- Conserves vertical space

**Example: Scroll legend type**

![Scroll legend with pagination](./images/legend-type-scroll.png)

The scroll type includes navigation arrows and a page indicator (shown as "1/2" in the bottom right). Users can navigate between pages of legend items.

### Legend height

- **Input:** Enter numeric input.
- **Units:** Choose between px (pixels) or % (percentage).
- **Availability:** Enabled only when Legends Position is set to Auto or Bottom and Legend Type is set to Plain.
- **Purpose:** Overrides the default height of the legend area.

**Example: Legend height configuration**

![Legend height setting in UI](../../images/legend-height-config.png)


### Legend width

- **Input:** Enter numeric input.
- **Units:** Choose between px (pixels) or % (percentage).
- **Availability:** Enabled only when Legends Position is set to Right and Legend Type is set to Plain.
- **Purpose:** Overrides the default width of the legend area.

**Example: Legend width configuration**

![Legend width setting in UI](../../images/legend-width-config.png)


### Chart align

Controls the horizontal alignment of the chart within its container.

| Option | Description |
|--------|-------------|
| Auto | Centers the chart (default) |
| Left | Aligns the chart to the left |
| Center | Centers the chart |

**Note:** This option is only available for pie and donut charts when legends position is set to "Right".

**Example: Chart align options for pie chart**

![Chart align dropdown showing Auto, Left, and Center options](../../images/chart-align-options.png)

Legends Position is set to Right and Legend Type is set to Plain. You can select how the chart is horizontally aligned within the remaining space.


## Gridline configuration

### Show gridlines

A toggle switch that controls gridline visibility on the chart.

- **Type:** Boolean toggle (on/off)
- **Default:** On
- **Effect:** When enabled, displays horizontal and vertical reference lines on the chart.

**Example: Gridlines disabled**

![Chart without gridlines](../../images/gridlines-off.png)

When gridlines are disabled, the chart displays without reference lines, providing a cleaner appearance.


## Chart type support

### Legend options

Legend configuration is available for:

- Line chart
- Area chart (stacked and unstacked)
- Bar chart (vertical and horizontal)
- Scatter plots
- Stacked chart (vertical and horizontal)
- Pie chart
- Donut chart

Legend configuration is not available for:

- Table chart
- Heatmaps
- Metric chart
- Gauge chart
- Geomap chart
- Sankey chart
- Map chart

### Gridlines option

The show gridlines option is available for:

- Line chart
- Area chart (stacked and unstacked)
- Bar chart (vertical and horizontal)
- Scatter plots
- Stacked chart (vertical and horizontal)

The show gridlines option is not available for:

- Pie chart
- Donut chart
- Heatmaps
- Table chart
- Metric chart
- Gauge chart
- Geomap chart
- Sankey chart
- Map chart
Loading
Loading