Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/api/user/add_user.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ description: >-
Add an existing user to an OpenObserve organization with a specified role
using a simple POST request. Supports admin and user roles.
---
# Add exiting user to org
# Add existing user to org

Endpoint: `POST /api/{organization}/users/{user_email}`

Expand Down
752 changes: 718 additions & 34 deletions docs/environment-variables.md

Large diffs are not rendered by default.

Binary file added docs/images/add-regex-pattern.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/create-regex-pattern.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/drop-at-ingestion-time-result.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/drop-at-query-time-result.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/drop-at-query-time-test-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/email-regex.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/enable-disable-streaming-search.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/full-name-regex.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/redact-at-ingestion-time-result.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/redact-at-query-test-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/redact-at-query-time-result.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/regex-pattern-execution-time.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/regex-patterns-drop.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/regex-patterns-redact.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/stream-settings-add-regex.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/stream-settings-sensitive-fields.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/update-regex-patterns.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 6 additions & 2 deletions docs/operator-guide/etcd.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
---
title: Etcd Maintenance
title: Etcd Maintenance (Deprecated)
weight: 4450
description: >-
Learn how to maintain your etcd cluster with compaction, defragmentation, and
space quotas to prevent data loss and ensure reliable performance.
---

# Etcd Maintenance
# Etcd Maintenance (Deprecated)

!!! warning "Deprecation Notice"
Support for **etcd** has been deprecated in OpenObserve.


## Overview

Expand Down
2 changes: 1 addition & 1 deletion docs/operator-guide/etcd_restore.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ description: >-
Restore a broken etcd cluster in OpenObserve by restarting pods, resetting
data, and rejoining members using CLI and updated Helm configs.
---
# Etcd Cluster Restore
# Etcd Cluster Restore (Deprecated)

Many users ran into the case only one of the 3 pods of etcd cluster can works. The other 2 pods always restart and can't back to work.

Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/management/.pages
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ nav:
- Cipher Keys: cipher-keys.md
- Nodes in OpenObserve: nodes.md
- SSO Domain Restrictions: sso-domain-restrictions.md
- Regex Patterns: regex-patterns.md
- Sensitive Data Redaction: regex-patterns.md
169 changes: 88 additions & 81 deletions docs/user-guide/management/query-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,127 +3,134 @@ description: >-
Monitor and cancel live queries across dashboards, alerts, and logs; inspect
execution time, range, user, and more in HA deployments.
---
The **Query Management** page provides **real-time visibility and control** over all currently running queries across dashboards, alerts, logs, and reports within an OpenObserve instance. Using the **Query Management page**, you can decide whether to cancel a query or leave it running.
This page explains what Query Management is and shows how to use it.

## Availability
> This feature is available only in [high-availability (HA)](../../openobserve-enterprise-edition-installation-guide.md) deployments.

The Query Management feature is available only in high-availability (HA) deployments.
=== "Overview"
## What is Query Management?
The Query Management feature provides real-time visibility and control over all currently running queries across dashboards, alerts, logs, and reports within an OpenObserve instance. Using the Query Management page, you can decide whether to cancel a query or leave it running.

## Access
!!! note "Who can use it"
By default, `root` users and any other user who has access to the `_meta` org can access the Query Management page.

By default, `root` users and any predefined user roles (`Admin`,`Editor`,`Viewer`, or `User`) with access to the `_meta` organization can access the **Query Management** page. RBAC cannot grant access to other custom roles.
!!! note "Where to find it"
To access the Query Management page:

**To access the Query Management page:**
1. Select `_meta` organization from the top right corner.
2. Go to **Management**.
3. In the side panel, select **Query Management**.
You will be taken to the **Running Queries** section.
![Running Queries](../../images/query-management-running-queries.png)

1. Select `_meta` organization from the top right corner.
2. Go to **Management**.
3. In the side panel, select **Query Management**.
You will be taken to the **Running Queries** section.
![Running Queries](../../images/query-management-running-queries.png)
## Viewing Modes

## Viewing Modes
You can toggle between:

You can toggle between:
- **User Summary**: Groups all queries by user and displays their combined activity.
- **All Queries**: Displays each query individually with full details and filtering options.

- **User Summary**: Groups all queries by user and displays their combined activity.
- **All Queries**: Displays each query individually with full details and filtering options.
Use **User Summary** for high-level monitoring. Switch to **All Queries** when you need to investigate specific query behavior.

Use **User Summary** for high-level monitoring. Switch to **All Queries** when you need to investigate specific query behavior.
## Page Layout and Field Descriptions

## Page Layout and Field Descriptions
The **Running Queries** table displays the following fields:

The **Running Queries** table displays the following fields:
- **Email**: The email ID of the user who initiated the queries.
- **Search Type**: The origin of the query (for example, dashboards, alerts, or others).
- **Number of Queries**: Total active queries for that user.
- **Total Exec. Duration**: Combined time spent executing all active queries.
- **Total Query Range**: Total log duration the queries are scanning.
- **Actions**: Cancel queries initiated by a user.
![Running Queries](../../images/query-management-running-queries.png)

- **Email**: The email ID of the user who initiated the queries.
- **Search Type**: The origin of the query (for example, dashboards, alerts, or others).
- **Number of Queries**: Total active queries for that user.
- **Total Exec. Duration**: Combined time spent executing all active queries.
- **Total Query Range**: Total log duration the queries are scanning.
- **Actions**: Cancel queries initiated by a user.
![Running Queries](../../images/query-management-running-queries.png)
The **All Queries** table displays the following fields:

The **All Queries** table displays the following fields:
- **Email:** The email of the user who triggered the query.
- **Organization ID:** The organization context.
- **Search Type:** The source of the query, such as dashboards, UI, or alerts.
- **Execution Duration:** The total time the query has been running.
- **Query Range:** The time range being queried.
- **Query Type:** Whether the system classifies the query as Short or Long.
- **Status:** The current status of the query, whether it is still processing or waiting.
- **Stream Type:** The type of data stream being queried, such as logs.
- **Actions:** Two actions available:

- **Email:** The email of the user who triggered the query.
- **Organization ID:** The organization context.
- **Search Type:** The source of the query, such as dashboards, UI, or alerts.
- **Execution Duration:** The total time the query has been running.
- **Query Range:** The time range being queried.
- **Query Type:** Whether the system classifies the query as Short or Long.
- **Status:** The current status of the query, whether it is still processing or waiting.
- **Stream Type:** The type of data stream being queried, such as logs.
- **Actions:** Two actions available:
- **View Details** to inspect the query details.
- **Cancel** to stop the query immediately.

- **View Details** to inspect the query details.
- **Cancel** to stop the query immediately.
![All Running Queries](../../images/query-management-all-queries.png)

![All Running Queries](../../images/query-management-all-queries.png)
## Filters and Searches

## Filters and Searches
- **Search Bar**: Enter an email or keyword to filter queries.
- **All Fields Dropdown**: The **All Fields dropdown** lets you filter queries based on either **Execution Duration** or **Query Range**. Range.
- **Source Filter**: Filter queries by source. Select one of the following:

- **Search Bar**: Enter an email or keyword to filter queries.
- **All Fields Dropdown**: The **All Fields dropdown** lets you filter queries based on either **Execution Duration** or **Query Range**. Range.
- **Source Filter**: Filter queries by source. Select one of the following:
- **Dashboards**: Queries coming from Dashboards.
- **UI**: Queries run manually by users from the Logs interface.
- **Others**: Queries triggered by Alerts or Reports.
<br>
![Filter and Search in Running Queries](../../images/query-management-filter-search.png)

- **Dashboards**: Queries coming from Dashboards.
- **UI**: Queries run manually by users from the Logs interface.
- **Others**: Queries triggered by Alerts or Reports.
<br>
![Filter and Search in Running Queries](../../images/query-management-filter-search.png)
- **Refresh Query Button**: Click to reload the page with the latest query data. Refer to the **Last Data Refresh Time** section to confirm whether the query results are up to date before refreshing.

- **Refresh Query Button**: Click to reload the page with the latest query data. Refer to the **Last Data Refresh Time** section to confirm whether the query results are up to date before refreshing.
=== "How to"
## How to View Query Details

## How to View Query Details
To inspect a running query:

To inspect a running query:
1. In the **All Queries** view, locate the query you want to examine.
2. In the **Actions** column, click the icon to **view details**.

1. In the **All Queries** view, locate the query you want to examine.
2. In the **Actions** column, click the icon to **view details**.
![View Query Details](../../images/query-management-view-details.png)

![View Query Details](../../images/query-management-view-details.png)
You will see a pop-up with full information about the query:

You will see a pop-up with full information about the query:
- Unique Trace ID.
- Current status (e.g., waiting, processing).
- User email and organization ID.
- Stream type (e.g., logs).
- The complete SQL query.
- The start time and end time selected by the user. This defines the **Query Range**.
- The **Execution Duration** and final **Query Range** calculated.
- Additional technical metrics, including the number of records scanned within the selected time range, the original size of the scanned files, and their compressed size in Parquet format.
![Query Detailed View](../../images/query-management-view-query-details.png)

- Unique Trace ID.
- Current status (e.g., waiting, processing).
- User email and organization ID.
- Stream type (e.g., logs).
- The complete SQL query.
- The start time and end time selected by the user. This defines the **Query Range**.
- The **Execution Duration** and final **Query Range** calculated.
- Additional technical metrics, including the number of records scanned within the selected time range, the original size of the scanned files, and their compressed size in Parquet format.
## How to Cancel a Query

![Query Detailed View](../../images/query-management-view-query-details.png)
Before you begin:

## How to Cancel a Query
Canceling a query may interrupt active investigations. Confirm the impact before proceeding.

You can cancel a query from either view:
!!! note "When should you cancel a query"
You should cancel a query if any of the following are true:

**To cancel from User Summary**:
- The execution time has exceeded acceptable limits.
- The time range being queried is too wide.
- The system is under strain, and this query appears in a long or waiting state.

1. Locate the user whose queries you want to stop.
2. Either select the checkbox and click **Cancel Query** at the bottom of the page, or click the red **X** icon in the **Actions** column.
!!! note "When should you not cancel a query"
The query is from a critical source.

![Cancel Queries](../../images/query-management-cancel-queries.png)
You can cancel a query from the **User Summary** page as well as the **All Queries** view.
<br>
**To cancel from User Summary**:

**To cancel from All Queries**:
1. Locate the user whose queries you want to stop.
2. Either select the checkbox and click **Cancel Query** at the bottom of the page, or click the red **X** icon in the **Actions** column.
![Cancel Queries](../../images/query-management-cancel-queries.png)

1. Find the query you want to cancel.
2. In the **Actions** column, click the red `X` icon.
<br>
**To cancel from All Queries**:

After you confirm, the query is terminated immediately.
1. Find the query you want to cancel.
2. In the **Actions** column, click the red `X` icon.

## When Should You Cancel a Query
After you confirm, the query is terminated immediately.

You should cancel a query if any of the following are true:

- The execution time has exceeded acceptable limits.
- The time range being queried is too wide.
- The system is under strain, and this query appears in a long or waiting state.

Avoid canceling if:

- The query is from a critical source.

> **Note:** Canceling a query may interrupt active investigations. Confirm the impact before proceeding.

Loading