Skip to content

Commit c1306c7

Browse files
added variables docs and fixed 404 issue in sql_reference page
1 parent ed12dca commit c1306c7

17 files changed

+349
-77
lines changed

docs/images/constant-variable.png

86 KB
Loading

docs/images/custom-variable.png

129 KB
Loading

docs/images/query-variable-result.png

291 KB
Loading
128 KB
Loading

docs/images/textbox-variable.png

104 KB
Loading

docs/images/variables-query.png

153 KB
Loading

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ Follow these steps to install OpenObserve Enterprise Edition:
116116
dex:
117117
enabled: true
118118
```
119-
For more inforamtion, refer to the [RBAC and SSO guides](../docs/user-guide/identity-and-access-management/).
119+
For more inforamtion, refer to the [RBAC and SSO guides](../user-guide/identity-and-access-management/role-based-access-control/).
120120

121121

122122
!!! Note

docs/overview/.pages

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
nav:
22
- Introduction: index.md
3-
- Our Principle: guiding-principles.md
3+
- Our Principles: guiding-principles.md
44
- Comparison with Alternatives: comparison.md

docs/sql_reference.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ Questions: This guide describes the custom SQL functions supported in OpenObserv
44
These functions allow you to filter records based on keyword or pattern matches within one or more fields.
55

66
### `str_match(field, 'value')`
7-
**Alias**: `match_field(field, 'value')` <br>
7+
**Alias**: `match_field(field, 'value')` (Available in OpenObserve version 0.15.0 and later) <br>
8+
89
**Description**: <br>
910

1011
- Filters logs where the specified field contains the exact string value.
@@ -19,7 +20,7 @@ This query filters logs from the `default` stream where the `k8s_pod_name` field
1920

2021
---
2122
### `str_match_ignore_case(field, 'value')`
22-
**Alias**: `match_field_ignore_case(field, 'value')` <br>
23+
**Alias**: `match_field_ignore_case(field, 'value')` (Available in OpenObserve version 0.15.0 and later)<br>
2324
**Description**: <br>
2425

2526
- Filters logs where the specified field contains the string value.
@@ -37,11 +38,11 @@ This query filters logs from the `default` stream where the `k8s_pod_name` field
3738
### `match_all('value')`
3839
**Description**: <br>
3940

40-
- Filters logs by searching for the keyword across all fields that have the Index Type set to Full Text Search in the [stream settings](../docs/user-guide/streams/schema-settings.md).
41+
- Filters logs by searching for the keyword across all fields that have the Index Type set to Full Text Search in the [stream settings](../user-guide/streams/schema-settings/).
4142
- This function is case-insensitive and returns matches regardless of the keyword's casing.
4243

4344
!!! Note
44-
To enable support for fields indexed using the Inverted Index method, set the environment variable `ZO_ENABLE_INVERTED_INDEX` to true. Once enabled, you can configure the fields to use the Inverted Index by updating the [stream settings](../docs/user-guide/streams/schema-settings.md) in the user interface or through the [setting API](../docs/api/stream/setting.md).
45+
To enable support for fields indexed using the Inverted Index method, set the environment variable `ZO_ENABLE_INVERTED_INDEX` to true. Once enabled, you can configure the fields to use the Inverted Index by updating the [stream settings](../user-guide/streams/schema-settings/) in the user interface or through the [setting API](../api/stream/setting/).
4546

4647
The `match_all` function searches through inverted indexed terms, which are internally converted to lowercase. Therefore, keyword searches using `match_all` are always case-insensitive.
4748

@@ -261,7 +262,7 @@ Aggregate functions compute a single result from a set of input values. For usag
261262

262263
### `histogram(field, 'duration')`
263264
**Description:** <br>
264-
Use the `histogram` function to divide your time-based log data into time buckets of a fixed duration and then apply aggregate functions such as COUNT() or SUM() to those intervals.
265+
Use the `histogram` function to divide your time-based log data into time buckets of a fixed duration and then apply aggregate functions such as `COUNT()` or `SUM()` to those intervals.
265266
This helps in visualizing time-series trends and performing meaningful comparisons over time. <br><br>
266267
**Syntax:** <br>
267268
```sql

docs/user-guide/dashboards/.pages

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@ nav:
33
- Dashboards in OpenObserve: dashboards-in-openobserve.md
44
- Manage Dashboards: manage-dashboards.md
55
- Move and Export Dashboards in Bulk: bulk-move-and-export-dashboards.md
6-
- Variables: variables.md
7-
- Variable Dependencies in Dashboards: variable-dependencies.md
6+
- Panels: panels
7+
- Variables: variables
88
- Comparison Against in Dashboards: comparison-against-in-dashboards.md
99
- Custom Charts: custom-charts
10-
- Panels: panels
10+
1111

1212

0 commit comments

Comments
 (0)