Skip to content

Commit 286e7f6

Browse files
authored
Merge pull request #74 from simranquirky/getting-started
modified getting started page
2 parents 6bcf58b + 4f45cc3 commit 286e7f6

File tree

6 files changed

+212
-96
lines changed

6 files changed

+212
-96
lines changed

docs/.pages

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,6 @@
11
nav:
2-
<<<<<<< HEAD
3-
<<<<<<< HEAD
4-
- Introduction: index.md
5-
- Getting started: getting-started.md
6-
- Quickstart: quickstart.md
7-
- Enterprise Edition Installation: openobserve-enterprise-edition-installation-guide.md
8-
- Releases: releases.md
9-
- Example Queries: example-queries.md
10-
- SQL Function Reference: sql_reference.md
11-
- Architecture: architecture.md
12-
=======
13-
=======
14-
>>>>>>> b992089 (nav bar modification:)
152
- Overview: overview
16-
- Architecture: architecture.md
3+
- Architechture: architecture.md
174
- Getting started: getting-started.md
185
- Features: features
196
- Enterprise Edition Installation Guide: openobserve-enterprise-edition-installation-guide.md

docs/features/logs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ OpenObserve provides powerful log management capabilities for collecting, storin
66

77
Logs in OpenObserve offer comprehensive observability into your system's behavior, allowing you to track events, debug issues, and monitor application performance. Built with high performance and cost efficiency in mind, OpenObserve handles log ingestion and querying at scale.
88

9-
![Logs Page](../images/features/logs-page.png)
9+
![Logs Page](../images/features/logs-hero.png)
1010
*Logs Page view*
1111

1212
## Key Features

docs/features/metrics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ OpenObserve provides comprehensive metrics collection, storage, and visualizatio
66

77
Metrics in OpenObserve enable you to track key performance indicators, monitor system health, and gain insights into your application's behavior over time. Designed for high-throughput environments, OpenObserve efficiently handles metrics ingestion, storage, and querying at scale while maintaining cost-effectiveness.
88

9-
![Metrics Page](../images/features/metrics-page.png)
9+
![Metrics Page](../images/features/metrics-hero.png)
1010
*Metrics Page view*
1111

1212
## Key Features

docs/getting-started.md

Lines changed: 209 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -1,148 +1,277 @@
1-
# Quickstart
1+
# OpenObserve Quickstart Guide
22

3-
You can get started with [OpenObserve Cloud](https://cloud.openobserve.ai) or a self hosted installation.
3+
This guide will help you get started with OpenObserve. You can choose between [OpenObserve Cloud](https://cloud.openobserve.ai) (recommended) or a self-hosted installation.
44

5-
OpenObserve Cloud is recommended for most users due to following benefits:
5+
## Choose Your Installation Method
66

7-
1. No effort in setting up a `Highly Available` installation and maintaining it.
8-
1. OpenObserve Cloud with its generous free tier is quite a lot for most hobby users / smaller companies / startups.
9-
1. Newer features and bug fixes are available earlier in OpenObserve Cloud.
10-
1. And more...
7+
=== "OpenObserve Cloud(Recommended)"
118

12-
## OpenObserve Cloud
9+
[OpenObserve Cloud](https://cloud.openobserve.ai) is the fastest way to get started and is recommended for most users because:
1310

14-
OpenObserve Cloud is offered as a hosted service backed by open source OpenObserve. It has the same features as that of OpenObserve with generous free tier with no effort on maintaining infrastructure for your own cluster.
11+
- **Zero maintenance:** No need to set up, operate, or upgrade infrastructure — we handle it all for you.
12+
- **Effortless scaling:** Easily handle growing data volumes without worrying about capacity planning or scaling issues.
13+
- **Always up-to-date:** Get the latest features, improvements, and security patches automatically.
1514

16-
Let's go through it.
15+
=== "Self-Hosted Installation"
1716

18-
1. Navigate to [https://cloud.openobserve.ai](https://cloud.openobserve.ai)
19-
2. Use a social login to create an account or login
20-
21-
![Sign in page](./images/quickstart/signin.png)
17+
Choose self-hosted if you need:
2218

23-
3. Now head over to `Ingestion` section and grab `CURL` command
19+
- Full control over your data and infrastructure
20+
- Custom configurations or integrations
21+
- On-premises deployment requirements
2422

25-
![Ingestion](./images/quickstart/ingestion_credentials.png)
2623

27-
Now head over to [Load sample data](#load-sample-data) section
24+
## Option 1: OpenObserve Cloud Setup
2825

26+
??? "Step 1: Create Your Account"
2927

30-
## Self hosted Installation
28+
1. Navigate to [https://cloud.openobserve.ai](https://cloud.openobserve.ai)
29+
2. Sign up using social login or create a new account
3130

32-
**Note**: Installation directions on this page is for single node installations. If you are looking for a `Highly Available` installation then head over to [HA deployment](./ha_deployment.md) section.
31+
![Sign in page](./images/quickstart/signin.png)
3332

34-
You would need ZO_ROOT_USER_EMAIL and ZO_ROOT_USER_PASSWORD environment variables when you start OpenObserve for the first time. You don't need them on subsequent runs of OpenObserve.
33+
??? "Step 2: Get Your Ingestion Credentials"
3534

36-
=== "Windows"
35+
1. After logging in, navigate to the **Data Sources** section in the sidebar
3736

38-
Binaries can be downloaded from [releases](https://github.com/openobserve/openobserve/releases) page for appropriate platform.
37+
![Ingestion](./images/quickstart/ingestion_credentials.png)
3938

39+
2. Copy the provided cURL command - it contains your unique credentials
40+
3. Your endpoint will look like: `https://api.openobserve.ai/api/[YOUR_ORG]/default/_json`
4041

41-
42-
set ZO_ROOT_USER_PASSWORD=Complexpass#123
43-
openobserve.exe
42+
You are ready to ingest data. Now head over to [Load sample data](#load-sample-data) section.
4443

44+
## Option 2: Self-Hosted Installation
4545

46-
Now point your browser to [http://localhost:5080](http://localhost:5080) and login
46+
> **Important**: These instructions are for single-node installations. For production high-availability setups, see our [HA deployment guide](./ha_deployment.md).
4747
48-
=== "MacOS/Linux Binaries"
49-
You could run the below command to download latest version of OpenObserve for your platform. Alternatively you could download the binary from [releases](https://github.com/openobserve/openobserve/releases) page manually:
48+
You'll need to set root user credentials (ZO_ROOT_USER_EMAIL and ZO_ROOT_USER_PASSWORD) on first startup only. They are not required for subsequent runs.
49+
50+
=== "Windows"
51+
52+
**Download and Install**
53+
54+
1. Download the Windows binary from our [releases page](https://github.com/openobserve/openobserve/releases)
55+
2. Open Command Prompt or PowerShell as Administrator
56+
3. Run the following commands:
57+
58+
```cmd
59+
#command prompt
60+
61+
set ZO_ROOT_USER_PASSWORD=Complexpass#123
62+
openobserve.exe
63+
```
5064

51-
curl -L https://raw.githubusercontent.com/openobserve/openobserve/main/download.sh | sh
65+
```powershell
66+
#powershell
67+
$env:ZO_ROOT_USER_EMAIL="[email protected]"
68+
$env:ZO_ROOT_USER_PASSWORD="Complexpass#123"
69+
.\openobserve.exe
70+
```
71+
72+
!!! note
73+
You can set email and password based on your preference
5274

53-
Once downloaded run it using below command:
5475

55-
ZO_ROOT_USER_EMAIL="[email protected]" ZO_ROOT_USER_PASSWORD="Complexpass#123" ./openobserve
76+
=== "MacOS/Linux Binaries"
5677

78+
**Option A: Quick Install Script**
79+
```bash
80+
# Download and install latest version automatically
81+
curl -L https://raw.githubusercontent.com/openobserve/openobserve/main/download.sh | sh
5782

58-
Now point your browser to [http://localhost:5080](http://localhost:5080) and login
83+
# Run OpenObserve
84+
ZO_ROOT_USER_EMAIL="[email protected]" ZO_ROOT_USER_PASSWORD="Complexpass#123" ./openobserve
85+
```
5986

60-
**Getting glibc error running binary**
87+
**Option B: Manual Download**
6188

62-
```shell
63-
./openobserve: `/lib/libm.so.6`: version `GLIBC_2.27` not found (required by ./openobserve)
89+
1. Download the appropriate binary from our [releases page](https://github.com/openobserve/openobserve/releases)
90+
2. Make it executable: `chmod +x openobserve`
91+
3. Run with environment variables as shown:
92+
```bash
93+
# Run OpenObserve
94+
ZO_ROOT_USER_EMAIL="[email protected]" ZO_ROOT_USER_PASSWORD="Complexpass#123" ./openobserve
6495
```
6596

66-
> Download the `musl` binary instead of regular binary from [releases](https://github.com/openobserve/openobserve/releases) page that has no external dependencies. This binary is not as performant as other binaries though. We recommend running the containerized version if performance is a concern for you and are unable to make the dependencies work.
97+
!!! note
98+
If you see an error like `version GLIBC_2.27 not found`, download the `musl` binary instead:
99+
100+
- Look for files ending in `-linux-musl.tar.gz` on the releases page
101+
- musl binaries have slightly lower performance but no external dependencies
67102

68103
=== "Docker"
69104

70-
Docker images are available at [https://gallery.ecr.aws/zinclabs/openobserve](https://gallery.ecr.aws/zinclabs/openobserve)
105+
**Prerequisites**: Ensure Docker is installed and running on your system.
71106

72-
docker run -v $PWD/data:/data -e ZO_DATA_DIR="/data" -p 5080:5080 \
73-
-e ZO_ROOT_USER_EMAIL="[email protected]" -e ZO_ROOT_USER_PASSWORD="Complexpass#123" \
74-
public.ecr.aws/zinclabs/openobserve:latest
107+
Docker images are available at:
108+
109+
- Enterprise: [https://gallery.ecr.aws/zinclabs/openobserve-enterprise](https://gallery.ecr.aws/zinclabs/openobserve-enterprise)
110+
- OSS : [https://gallery.ecr.aws/zinclabs/openobserve](https://gallery.ecr.aws/zinclabs/openobserve)
111+
112+
113+
**Linux/macOS:**
114+
```bash
115+
docker run -v $PWD/data:/data -e ZO_DATA_DIR="/data" -p 5080:5080 \
116+
-e ZO_ROOT_USER_EMAIL="[email protected]" -e ZO_ROOT_USER_PASSWORD="Complexpass#123" \
117+
public.ecr.aws/zinclabs/openobserve:latest
118+
```
75119

120+
**Windows:**
121+
```cmd
122+
# Windows Command Prompt
123+
docker run -d --name openobserve -v %cd%/openobserve-data:/data -e ZO_DATA_DIR="/data" -e ZO_ROOT_USER_EMAIL="[email protected]" -e ZO_ROOT_USER_PASSWORD="Complexpass#123" -p 5080:5080 public.ecr.aws/zinclabs/openobserve:latest
124+
```
76125

77-
Now point your browser to [http://localhost:5080](http://localhost:5080) and login
126+
**Docker Image Options:**
78127

79-
**Error pulling image if you have AWS CLI installed?**
128+
- `latest`: Compatible with most environments
129+
- `latest-simd`: Optimized for systems with AVX512 (Intel) or NEON (ARM) for better performance
80130

81-
If you have AWS CLI installed and get login error then run below command:
131+
!!! Troubleshooting
82132

133+
If you encounter AWS ECR login issues:
134+
```bash
83135
aws ecr-public get-login-password --region us-east-1 | docker login --username AWS --password-stdin public.ecr.aws
136+
```
84137

85-
86-
*** Docker tags ***
138+
=== "Kubernetes - Manifest"
139+
140+
**Prerequisites**: Ensure `kubectl` is configured and you have cluster access.
87141

88-
- `public.ecr.aws/zinclabs/openobserve:latest`
142+
1. **Create namespace:**
143+
```bash
144+
kubectl create namespace openobserve
145+
```
89146

90-
Compatible with environments of most users
147+
2. **Deploy OpenObserve:**
148+
```bash
149+
kubectl apply -f https://raw.githubusercontent.com/zinclabs/openobserve/main/deploy/k8s/statefulset.yaml
150+
```
91151

92-
- `public.ecr.aws/zinclabs/openobserve:latest-simd`
152+
3. **Access the service:**
153+
```bash
154+
kubectl -n openobserve port-forward svc/openobserve 5080:5080
155+
```
93156

94-
If you want to leverage OpenObserve's support for vectorization then you should use this image. OpenObserve supports `AVX512` on intel CPUs, or `NEON` on ARM CPUs. This will help you get higher performance.
95157

96-
=== "Kubernetes - Manifest"
97158

98-
Create a namespace:
159+
## Verify Installation
160+
161+
After installation, verify OpenObserve is running:
162+
163+
1. Open your browser and navigate to:
164+
- **Self-hosted**: [http://localhost:5080](http://localhost:5080)
165+
- **Cloud**: [https://cloud.openobserve.ai](https://cloud.openobserve.ai)
166+
167+
2. Log in with your credentials:
168+
- **Self-hosted**: Use the email/password you set in environment variables
169+
- **Cloud**: Use your account credentials
170+
171+
3. You should see the OpenObserve dashboard
172+
173+
174+
## Load Sample Data
175+
176+
Let's load some real-world log data to explore OpenObserve's features.
177+
178+
??? "Step 1: Download Sample Data"
179+
180+
```bash
181+
# Download and extract sample Kubernetes logs
182+
curl -L https://zinc-public-data.s3.us-west-2.amazonaws.com/zinc-enl/sample-k8s-logs/k8slog_json.json.zip -o k8slog_json.json.zip
183+
unzip k8slog_json.json.zip
184+
```
185+
186+
**What's in the sample data**: This file contains real Kubernetes application logs with various log levels (info, warning, error) and structured JSON fields.
187+
188+
??? "Step 2: Load Data into OpenObserve"
189+
190+
**For OpenObserve Cloud**:
191+
```bash
192+
# Use the cURL command from your Ingestion page
193+
curl -u [email protected]:your-password \
194+
-H "Content-Type: application/json" \
195+
https://api.openobserve.ai/api/YOUR_ORG/default/_json \
196+
-d "@k8slog_json.json"
197+
```
198+
199+
**For Self-Hosted Installation**:
200+
```bash
201+
curl -u "[email protected]:Complexpass#123" \
202+
-H "Content-Type: application/json" \
203+
http://localhost:5080/api/default/default/_json \
204+
-d "@k8slog_json.json"
205+
```
206+
207+
??? "Step 3: Verify Data Upload"
208+
209+
You should see output similar to:
210+
```json
211+
{"code":200,"status":"ok","records":1000}
212+
```
213+
214+
If you see errors, check:
215+
216+
- Your credentials are correct
217+
- The JSON file was downloaded completely
218+
- OpenObserve is running and accessible
219+
220+
221+
## Search Your Data
222+
223+
Now let's explore the data you just loaded.
224+
225+
??? "Step 1: Access the Logs Interface"
99226

100-
kubectl create ns openobserve
227+
1. Navigate to your OpenObserve instance
228+
2. Click on **Logs** in the left sidebar
229+
3. Select **default** from the stream dropdown (top-left)
101230

102-
Create the deployment and port forward:
231+
![Logs page](./images/quickstart/logs_page.png)
103232

104-
kubectl apply -f https://raw.githubusercontent.com/zinclabs/openobserve/main/deploy/k8s/statefulset.yaml
105233

106-
Expose the openobserve service by port-forwarding:
234+
??? "Step 2: Try These Sample Searches"
107235

108-
kubectl -n openobserve port-forward svc/openobserve 5080:5080
236+
**Basic searches** (click the **Run Query** button after each):
109237

110-
Now point your browser to [http://localhost:5080](http://localhost:5080) and login
238+
1. **View all logs**: Leave search box empty and click search
239+
2. **Find errors**: `level='error'` or `match_all('error')`
111240

112-
## Load sample data
241+
*Congratulations! You now have OpenObserve running with sample data.*
113242

114-
We will use JSON API to load sample log data.
115243

116-
Below commands will download a sample file of real life log data, unzip it and load it in OpenObserve using the JSON ingestion API.
244+
## Next Steps - Send Your Own Data
117245

118-
**Download sample data**
246+
- **Application logs**: Use our [logging libraries](./ingestion/logs/otlp.md) for your applications
247+
- **Metrics**: Set up [Prometheus integration](./ingestion/metrics/prometheus.md)
248+
- **Traces**: Configure [OpenTelemetry](./ingestion/traces/opentelemetry.md) for distributed tracing
119249

120-
```shell
121-
curl -L https://zinc-public-data.s3.us-west-2.amazonaws.com/zinc-enl/sample-k8s-logs/k8slog_json.json.zip -o k8slog_json.json.zip
122-
unzip k8slog_json.json.zip
123-
```
124250

125-
**Load sample data**
251+
## Troubleshooting Common Issues
126252

127-
*Note*: Replace the URL you got from OpenObserve Cloud and append it with `@k8slog_json.json`
253+
??? "Can't access OpenObserve web interface"
128254

129-
```shell title="For OpenObserve Cloud"
130-
curl -u [email protected]:abqlg4b673465w46hR2905 -k https://api.openobserve.ai/api/User_organization_435345/default/_json -d "@k8slog_json.json"
131-
```
255+
- Check if the process is running
256+
- Verify port 5080 is not blocked by firewall
257+
- For Docker: ensure port mapping is correct (`-p 5080:5080`)
132258

133-
```shell title="For self hosted installation"
134-
curl http://localhost:5080/api/default/default/_json -i -u "[email protected]:Complexpass#123" -d "@k8slog_json.json"
135-
```
259+
??? "Authentication errors"
136260

261+
- Verify your email/password combination
262+
- For self-hosted: ensure environment variables were set correctly
263+
- For cloud: check your account credentials
137264

138-
## Search for data
265+
??? "Data not appearing"
139266

140-
Point your browser to [http://cloud.openobserve.ai](http://cloud.openobserve.ai) (for OpenObserve Cloud) / [http://localhost:5080](http://localhost:5080) (for self hosted) and login
267+
- Verify the curl command returned success (200 status)
268+
- Check the time range in the web interface
269+
- Ensure you selected the correct stream/index
141270

142-
1. Visit `logs` page
143-
1. Select the index `default` from drop down in the left
144-
![Logs page](./images/quickstart/logs_page.png)
145-
1. Type `match_all('error')` in search bar and click the search button on right.
271+
??? "Performance issues"
146272

147-
Click on the "syntax guide" button next to the search bar to see examples on how to search.
273+
- Consider using the SIMD Docker image for better performance
274+
- Check available memory and CPU resources
275+
- For large datasets, consider the high-availability deployment
148276

277+
If you're still having issues, Join our [Slack Community](https://short.openobserve.ai/community) for help

docs/images/features/logs-hero.png

994 KB
Loading

docs/images/features/metrics-hero.png

438 KB
Loading

0 commit comments

Comments
 (0)