Skip to content

Commit 8a08395

Browse files
update docs
1 parent 11d19d9 commit 8a08395

File tree

8 files changed

+54
-47
lines changed

8 files changed

+54
-47
lines changed

docs/.pages

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
nav:
22
- Introduction: index.md
3-
- Downloads: downloads.md
43
- Getting started: getting-started.md
5-
- Screenshots: screenshots.md
64
- Quickstart: quickstart.md
75
- Enterprise Edition Installation Guide: openobserve-enterprise-edition-installation-guide.md
86
- Releases: releases.md

docs/user-guide/.pages

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,14 @@ nav:
22
- Concepts: concepts.md
33
- Log Search: logs
44
- Metrics: metrics
5-
- Real User Monitoring (RUM): rum.md
6-
- Organizations: organizations.md
7-
- Users: users.md
85
- Streams: streams
96
- Ingestion: ingestion.md
107
- Pipelines: Pipelines
118
- Alerts: alerts
129
- Dashboards: dashboards
1310
- Actions: actions
1411
- Functions: functions
15-
- Migration: migration
12+
- Real User Monitoring (RUM): rum.md
1613
- Identity and Access Management (IAM): identity-and-access-management
1714
- Management: management
1815
- Profile: profile

docs/user-guide/management/alert-destinations.md

Lines changed: 24 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Webhooks are ideal for integrating OpenObserve alerts with third-party platforms
1919
4. Fill the following sections:
2020

2121
- **Name**: Enter a descriptive name for the Webhook destination such as **SlackNotifications**.
22-
> Note: Characters like :, ?, /, #, and spaces are not allowed.
22+
> **Note**: Characters like :, ?, /, #, and spaces are not allowed.
2323
- **Template**: Choose a template from the dropdown menu. Refer to [Templates](templates.md) to create or manage templates.
2424
- **URL**: Specify the Webhook endpoint URL where notifications will be sent.
2525
- **Method**: Select the HTTP method depending on the Webhook's requirements.
@@ -31,17 +31,16 @@ Webhooks are ideal for integrating OpenObserve alerts with third-party platforms
3131

3232
![alert destination](../../images/alert-destination-webhook-slack.png)
3333

34-
### Example
34+
!!! Note "Example"
35+
- **Name**: Slack Alerts
36+
- **Template**: SlackTemplate
37+
- **URL**: `https://hooks.slack.com/services/T02QBH105PF/B04C7NLLLRE/HY3fXf123`
38+
- **Method**: POST
39+
- **Output Format**: JSON
40+
- **Headers**:
3541

36-
- **Name**: Slack Alerts
37-
- **Template**: SlackTemplate
38-
- **URL**: `https://hooks.slack.com/services/T02QBH105PF/B04C7NLLLRE/HY3fXf123`
39-
- **Method**: POST
40-
- **Output Format**: JSON
41-
- **Headers**:
42-
43-
- **Key**: Authorization
44-
- **Value**: Basic cm9vdEBleGFtcGxlLmNvbTpDb21wbGV4GFzcy
42+
- **Key**: Authorization
43+
- **Value**: Basic cm9vdEBleGFtcGxlLmNvbTpDb21wbGV4GFzcy
4544

4645

4746
## Configure Email Destinations
@@ -58,11 +57,10 @@ Email destinations are used for delivering alert notifications directly to speci
5857
5. Click **Save** to create the Email destination.
5958

6059

61-
### Example
62-
63-
- **Name**: Critical Alerts
64-
- **Template**: EmailTemplate
65-
60+
!!! Note "Example"
61+
- **Name**: Critical Alerts
62+
- **Template**: EmailTemplate
63+
- **Recipients**: `[email protected]; [email protected]`
6664

6765
## Additional Notes
6866
![list_Destinations](../../images/destinations/4.jpg)
@@ -80,20 +78,20 @@ By following this guide, you can set up Webhook and Email destinations to ensure
8078
To send email alerts, OpenObserve requires SMTP configuration. This can be done by setting the appropriate environment variables when starting OpenObserve.
8179

8280

83-
#### Start OpenObserve with SMTP Configuration
81+
### Start OpenObserve with SMTP Configuration
8482

8583
Use the following command to configure OpenObserve to send email alerts via Gmail:
8684

8785
```bash
88-
ZO_SMTP_ENABLED=true \
89-
ZO_SMTP_HOST="smtp.gmail.com" \
90-
ZO_SMTP_PORT=587 \
91-
ZO_SMTP_USER_NAME="your-user-name" \
92-
ZO_SMTP_PASSWORD="your-app-password" \
93-
ZO_SMTP_FROM_EMAIL="your-email-address" \
94-
ZO_SMTP_ENCRYPTION="starttls" \
95-
ZO_ROOT_USER_EMAIL="[email protected]" \
96-
ZO_ROOT_USER_PASSWORD="Complexpass#123" \
86+
ZO_SMTP_ENABLED=true
87+
ZO_SMTP_HOST="smtp.gmail.com"
88+
ZO_SMTP_PORT=587
89+
ZO_SMTP_USER_NAME="your-user-name"
90+
ZO_SMTP_PASSWORD="your-app-password"
91+
ZO_SMTP_FROM_EMAIL="your-email-address"
92+
ZO_SMTP_ENCRYPTION="starttls"
93+
ZO_ROOT_USER_EMAIL="[email protected]"
94+
ZO_ROOT_USER_PASSWORD="Complexpass#123"
9795
./openobserve
9896
```
9997
Replace the placeholders (your-email-address, your-app-password, etc.) with your actual SMTP details.

docs/user-guide/management/cipher-keys.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Follow these steps to create and configure Cipher Keys in OpenObserve:
88

99
### Step 1: Navigate to the Cipher Keys Section
1010

11-
1. From the top navigation bar, click the gear icon (**Management**).
11+
1. From the top navigation bar, click the gear icon to open the **Management** page.
1212
2. Select **Cipher Keys**.
1313

1414
![cipher-keys](../../images/cipher-keys1.png)
@@ -43,7 +43,9 @@ After you have filled in all the details, click **Save**. Your new Cipher Key is
4343

4444
After creating the Cipher Key, write queries using the `decrypt()` function in the following formats to decrypt encrypted logs:
4545

46-
```SELECT decrypt (<field name which is encrypted>, ‘<Name of the Cipher Key>’ ) as <name the decrypted log field> from <stream name>;```
46+
```
47+
SELECT decrypt (<field name which is encrypted>, ‘<Name of the Cipher Key>’ ) as <name the decrypted log field> from <stream name>;
48+
```
4749

4850
Let’s say you have the following setup:
4951

@@ -53,13 +55,24 @@ Let’s say you have the following setup:
5355
- You want to name the decrypted field `decrypted_user_data` in the query results.
5456

5557
The query to decrypt and retrieve the logs would look like this:
56-
```SELECT decrypt(user_data, 'user_data_decryption_key') as decrypted_user_data FROM user_activity_stream;```
58+
```
59+
SELECT decrypt(user_data, 'user_data_decryption_key') as decrypted_user_data FROM user_activity_stream;
60+
```
5761

5862
Additionally, you can use the `decrypt()` function:
5963

60-
- **With the WHERE clause**: The following query retrieves the `user_id` from the `user_activity_stream` where the decrypted `user_data` matches the string '`John Doe`': ```Select user_id from user_activity_stream where decrypt(user_data,'user_data_decryption_key') = 'John Doe';```
61-
- **With match* functions**: The following query will decrypt the `user_data` field using the `user_data_decryption_key` and match the decrypted value with `'John’:` ```SELECT user_id FROM user_activity_stream WHERE str_match_all(decrypt(user_data, 'user_data_decryption_key'), 'John Doe’);```
62-
- **With the LIKE clause**: This query will decrypt the `user_data` field using the `user_data_decryption_key` and return results where the decrypted data contains the substring '`John`': ```SELECT user_id FROM user_activity_stream WHERE decrypt(user_data, 'user_data_decryption_key') LIKE '%John%';```
64+
- **With the WHERE clause**: The following query retrieves the `user_id` from the `user_activity_stream` where the decrypted `user_data` matches the string '`John Doe`':
65+
```
66+
Select user_id from user_activity_stream where decrypt(user_data,'user_data_decryption_key') = 'John Doe';
67+
```
68+
- **With match* functions**: The following query will decrypt the `user_data` field using the `user_data_decryption_key` and match the decrypted value with `'John’`:
69+
```
70+
SELECT user_id FROM user_activity_stream WHERE str_match_all(decrypt(user_data, 'user_data_decryption_key'), 'John Doe’);
71+
```
72+
- **With the LIKE clause**: This query will decrypt the `user_data` field using the `user_data_decryption_key` and return results where the decrypted data contains the substring '`John`':
73+
```
74+
SELECT user_id FROM user_activity_stream WHERE decrypt(user_data, 'user_data_decryption_key') LIKE '%John%';
75+
```
6376

6477
**Note:**
6578

docs/user-guide/metrics/downsampling-metrics.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,10 @@ Downsampling summarizes historical data into fewer data points. Each summarized
88

99
Downsampling is configured using the following environment variables.:
1010

11-
- `O2_COMPACT_DOWNSAMPLING_INTERVAL`: Defines how often the downsampling job runs (interval), in seconds. <br>**Example:** `O2_COMPACT_DOWNSAMPLING_INTERVAL`: "300" (this downsampling job runs every 5 minutes)
12-
- `O2_METRICS_DOWNSAMPLING_RULES`: Specifies which data streams to target and how they should be downsampled using defined rules. You can add a comma-separated list of rules.<br>**Example:** `O2_METRICS_DOWNSAMPLING_RULES`: "o2_cpu_usage:avg:30d:5m, app_analytics:last:10d:10m"
11+
- `O2_COMPACT_DOWNSAMPLING_INTERVAL`: Defines how often the downsampling job runs or the interval, in seconds.
12+
> For example, `O2_COMPACT_DOWNSAMPLING_INTERVAL`: "300", this downsampling job runs every 5 minutes.
13+
- `O2_METRICS_DOWNSAMPLING_RULES`: Specifies which data streams to target and how they should be downsampled using defined rules. You can add a comma-separated list of rules.
14+
> For example, `O2_METRICS_DOWNSAMPLING_RULES`: "o2_cpu_usage:avg:30d:5m, app_analytics:last:10d:10m"
1315
1416
> Refer to the [Downsampling Rule](#downsampling-rule) section. <br>
1517
@@ -56,9 +58,9 @@ Here:
5658
- **offset**: It defines the age of data eligible for downsampling. For example, 15d for applying downsampling on data older than 15 days.
5759
- **step**: The time block used to group data points. For example, 30m for applying downsampling to retain one value every 30 minutes.
5860

59-
#### Sample Downsampling Rules
61+
### Sample Downsampling Rules
6062

61-
##### Single Rule
63+
#### Single Rule
6264
```yaml
6365
O2_METRICS_DOWNSAMPLING_RULES: "o2_cpu_metrics:avg:30d:5m"
6466
```

docs/user-guide/performance/download-manager.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ The following examples illustrate how files are assigned to the priority or norm
143143
The querier does not begin processing the search query until all required files, regardless of whether they were downloaded via the Priority or Normal Queue.
144144

145145

146-
## Frequently Asked Questions (FAQ)
146+
## Frequently Asked Questions
147147

148148
**Q. My query includes both recent and old data. Do I get results faster with the new system?** <br>
149149
**A.** Yes. Files within the configured priority window are downloaded immediately. This helps reduce total wait time, even though the query waits for all required files.

docs/user-guide/performance/monitor-download-queue-size-and-disk-cache-metrics.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ OpenObserve emits four key metrics that track how data files are downloaded and
1111
- `zo_file_downloader_priority_queue_size`: Number of files in the [**priority** queue](download-manager.md/#dual-queue-system).
1212

1313
- `zo_query_disk_cache_hit_count`: Number of files that were already on disk when the query was executed.
14-
1514
- `zo_query_disk_cache_miss_count`: Number of files that were not on disk and had to be downloaded before the query could run.
1615

1716
!!! Note
@@ -167,4 +166,4 @@ If the metrics do not appear:
167166

168167
- Verify that `ZO_SELF_METRIC_CONSUMPTION_ENABLED` is set to **true**.
169168
- Check that `ZO_SELF_METRIC_CONSUMPTION_ACCEPTLIST` includes all the relevant metric names.
170-
- Confirm that your dashboard filters match the environment where metrics are enabled (e.g., `main`, `usertest`, etc.)
169+
- Confirm that your dashboard filters match the environment where metrics are enabled. For example, `main`, `usertest`, etc.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
After [learning about streams](streams-in-openobserve.md) and [completing the data ingestion](streams-in-openobserve.md/#ingest-data-into-stream), you can view detailed information about a stream.
2-
This guide explains how to access the Stream Details panel and the information available in the panel.
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.
33

44
## Access
55

0 commit comments

Comments
 (0)