Skip to content

Commit 921bcd0

Browse files
Merge pull request #83 from openobserve/docs-404-and-uppercase-issues
fixed 404 issues and uppercase URL issue
2 parents 1e24970 + 89461c5 commit 921bcd0

19 files changed

+44
-399
lines changed

docs/user-guide/Pipelines/Create-and-Use-Pipelines.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ This opens up the pipeline editor.
3030
- In the **Build Query** section, select the **Stream Type** (Logs, Metrics, or Traces) and **Stream Name**. Use the seach bar to search for the desired field in the source stream.
3131
- In the **SQL Query** section, write a query to fetch data from a source. For **Metrics**, you also have the option to write **PromQL**.
3232
![scheduled pipeline](../../images/create-pipeline-sch-query.png)
33-
- Under **Set Variables**, schedule the query execution by setting the **Frequency** and **Period**. For more details, visit [Pipelines in OpenObserve](Pipelines-in-OpenObserve.md).
33+
- Under **Set Variables**, schedule the query execution by setting the **Frequency** and **Period**. For more details, visit [Pipelines in OpenObserve](../pipelines-in-openobserve/).
3434
- Adjust the time filter and click **Run Query** to view the output.
3535
![scheduled pipeline](../../images/create-pipeline-sch-output.png)
3636
<br>In the above example, data is ingested periodically into the stream `default`. The query runs every 6 minutes and fetches all data that was ingested into the stream `default` in the preceding 6-minute interval.
@@ -96,7 +96,7 @@ This opens up the pipeline editor.
9696

9797
### Step 7: Save the pipeline
9898

99-
After you click Save, it gets activated automatically. Learn how to [manage pipelines](Manage-Pipelines.md).
99+
After you click Save, it gets activated automatically. Learn how to [manage pipelines](../manage-pipelines/).
100100

101101
![active pipeline](../../images/pipeline8_save_pipeline.png)
102102

@@ -167,4 +167,4 @@ Each run continues at fixed intervals from that point onward, such as 23:08, 23:
167167

168168

169169
## Next Step
170-
- [Manage Pipelines](Manage-Pipelines.md)
170+
- [Manage Pipelines](../manage-pipelines/)

docs/user-guide/Pipelines/Pipelines-in-OpenObserve.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,5 +76,5 @@ To configure an external destination for pipelines:
7676

7777

7878
## Next Steps
79-
- [Create and Use Pipelines](Create-and-Use-Pipelines.md)
80-
- [Manage Pipelines](Manage-Pipelines.md)
79+
- [Create and Use Pipelines](create-and-use-pipelines.md)
80+
- [Manage Pipelines](manage-pipelines.md)

docs/user-guide/Pipelines/configurable-delay-in-scheduled-pipelines.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
This guide explains how to use the configurable delay feature for [scheduled pipelines](Pipelines-in-OpenObserve.md).
2+
This guide explains how to use the configurable delay feature for [scheduled pipelines](../create-and-use-pipelines/).
33
This feature allows you to delay the execution of a scheduled pipeline by a set number of minutes after its scheduled start time. This is useful to ensure data completeness and accommodate late-arriving events before the pipeline runs.
44

55
## How to Configure Delay
@@ -34,5 +34,5 @@ At 10:00 AM (scheduled time), the pipeline executes at 10:02 AM, processing data
3434
- **Data Window Unchanged**: Delay only affects when execution starts. It does not change the data range.
3535

3636
**Related Links**<br>
37-
For steps on creating scheduled pipelines, see [Scheduled Pipelines](Create-and-Use-Pipelines.md).
37+
For steps on creating scheduled pipelines, see [Scheduled Pipelines](../create-and-use-pipelines/).
3838

docs/user-guide/Pipelines/import-and-export-pipelines.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,4 +62,4 @@ If any validation errors occur during import, refer to the following resolutions
6262
The imported pipeline appears in the **Pipelines** tab.
6363

6464
## Related Links
65-
- [Manage Pipelines](Manage-Pipelines.md)
65+
- [Manage Pipelines](../manage-pipelines/)

docs/user-guide/Pipelines/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ In OpenObserve, pipelines are data processing workflows used to transform logs,
22

33
**Learn more:**
44

5-
- [Pipelines in OpenObserve](Pipelines-in-OpenObserve.md)
6-
- [Create and Use Pipelines](Create-and-Use-Pipelines.md)
7-
- [Import and Export Pipelines](import-and-export-pipelines.md)
8-
- [Manage Pipelines](Manage-Pipelines.md)
9-
- [Configurable Delay in Scheduled Pipelines](onfigurable-delay-in-scheduled-pipelines.md)
5+
- [Pipelines in OpenObserve](../pipelines/pipelines-in-openobserve/)
6+
- [Create and Use Pipelines](../pipelines/create-and-use-pipelines/)
7+
- [Import and Export Pipelines](../pipelines/import-and-export-pipelines/)
8+
- [Manage Pipelines](../pipelines/manage-pipelines/)
9+
- [Configurable Delay in Scheduled Pipelines](../pipelines/configurable-delay-in-scheduled-pipelines/)

docs/user-guide/alerts/.pages

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
nav:
22
- Alerts Overview: index.md
33
- Alerts in OpenObserve: alerts.md
4-
- Alert Destinations: destinations.md
54
- Alert Folders: alert-folders.md
65
- Alert Conditions: alert-conditions.md
76
- Import and Export Alerts: import-export-alerts.md
87
- Multi-window Selector in Scheduled Alerts (SQL Mode): multi-window-selector-scheduled-alerts-concept.md
9-
- Use Multi-window Selector in Scheduled Alerts: multi-window-selector-scheduled-alerts.md
8+
- Use Multi-window Selector in Scheduled Alerts: how-to-access-multi-window-selector-scheduled-alerts.md

docs/user-guide/alerts/how-to-access-multi-window-selector-scheduled-alerts.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ To access multi-window selector in new alerts:
1616
4. Under **Alert Setup**, select **Scheduled Alerts**.
1717
5. Navigate to the **Multi-window Selector** section.
1818

19-
![access multi-window](../../images/multi-window.png)
19+
![access multi-window](../../images/multi-window-period.png)
2020

2121
### In Existing Alerts
2222

@@ -212,7 +212,7 @@ if length(result) >= 2 {
212212
213213
.
214214
```
215-
![vrl editor](../../images/multi-window-5.png)
215+
![vrl editor](../../images/multi-window-vrl-editor.png)
216216

217217
**Understand the VRL Function Output**
218218

@@ -257,7 +257,7 @@ Set the **Threshold** as **>= 1**
257257

258258
Determines how often the alert manager runs the query throughout the day (e.g., every 30 minutes).
259259

260-
![frequency](../../images/multi-window-6.png)
260+
![frequency](../../images/multi-window-frequency.png)
261261

262262
**Important:**
263263

@@ -284,7 +284,7 @@ At 10:30 AM, OpenObserve alert manager executes SQL for:
284284

285285
Specify where you want to receive the alert notification- email or webhook.
286286

287-
![add destination](../../images/multi-window-4.png)
287+
![add destination](../../images/multi-window-add-destination.png)
288288

289289
### Step 8: Create Row Template
290290

@@ -310,8 +310,8 @@ Details: Count difference: {{ diff }}
310310

311311
## FAQ
312312

313-
**What is a window in the Multi-window Selector?** <br>
314-
A *window* is a specific time range of data. It depends on the period you set in the alert.
313+
**Q.** **What is a window in the Multi-window Selector?** <br>
314+
**A.** A *window* is a specific time range of data. It depends on the period you set in the alert.
315315
If you set the period to 4 hours, each window will cover exactly 4 hours of data.
316316

317317
- The **current window** is simply the most recent 4-hour block of time before the evaluation. If the current time is **April 10th at 4:00 PM**, then the current window covers **April 10th from 12:00 PM to 4:00 PM**.
@@ -320,11 +320,11 @@ If you set the period to 4 hours, each window will cover exactly 4 hours of data
320320
Every window you select is just a copy of the same time range (defined by the period), shifted back by the amount of time you choose.
321321
<br>
322322

323-
**Does the period control the window length?**<br>
324-
Yes. The period defines the duration of each window. If you set the period to 4 hours, then every window — whether it's the current window or any past window — will be exactly 4 hours long.
323+
**Q.** **Does the period control the window length?**<br>
324+
**A.** Yes. The period defines the duration of each window. If you set the period to 4 hours, then every window — whether it's the current window or any past window — will be exactly 4 hours long.
325325

326-
**Does the alert manager run multiple queries inside one window?** <br>
327-
No. For each evaluation, the alert manager runs:
326+
**Q.** **Does the alert manager run multiple queries inside one window?** <br>
327+
**A.** No. For each evaluation, the alert manager runs:
328328

329329
- One query for the current window
330330
- One separate query for each additional past window you select
@@ -337,8 +337,8 @@ For example:
337337
- If you set frequency to every 12 hours, it runs the queries every 12 hours.
338338
So, frequency controls when the alert manager checks, and period controls what time range is checked at each evaluation.
339339

340-
**What happens if I forget to include `#ResultArray#` in my VRL function?** <br>
341-
If you do not include `#ResultArray#`, your VRL function will receive a flat array:**
340+
**Q.** **What happens if I forget to include `#ResultArray#` in my VRL function?** <br>
341+
**A.** If you do not include `#ResultArray#`, your VRL function will receive a flat array:**
342342

343343
``` linenums="1"
344344
[

0 commit comments

Comments
 (0)