Skip to content

Commit bf29dfa

Browse files
update docs
1 parent d3bbbd3 commit bf29dfa

8 files changed

+20
-21
lines changed
161 KB
Loading
100 KB
Loading
278 KB
Loading
613 KB
Loading
257 KB
Loading

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

Lines changed: 12 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -16,25 +16,18 @@ Webhooks are ideal for integrating OpenObserve alerts with third-party platforms
1616
1. In OpenObserve, go to **Management** from the top navigation bar.
1717
2. Select **Alert Destinations**.
1818
3. Select the **Webhook** tab.
19-
4. Enter a descriptive name for the Webhook destination such as **SlackNotifications**.
20-
> Note: Characters like :, ?, /, #, and spaces are not allowed.
21-
5. Choose a template from the dropdown menu. Refer to [Templates](templates.md) to create or manage templates.
22-
6. Specify the Webhook endpoint URL where notifications will be sent.
23-
7. Select the HTTP method depending on the Webhook's requirements.
24-
8. Choose **JSON** unless the receiving system explicitly requires **NDJSON** format.
25-
> Why Output Format Matters <br>
26-
> You define where the alert should be sent — this is the alert destination. <br>
27-
> OpenObserve sends the alert to that destination — which is a remote server. <br>
28-
> The remote server expects the payload in a specific format. <br>
29-
> You choose JSON or NDJSON accordingly. <br>
30-
> **Example:** <br>
31-
> **If the destination is a Slack webhook, choose JSON.** <br>
32-
> **If the destination is another OpenObserve instance, choose JSON.** <br>
33-
> **If the destination is a Splunk HTTP Event Collector (HEC) endpoint, choose NDJSON.** <br>
34-
>
35-
9. Under **Headers**, add custom headers in key-value format such as authentication tokens or content type.
36-
10. Enable the **Skip TLS Verify** option if the endpoint uses self-signed certificates or if you want to bypass SSL verification.
37-
9. Click **Save** to create the Webhook destination.
19+
4. Fill the following sections:
20+
21+
- **Name**: Enter a descriptive name for the Webhook destination such as **SlackNotifications**.
22+
> Note: Characters like :, ?, /, #, and spaces are not allowed.
23+
- **Template**: Choose a template from the dropdown menu. Refer to [Templates](templates.md) to create or manage templates.
24+
- **URL**: Specify the Webhook endpoint URL where notifications will be sent.
25+
- **Method**: Select the HTTP method depending on the Webhook's requirements.
26+
- **Output Format**: Choose **JSON** unless the receiving system explicitly requires **NDJSON** format.
27+
- **Headers**: Add custom headers in key-value format such as authentication tokens or content type.
28+
- **Skip TLS Verify**: Enable this option if the endpoint uses self-signed certificates or if you want to bypass SSL verification.
29+
30+
5. Click **Save** to create the Webhook destination.
3831

3932
![alert destination](../../images/alert-destination-webhook-slack.png)
4033

docs/user-guide/management/templates.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Alerts Templates
1+
# Alert Templates
22

33
Templates are used when notification is sent for an alert, templates forms body of request being sent to destination, for eg. for slack one can create template like:
44

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

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ From the **Stream Type** dropdown, select **Metrics**. This enables access to th
7373

7474
### Step 4: Select the Metric
7575
From the metrics dropdown, select the one you want to plot. For example, `zo_query_disk_cache_hit_count`.
76+
![select the metric](../../images/download-manager-metrics-choose-metrics.png)
7677

7778
### Step 5: Configure the Axes
7879
**Configure the X-Axis:**
@@ -88,12 +89,15 @@ From the metrics dropdown, select the one you want to plot. For example, `zo_que
8889
3. Use the **Aggregation** dropdown and select **Max** to show the highest value per interval.
8990
> Using the **Max** aggregation highlights the highest cache hit value observed in each interval.
9091

92+
![download manager metrics plotting - conifgure y-axis](../../images/download-manager-metrics-configure-axes.png)
93+
9194
### Step 6: Add Filters
9295
Filters narrow the data to a specific cluster and namespace, ensuring the chart reflects the intended environment. In this example, we need to add two filters:
9396

9497
- Filter for cluster to isolate the specific Kubernetes cluster. For example, `common-dev` which is ingested as value in the `k8s_cluster` field.
9598
- Filter for namespace to filter down to the environment namespace. For example, `main` which is ingested as value in the `k8s_namespace_name` field.
9699

100+
![add filters](../../images/download-manager-metrics-filters.png)
97101

98102
**Add Filter for Cluster:**
99103

@@ -117,13 +121,15 @@ To visualize the cache hit count on each pod, add a breakdown for pods.
117121

118122
This configuration allows the chart to display a separate line for each pod. It helps you compare cache hit behavior across pods in the same namespace.
119123

124+
![add breakdown](../../images/download-manager-metrics-pod-name.png)
125+
120126
### Step 8: Select the Time Range
121127
Use the time range selector at the top of the panel editor to define the period you want to analyze. For example, select Last 6 hours or Last 12 hours to examine recent trends.
122128

123129
### Step 9: Click Apply
124130
Click **Apply** to generate the chart using your selected configuration.
125131

126-
132+
![Download Manager Metrics Visualization](../../images/download-manager-metrics-plotting.png)
127133
## Plot Additional Metrics
128134
To complete cache performance analysis and monitor the download queue, repeat **Steps 1** through **9**, however, select `zo_query_disk_cache_miss_count`, `zo_file_downloader_normal_queue_size`, and `zo_file_downloader_priority_queue_size` in **Step 4**. Use the same filters, time range, and breakdown by pod.
129135

0 commit comments

Comments
 (0)