Skip to content

Commit 51874e6

Browse files
Update doc (#269)
* Add distinct values documentation and related images (#258) * New Doc: Custom charts for metrics using PromQL (#260) * doc fix: streams docs and custom charts docs (#261) * update docs: pipelines pages, alert history, custom chart for metrics using promql (#263) * doc fix: streams docs and custom charts docs * update pipelines pages, alert history, custom chart for metrics using promql doc * Dashboard doc fix (#264) * doc fix: streams docs and custom charts docs * update pipelines pages, alert history, custom chart for metrics using promql doc * doc fix: formatting and 404 fixes * doc-fixes (#265) * new docs: License and multiple promql custom chart | update pipeline user guides --------- Co-authored-by: ktx-krupa <krupa.jivani@kiara.tech>
1 parent 01aa136 commit 51874e6

16 files changed

+369
-32
lines changed

docs/images/about-page-license.png

174 KB
Loading
105 KB
Loading

docs/images/license-management.png

128 KB
Loading

docs/images/license-server.png

39.7 KB
Loading

docs/user-guide/alerts/alert-history.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,6 @@ This process applies only to users who have access to the `_meta` organization.
6969

7070
## Why you might see a skipped status
7171
A **skipped** status appears when a scheduled alert runs later than its expected window. <br>
72-
For example, an alert configured with a 5-minute period and 5-minute frequency is scheduled to run at 12:00 PM. It should normally evaluate data from 11:55 to 12:00.
73-
If the alert manager experiences a delay and runs the job at 12:05 PM, it evaluates the current aligned window (12:00 to 12:05) instead of the earlier one. The earlier window (11:55 to 12:00) is marked as skipped to indicate that evaluation for that range did not occur because of delay in job pickup or data availability.
72+
For example, an alert configured with a 5-minute period and 5-minute frequency is scheduled to run at 12:00 PM. <br>It should normally evaluate data from 11:55 to 12:00.
73+
If the alert manager experiences a delay and runs the job at 12:05 PM, it evaluates the current aligned window (12:00 to 12:05) instead of the earlier one.<br> The earlier window (11:55 to 12:00) is marked as skipped to indicate that evaluation for that range did not occur because of delay in job pickup or data availability.
7474

docs/user-guide/dashboards/custom-charts/.pages

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,5 @@ nav:
44
- Custom Charts with Flat Data: custom-charts-flat-data.md
55
- Custom Charts with Nested Data: custom-charts-nested-data.md
66
- Event Handlers and Custom Functions: custom-charts-event-handlers-and-custom-functions.md
7-
- Custom Charts for Metrics Using PromQL: custom-charts-for-metrics-using-promql.md
7+
- Custom Charts for Metrics Using PromQL: custom-charts-for-metrics-using-promql.md
8+
- Custom Charts for Metrics Using Multiple PromQL Queries: custom-charts-for-metrics-using-multiple-promql-queries.md

docs/user-guide/dashboards/custom-charts/custom-charts-event-handlers-and-custom-functions.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@ description: >-
55
---
66
This guide shows how to make your [custom charts](what-are-custom-charts.md) interactive using event handlers and reusable custom functions (customFn).
77

8-
## What Are Event Handlers
9-
8+
## What are event handlers?
109
Event handlers let you define what happens when a user interacts with the chart, such as clicking or hovering over a data point. Use event handlers in the custom chart logic to display messages, log actions, or apply filters based on user input.
1110

1211
Common event handlers:
@@ -21,7 +20,7 @@ Before you begin, note the following:
2120
- Use the `o2_events` block to specify the event type, such as `click`.
2221
- Associate the event with a function that will run when the event occurs.
2322

24-
## How to Create Event Handlers
23+
## How to create event handlers
2524

2625
### Step 1: Create a basic chart with labels and values
2726

@@ -92,7 +91,7 @@ o2_events: {
9291
}
9392
```
9493

95-
## What Are Custom Functions
94+
## What are custom functions?
9695

9796
Custom functions (customFn) are special sections inside the chart’s `option` object where you can define reusable functions.
9897

@@ -102,7 +101,7 @@ These functions can be used:
102101
- To apply logic such as filters
103102
- To keep your event handlers simple
104103

105-
## How to Create Custom Functions
104+
## How to create custom functions
106105

107106
**Example**: You have a chart showing bars for A, B, and C. When the user clicks on a bar, you want to format the output like:
108107
```

docs/user-guide/dashboards/custom-charts/custom-charts-flat-data.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ description: >-
55
---
66
The following step-by-step instructions can help you build a [custom chart that expects flat data](what-are-custom-charts.md#how-to-check-the-data-structure-a-chart-expects).
77

8-
## Use Case
8+
## Use case
99

1010
Build a custom **heatmap chart** to understand which organization and search type combinations generate the most query load.
1111

1212

13-
## Before You Begin
13+
## Before you begin
1414

1515
To build a custom chart, you need to bridge two things:
1616

@@ -19,7 +19,7 @@ To build a custom chart, you need to bridge two things:
1919

2020
> **Note**: Understanding both is important because it helps you write the right SQL query, [prepare](what-are-custom-charts.md#build-the-chart) the data through grouping or aggregation, [reshape](what-are-custom-charts.md#build-the-chart) the results to match the chart’s structure, and map them correctly in the JavaScript code that renders the chart.
2121
22-
## Step 1: Understand the Ingested Dataset
22+
## Step 1: Understand the ingested dataset
2323

2424
In OpenObserve, the data ingested into a stream is typically in a flat structure.
2525
**Example:** In the following dataset, each row represents a single event or query log with its own timestamp, organization ID, search type, and query duration.
@@ -39,7 +39,7 @@ In OpenObserve, the data ingested into a stream is typically in a flat structure
3939

4040
**Note**: Use the **Logs** page to view the data ingested to the stream.
4141

42-
## Step 2: Identify the Expected Data Structure
42+
## Step 2: Identify the expected data structure
4343

4444
Before moving ahead, [identify what structure the chart expects](what-are-custom-charts.md#how-to-check-the-data-structure-a-chart-expects). The heatmap chart expects flat data.
4545

@@ -51,7 +51,7 @@ In this example, each row in [data[0]](what-are-custom-charts.md#the-data-object
5151

5252
**Note**: For charts that expect flat data, [reshaping is not needed](what-are-custom-charts.md#build-the-chart). SQL alone is enough to prepare the data in required format.
5353

54-
## Step 3: Prepare the Data (via SQL)
54+
## Step 3: Prepare the data (via SQL)
5555

5656
In the [Add Panel](what-are-custom-charts.md#how-to-access-custom-charts) page, under **Fields**, select the desired stream type and stream name.
5757
![custom-chart-flat-data-add-panel](../../../images/custom-chart-flat-data-add-panel.png)
@@ -85,7 +85,7 @@ Select a time range to fetch the relevant dataset for your chart.
8585

8686
![custom-chart-flat-data-time-range-selection](../../../images/custom-chart-flat-data-time-range.png)
8787

88-
**Expected Query Result**
88+
**Expected query result**
8989

9090
```linenums="1"
9191
data=[[
@@ -99,7 +99,7 @@ data=[[
9999

100100
**Note**: OpenObserve stores the result of the query in [the `data` object](what-are-custom-charts.md#the-data-object) as an **array of an array**.
101101

102-
## Step 4: Inspect the Queried Dataset
102+
## Step 4: Inspect the queried dataset
103103

104104
Inspect the queried dataset:
105105

@@ -108,7 +108,7 @@ console.log(data);
108108
console.log(data[0]);
109109
```
110110

111-
## Step 5: JavaScript Code to Render the Heatmap
111+
## Step 5: JavaScript code to render the heatmap
112112

113113
In the JavaScript editor, you must construct an [object named `option`](what-are-custom-charts.md#the-option-object).
114114
This `option` object defines how the chart looks and behaves. To feed data into the chart, use the query result stored in `data[0]`
@@ -165,13 +165,13 @@ option = {
165165
};
166166
```
167167

168-
## Step 6: View Result
168+
## Step 6: View result
169169

170170
Click **Apply** to generate the chart.
171171

172172
![custom-chart-flat-data-result](../../../images/custom-chart-flat-data-result.png)
173173

174-
### Understand the Chart
174+
### Understand the chart
175175

176176
In the chart,
177177

@@ -208,7 +208,7 @@ Use the following guidance to identify and fix common issues when working with c
208208
- Open your browser's developer console to locate the error.
209209
- Use `console.log()` to test your script step by step.
210210

211-
**4. Chart Not Rendering:**
211+
**4. Chart not rendering:**
212212
**Cause**: The query returned data, but the chart did not render.
213213
**Fix**:
214214

0 commit comments

Comments
 (0)