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
Copy file name to clipboardExpand all lines: docs/openobserve-enterprise-edition-installation-guide.md
+8-7Lines changed: 8 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,8 @@
1
+
## Deploy OpenObserve Enterprise Edition as a Highly Available (HA) installation using Helm.
2
+
1
3
This guide explains how to deploy [OpenObserve Enterprise Edition](https://openobserve.ai/downloads/) in a **Kubernetes** environment using **Helm**.
2
4
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.
4
6
5
7
> For support, reach out in the [Slack channel](https://short.openobserve.ai/community).
6
8
@@ -13,7 +15,7 @@ This guide explains how to deploy [OpenObserve Enterprise Edition](https://openo
13
15
- **Dex and OpenFGA** enable Single Sign-On (SSO) and Role-Based Access Control (RBAC).
14
16
15
17
16
-
## Installation Steps
18
+
###Installation Steps
17
19
Follow these steps to install OpenObserve Enterprise Edition:
18
20
19
21
@@ -158,10 +160,9 @@ Follow these steps to install OpenObserve Enterprise Edition:
**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.
166
164
165
+
OpenObserve is now running in your Kubernetes cluster. Log in using the root user credentials configured in Step 5 to start using OpenObserve.
167
166
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).
Copy file name to clipboardExpand all lines: docs/sql_reference.md
+23-8Lines changed: 23 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff 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.
2
2
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.
4
5
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'.
6
15
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.
8
25
9
-
### str_match_ignore_case(field, 'v')
10
26
11
-
filter the keyword in the field with case_insensitive. it can match `KeyWord` or `keyWord`.
12
27
13
28
### 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,
16
31
then you can specify Index Type for one or multiple fields (e.g. `body`, `message`) to `Inverted Index` by going to stream settings.
17
32
18
33
> 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.
Copy file name to clipboardExpand all lines: docs/user-guide/dashboards/panels/panel-management.md
+12-15Lines changed: 12 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,5 @@
1
1
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.
2
2
3
-
## Panel Toolbar Features
4
-
5
3
The panel toolbar offers the following controls to adjust, organize, and customize your panels:
6
4
7
5
## Viewing and Refresh Controls
@@ -14,6 +12,17 @@ Maximizes the panel to cover the entire display, providing an expanded view. <br
14
12
- To expand the view, click the **Full Screen Mode** button in the panel toolbar.
15
13
- To exit **Full Screen Mode**, press **Escape** on your keyboard.
16
14
15
+
### Information Icon
16
+
The information icon on panel shows the description of the panel. <br>
Copy file name to clipboardExpand all lines: docs/user-guide/identity-and-access-management/organizations.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff 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.
2
2
3
3
## Overview
4
4
Organizations provide logical boundaries for separating data, users, and access controls, enabling secure multi-tenant usage in a single OpenObserve deployment.
Copy file name to clipboardExpand all lines: docs/user-guide/streams/extended-retention.md
+6-5Lines changed: 6 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
## Extended Retention
2
2
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.
4
4
5
5
## When to Use Extended Retention
6
6
@@ -9,10 +9,11 @@ For example, logs from a known incident that occurred last month, you can config
9
9
10
10
## How to Apply Extended Retention
11
11
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.
16
17
17
18
!!! Note
18
19
The data within the selected time range will be retained for an additional 3,650 days.
Copy file name to clipboardExpand all lines: docs/user-guide/streams/schema-settings.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff 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:
Copy file name to clipboardExpand all lines: docs/user-guide/streams/stream-details.md
+12-9Lines changed: 12 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff 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.
3
2
4
-
## Access
5
-
From the Streams page, select the **Explore** icon from the **Actions** column.
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).
@@ -42,10 +40,15 @@ The **Stream Details** panel displays key configuration and usage information fo
42
40
```
43
41
ZO_DEFAULT_MAX_QUERY_RANGE_DAYS
44
42
```
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.
46
44
47
45
- **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.
48
46
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.
0 commit comments