Skip to content

Commit 11d19d9

Browse files
update docs and new docs
1 parent 91403ad commit 11d19d9

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+520
-11
lines changed

docs/api/.pages

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,5 @@ nav:
44
- Search: search
55
- Functions: function
66
- Users: user
7+
- Cluster: cluster
78

docs/api/cluster/.pages

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
nav:
2+
- Cluster Info API: cluster-info.md

docs/api/cluster/cluster-info.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
Retrieves operational information about the OpenObserve cluster, currently reporting the number of pending compaction jobs per node. The response is organized by region and node, supporting multi-region environments.
2+
3+
### Request
4+
```
5+
GET /api/{org_id}/cluster_info
6+
```
7+
**Path Parameter**: {org_id} is the unique identifier of the organization.
8+
9+
### Response
10+
Returns a JSON object containing region-wise pending compaction job counts for each node.
11+
12+
### Example Response
13+
```json
14+
{
15+
"regions": {
16+
"openobserve": {
17+
"zo1": {
18+
"pending_jobs": 0
19+
}
20+
}
21+
}
22+
}
23+
```
24+
!!! Note
25+
The response can be extended to include additional cluster-level metrics.
26+
The endpoint supports region-based filtering.

docs/api/function/.pages

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,4 @@ nav:
44
- Delete: delete.md
55
- List: list.md
66
- Examples: examples.md
7+

docs/api/search/.pages

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,5 @@ nav:
22
- Search: search.md
33
- Around: around.md
44
- Value: value.md
5+
- Profile: profile.md
6+

docs/api/search/profile.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
## Search Inspector
2+
The Search Inspector in OpenObserve helps you identify what happens during a search operation.
3+
4+
## How to Use It
5+
Make a request to the following endpoint to get profiling information for your search operations:
6+
```
7+
GET /api/{org_id}/search/profile
8+
```
9+
This returns structured metadata about recent search executions for your organization.
10+
11+
## Why Use the Search Inspector
12+
- To find out why a search is slow and which part is causing the delay
13+
- To see how a search is processed step by step, including WAL, storage, and execution phases
14+
- To trace how the query moved across nodes, using OpenTelemetry for distributed tracking
15+
- To view all search metadata in one place, including role, timing, and component context
16+
- To debug reliably using logs that show durations in human-readable format and clear size metrics
17+
18+
## No Setup Required
19+
You do not need to configure anything. The Search Inspector works automatically in the background and shows real-time details when you query the endpoint.

docs/environment-variables.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,8 @@ OpenObserve is configured through the use of below environment variables.
128128
| ZO_CALCULATE_STATS_INTERVAL | 600 | No | In seconds. How often stream stats (total size) is calculated |
129129
| ZO_ENRICHMENT_TABLE_LIMIT | | No | |
130130
| ZO_SWAGGER_ENABLED | true | No | Generate SWAGGER API documentation by default. (since v0.10.8) |
131+
| ZO_INGEST_ALLOWED_UPTO | 5 | No | Discards events older than the specified number of hours. By default, OpenObserve accepts data only if it is not older than 5 hours from the current ingestion time.|
132+
| ZO_INGEST_ALLOWED_IN_FUTURE | 24 | No | Discards events dated beyond the specified number of future hours. By default, OpenObserve accepts data only if it is not timestamped more than 24 hours into the future.|
131133

132134
> For local mode, OpenObserve use sqlite as the metadata store.
133135
>
@@ -203,7 +205,10 @@ OpenObserve is configured through the use of below environment variables.
203205
| -------------------------------------- | ------------------------- | --------- | ------------------------------------------------------------------------- |
204206
| ZO_DATA_CACHE_DIR | ./data/openobserve/cache/ | No | local query cache storage directory, applicable only for cluster mode. |
205207
| ZO_MEMORY_CACHE_ENABLED | true | No | enable in-memory caching for files, default is true, the latest files are cached for accelerated queries. |
206-
| ZO_MEMORY_CACHE_CACHE_LATEST_FILES | false | No | by default we just cache files required by data being queried, enable this option to cache all the latest generated files. Caching all latest generated files can accelerate the queries on latest data, the time range for latest cached files depends on the max cache size. |
208+
| ZO_CACHE_LATEST_FILES_ENABLED | false | No | Enables or disables latest file caching.|
209+
| ZO_CACHE_LATEST_FILES_PARQUET | true | No | Enables caching of latest parquet files.|
210+
| ZO_CACHE_LATEST_FILES_INDEX | true | No | Enables caching of index files.|
211+
| ZO_CACHE_LATEST_FILES_DELETE_MERGE_FILES | false | No | Controls whether merged files should be deleted from cache.|
207212
| ZO_MEMORY_CACHE_MAX_SIZE | - | No | default 50% of the total memory used for in-memory cache, one can set it to desired amount unit: MB |
208213
| ZO_MEMORY_CACHE_SKIP_SIZE | - | No | default 80% of the total memory cache size, A query will skip memory cache if it need more than this value. one can set it to desired amount unit: MB |
209214
| ZO_MEMORY_CACHE_RELEASE_SIZE | - | No | default drop 1% entries from in-memory cache as cache is full, one can set it to desired amount unit: MB |

docs/images/dashboard-bulk-export.png

497 KB
Loading
232 KB
Loading

docs/images/dashboard-bulk-move.png

341 KB
Loading

0 commit comments

Comments
 (0)