Skip to content

Commit cebe8ff

Browse files
update docs
1 parent 28de7d0 commit cebe8ff

File tree

10 files changed

+65
-50
lines changed

10 files changed

+65
-50
lines changed

docs/.pages

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ nav:
55
- Enterprise Edition Installation: openobserve-enterprise-edition-installation-guide.md
66
- Releases: releases.md
77
- Example Queries: example-queries.md
8-
- SQL SQL Function Reference: sql_reference.md
8+
- SQL Function Reference: sql_reference.md
99
- Architecture: architecture.md
1010
- HA Deployment: ha_deployment.md
1111
- Environment Variables: environment-variables.md

docs/data-management/storage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ By default:
1010

1111
- Metadata is always stored on disk using **SQLite** in **Local mode**.
1212
- Metadata is always stored on disk using **postgres** in **Cluster mode**.
13-
- Stream data can be stored on disk or S3-compatible object storage such as Amazon S3, minIO, Google GCS, Alibaba OSS, or Tencent COS.
13+
- Stream data can be stored on disk or object storage such as Amazon S3, minIO, Google GCS, Alibaba OSS, or Tencent COS.
1414

1515
## Storage Modes
1616

docs/openobserve-enterprise-edition-installation-guide.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1+
## Deploy OpenObserve Enterprise Edition as a Highly Available (HA) installation using Helm.
2+
13
This guide explains how to deploy [OpenObserve Enterprise Edition](https://openobserve.ai/downloads/) in a **Kubernetes** environment using **Helm**.
24

3-
> These instructions use Amazon EKS and S3 for demonstration, but the deployment works with any Kubernetes platform such as GKE or AKS, and other S3-compatible storage services such as Azure Blob, MinIO, or GCS.
5+
> These instructions use Amazon EKS and S3 for demonstration, but the deployment works with any Kubernetes environment, such as GKE or AKS, and other object storage services such as Azure Blob, MinIO, or GCS.
46
57
> For support, reach out in the [Slack channel](https://short.openobserve.ai/community).
68
@@ -13,7 +15,7 @@ This guide explains how to deploy [OpenObserve Enterprise Edition](https://openo
1315
- **Dex and OpenFGA** enable Single Sign-On (SSO) and Role-Based Access Control (RBAC).
1416

1517

16-
## Installation Steps
18+
### Installation Steps
1719
Follow these steps to install OpenObserve Enterprise Edition:
1820

1921

@@ -158,10 +160,9 @@ Follow these steps to install OpenObserve Enterprise Edition:
158160
helm --namespace openobserve -f values.yaml install o2 openobserve/openobserve
159161
```
160162

161-
**After installation, Helm will output a kubectl port-forward command. Run the command and open http://localhost:<port>/ in your browser.**
162-
163-
**Installation complete**
164-
OpenObserve is now running in your Kubernetes cluster. You can log in using the root user credentials and begin configuring data streams, dashboards, and alerting.
165-
163+
After installation, the output displays a `kubectl port-forward` command. Run that command and then open `http://localhost:<port>` in your browser, replacing `<port>` with the actual port number shown.
166164

165+
OpenObserve is now running in your Kubernetes cluster. Log in using the root user credentials configured in Step 5 to start using OpenObserve.
167166

167+
!!! info "Note"
168+
OpenObserve also provides an Infrastructure as Code (IAC) workflow using [Terraform](https://www.terraform.io/downloads.html) or [OpenTofu](https://opentofu.org/docs/intro/install/). This streamlines the deployment of Amazon Elastic Kubernetes Service (EKS) and OpenObserve in HA mode. It enables teams to quickly provision and manage OpenObserve infrastructure in Amazon EKS using prebuilt, flexible modules. To explore this option, visit the [openobserve-eks-iac repository](https://github.com/openobserve/openobserve-eks-iac).

docs/sql_reference.md

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,33 @@
1-
# Functions
1+
This guide describes the custom SQL functions supported in OpenObserve for querying and processing logs and time series data. These functions extend the capabilities of standard SQL by enabling full-text search, array processing, and time-based aggregations.
22

3-
## FUll text search functions
3+
## Full-text Search Functions
4+
These functions allow you to filter records based on keyword or pattern matches within one or more fields.
45

5-
### str_match(field, 'v')
6+
### `match_field(field, 'value')`
7+
**Alias for**: `str_match(field, 'v')` <br>
8+
**Description**: <br>
9+
Filters logs by matching the exact string value within the specified field. The match is case-sensitive. <br>
10+
**Example**:
11+
```sql
12+
SELECT * FROM logs WHERE match_field("status", 'Success')
13+
```
14+
This filters logs where the status field contains the string 'Success'. It does not match 'success' or 'SUCCESS'.
615

7-
filter the keyword in the field.
16+
### `match_field_ignore_case(field, 'value')`
17+
**Alias for**: `str_match_ignore_case` <br>
18+
**Description**: <br>
19+
Filters logs by matching the string value within the specified field, ignoring case. The match is case-insensitive. <br>
20+
**Example**:
21+
```sql
22+
SELECT * FROM logs WHERE match_field_ignore_case("status", 'success')
23+
```
24+
This matches logs where the status field contains 'success', 'Success', 'SUCCESS', or any other casing variation.
825

9-
### str_match_ignore_case(field, 'v')
1026

11-
filter the keyword in the field with case_insensitive. it can match `KeyWord` or `keyWord`.
1227

1328
### match_all('v')
14-
15-
filter the keyword in the fields, whose **Index Type** is set to `Full text search` in streams settings. To utilize Inverted Index, you must set environment variable `ZO_ENABLE_INVERTED_INDEX` to `true` first,
29+
**Description**: <br>
30+
Filters the keyword in the fields, whose **Index Type** is set to `Full text search` in streams settings. To utilize Inverted Index, you must set environment variable `ZO_ENABLE_INVERTED_INDEX` to `true` first,
1631
then you can specify Index Type for one or multiple fields (e.g. `body`, `message`) to `Inverted Index` by going to stream settings.
1732

1833
> We have default fields: `log`, `message`, `msg`, `content`, `data`, `json`. you can set the full text search fields in the UI or through `index.setting` API.

docs/user-guide/dashboards/manage-dashboards.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,5 +71,3 @@ In the Tabs section, you can add, edit, and delete Tabs within the Dashboard.
7171
![tabs](../../images/dashboard-manage-5.png)
7272

7373

74-
FAQs
75-
Q: Why does my dashboard chart say "No data"?

docs/user-guide/dashboards/panels/panel-management.md

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
This guide explains how to use and manage panels in the dashboard. It includes features available in the panel toolbar, step-by-step instructions, and troubleshooting tips for common issues.
22

3-
## Panel Toolbar Features
4-
53
The panel toolbar offers the following controls to adjust, organize, and customize your panels:
64

75
## Viewing and Refresh Controls
@@ -14,6 +12,17 @@ Maximizes the panel to cover the entire display, providing an expanded view. <br
1412
- To expand the view, click the **Full Screen Mode** button in the panel toolbar.
1513
- To exit **Full Screen Mode**, press **Escape** on your keyboard.
1614

15+
### Information Icon
16+
The information icon on panel shows the description of the panel. <br>
17+
![Panel Description](../../../images/manage-panels-panel-description.png)
18+
19+
**To add, edit, or remove a panel description:**
20+
21+
1. In the panel toolbar, open the dropdown menu and select **Edit Panel**.
22+
2. On the right side of the screen, select the **Config** tab.
23+
3. Under **Description**, enter, update, or delete the panel description as needed.
24+
4. Select **Apply** to save your changes.
25+
1726
### Last Refreshed At
1827
Displays the timestamp of when the panel’s data was last updated. <br>
1928
**How to Use:** Hover over the timestamp icon to view the time when the panel was last refreshed.
@@ -103,11 +112,9 @@ Allows you to add notes to selected data points or time ranges across multiple p
103112

104113
- Use the dropdown menu to select panels. You can apply annotations across multiple panels based on your selection.
105114
- If you do not select any panel, the annotation applies to all panels for the selected time range, within the dashboard by default.
106-
107-
![Select Panels](../../../images/manage-panels-select-panels.png)
115+
![Select Panels](../../../images/manage-panels-select-panels.png)
108116

109117
5. **Save Annotation.**
110-
111118
![Save Annotation](../../../images/manage-panels-save-annotations.png)
112119

113120

@@ -120,13 +127,3 @@ Allows you to add notes to selected data points or time ranges across multiple p
120127
![Delete Annotations](../../../images/manage-panels-delete-annotations.png)
121128

122129

123-
!!! Note
124-
Information icon on panel shows the description of the panel.
125-
![Panel Description](../../../images/manage-panels-panel-description.png)
126-
127-
**To add, edit, or remove a panel description:**
128-
129-
1. In the panel toolbar, open the dropdown menu and select **Edit Panel**.
130-
2. On the right side of the screen, select the **Config** tab.
131-
3. Under **Description**, enter, update, or delete the panel description as needed.
132-
4. Select **Apply** to save your changes.

docs/user-guide/identity-and-access-management/organizations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
This guide explains how organizations work in OpenObserve. It covers organization types, creation methods, identifiers, access control, and switching behavior.
1+
This guide explains how organizations work in OpenObserve. It covers organization types, creation methods, identifiers, access control, and limitations.
22

33
## Overview
44
Organizations provide logical boundaries for separating data, users, and access controls, enabling secure multi-tenant usage in a single OpenObserve deployment.

docs/user-guide/streams/extended-retention.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Extended Retention
22

3-
The Extended Retention feature in the Stream Details panel allows you to retain specific segments of your stream data beyond the configured stream-level or global retention period.
3+
The Extended Retention feature in **Stream Details** allows you to retain specific segments of your stream data beyond the configured stream-level or global retention period.
44

55
## When to Use Extended Retention
66

@@ -9,10 +9,11 @@ For example, logs from a known incident that occurred last month, you can config
99

1010
## How to Apply Extended Retention
1111

12-
1. Navigate to the **Stream Details** panel.
13-
2. Select the **Extended Retention** tab.
14-
3. Use the date selector to specify a time range in UTC. Click **Apply**.
15-
4. Click **Update Settings** to apply the retention policy.
12+
1. From the **Streams** page, select the **Explore** icon from the **Actions** column.
13+
2. Navigate to [**Stream Details**](../../user-guide/streams/stream-details.md/#access-the-stream-details).
14+
3. Select the **Extended Retention** tab.
15+
4. Use the date selector to specify a time range in UTC. Click **Apply**.
16+
5. Click **Update Settings** to apply the retention policy.
1617

1718
!!! Note
1819
The data within the selected time range will be retained for an additional 3,650 days.

docs/user-guide/streams/schema-settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
The **Schema Settings** tab in the [Stream Details](stream-details.md) panel allows you to inspect and manage the schema used to store and query ingested data. A schema defines the structure of log data in a stream, including:
1+
The **Schema Settings** tab in [Stream Details](stream-details.md) allows you to inspect and manage the schema used to store and query ingested data. A schema defines the structure of log data in a stream, including:
22

33
- The fields present in the logs
44
- The detected data types for each field

docs/user-guide/streams/stream-details.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
1-
After data [ingestion is complete](streams-in-openobserve.md/#ingest-data-into-stream), you can view detailed information about a stream using the **Stream Details** panel.
2-
This guide explains how to access the **Stream Details** panel and the information available in the panel.
1+
After After you complete [data ingestion](streams-in-openobserve.md/#ingest-data-into-stream), use **Stream Details** to view configuration and usage information for a stream and update its settings.
32

4-
## Access
5-
From the Streams page, select the **Explore** icon from the **Actions** column.
6-
![stream details access](../../images/stream-details-access.png)
3+
This guide explains how to open **Stream Details** and the information it displays.
74

8-
This opens the **Stream Details** panel, which provides configuration details, schema settings, and extended retention options.
5+
## Access the Stream Details
6+
From the **Streams** page, select the **Explore** icon from the **Actions** column.
7+
![stream details access](../../images/stream-details-access.png)
98

109
## Permission
11-
1210
User roles that have permission to update Streams can modify the stream settings from the **Stream Details** page. The permission needs to be assigned to appropriate user roles using role-based access control (RBAC).
1311

1412
![stream details permission](../../images/stream-details-permission.png)
1513

1614
## Stream Details
17-
The **Stream Details** panel displays key configuration and usage information for the selected stream:
15+
**Stream Details** shows key configuration and usage information for the selected stream:
1816

1917
![stream details](../../images/stream-details.png)
2018

@@ -42,10 +40,15 @@ The **Stream Details** panel displays key configuration and usage information fo
4240
```
4341
ZO_DEFAULT_MAX_QUERY_RANGE_DAYS
4442
```
45-
> However, when a non-zero Max query range is set on a stream, the value set from the Stream Details panel overrides the global value. <br> By default, both the environment variable and **Max Query Range** in the UI is set to zero (o), which means no limit.
43+
> However, when a non-zero Max query range is set on a stream, the value set through **Stream Details** overrides the global value. <br> By default, both the environment variable and the **Max Query Range** value are set to zero, which means there is no limit.
4644
4745
- **Use Stream Stats for Partitioning**: When you enable this toggle, OpenObserve assumes that all your data present in the stream is equally split and creates equal sized partitions between the start and end time.
4846
47+
## Troubleshooting
48+
49+
- If stream details appear blank, verify that the data has been successfully ingested.
50+
- Ensure you have the necessary role permissions to view or modify stream settings.
51+
4952
## Next Steps
5053
5154
- [Schema Settings](schema-settings.md)

0 commit comments

Comments
 (0)