Skip to content

Commit fdc0d3c

Browse files
update docs: reports, HEC ingestion support
1 parent 64760fd commit fdc0d3c

File tree

8 files changed

+57
-6
lines changed

8 files changed

+57
-6
lines changed

docs/user-guide/.pages

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ nav:
33
- Log Search: logs
44
- Metrics: metrics
55
- Streams: streams
6-
- Ingestion: ingestion.md
6+
- Ingestion: ingestion
77
- Pipelines: Pipelines
88
- Alerts: alerts
99
- Dashboards: dashboards

docs/user-guide/ingestion.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

docs/user-guide/ingestion/.pages

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
nav:
2+
- Ingestion Overview: index.md
3+
- Ingestion Format Support: ingestion-format-support.md

docs/user-guide/ingestion/index.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
The Ingestion section provides guidance to help users send data into OpenObserve from various sources.
2+
3+
Learn more:
4+
5+
- [Ingestion Format Support](ingestion-format-support.md)
6+
- [Logs ingestion](../../ingestion/logs/)
7+
- [Metrics ingestion](../../ingestion/metrics/)
8+
- [Traces ingestion](../../ingestion/traces)
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
OpenObserve supports ingestion in both JSON and HEC formats.
2+
3+
=== "Ingest JSON-formatted Logs"
4+
If your log files are in JSON format, use the following endpoint:
5+
6+
```
7+
https://api.openobserve.ai/api/<organization_id>/<stream_id>/_json
8+
```
9+
**Example:**
10+
Ingest JSON-formatted Logs Using cURL
11+
```
12+
curl https://api.openobserve.ai/api/<organization_id>/<stream_id>/_hec -i -u "[email protected]:Complexpass#123" -d "@k8slogs_json.json"
13+
```
14+
15+
=== "Ingest HEC-formatted Logs"
16+
If your log files are in HEC format, use the following endpoint:
17+
18+
```
19+
https://api.openobserve.ai/api/<organization_id>/<stream_id>/_hec
20+
```
21+
This ingestion method is useful for teams migrating from Splunk or using tools that generate logs in HEC format.
22+
23+
**Example:**
24+
Ingest HEC-formatted Logs Using cURL
25+
```
26+
curl https://api.openobserve.ai/api/<organization_id>/<stream_id>/_hec -i -u "[email protected]:Complexpass#123" -d "@logs_hec.hec"
27+
```
28+
29+
!!! Note
30+
Ensure that the log file matches the required format for the selected endpoint. Improperly formatted files will result in ingestion errors.
31+
32+
33+
34+
35+
36+

docs/user-guide/reports/.pages

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
nav:
2+
3+
- Reports Overview: index.md
4+
- Reports FAQ: reports-frequently-asked-questions.md

docs/user-guide/reports/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
The Reports section allows users to create and manage recurring reports from dashboard visualizations. Reports can be configured as either Scheduled or Cached.
2+
3+
Learn more:
4+
5+
- [Reports FAQ](reports-frequently-asked-questions.md)

docs/user-guide/reports/reports-frequently-asked-questions.md

Whitespace-only changes.

0 commit comments

Comments
 (0)