Skip to content

Commit 5fd8527

Browse files
committed
modified getting started page
1 parent 6bcf58b commit 5fd8527

File tree

1 file changed

+280
-0
lines changed

1 file changed

+280
-0
lines changed

docs/getting-started.md

Lines changed: 280 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<<<<<<< HEAD
12
# Quickstart
23

34
You can get started with [OpenObserve Cloud](https://cloud.openobserve.ai) or a self hosted installation.
@@ -146,3 +147,282 @@ Point your browser to [http://cloud.openobserve.ai](http://cloud.openobserve.ai)
146147

147148
Click on the "syntax guide" button next to the search bar to see examples on how to search.
148149

150+
=======
151+
# OpenObserve Quickstart Guide
152+
153+
This guide will help you get started with OpenObserve in under 10 minutes. You can choose between [OpenObserve Cloud](https://cloud.openobserve.ai) (recommended) or a self-hosted installation.
154+
155+
## Choose Your Installation Method
156+
157+
### [OpenObserve Cloud](https://cloud.openobserve.ai) (Recommended)
158+
159+
OpenObserve Cloud is the fastest way to get started and is recommended for most users because:
160+
161+
- **Zero maintenance**: No infrastructure setup or maintenance required
162+
- **Generous free tier**: Suitable for hobby projects, small companies, and startups
163+
- **Latest features**: Access to newest features and bug fixes first
164+
- **High availability**: Built-in redundancy and reliability
165+
166+
### Self-Hosted Installation
167+
168+
Choose self-hosted if you need:
169+
170+
- Full control over your data and infrastructure
171+
- Custom configurations or integrations
172+
- On-premises deployment requirements
173+
174+
175+
## Option 1: OpenObserve Cloud Setup
176+
177+
### Step 1: Create Your Account
178+
179+
1. Navigate to [https://cloud.openobserve.ai](https://cloud.openobserve.ai)
180+
2. Sign up using social login or create a new account
181+
182+
![Sign in page](./images/quickstart/signin.png)
183+
184+
### Step 2: Get Your Ingestion Credentials
185+
186+
1. After logging in, navigate to the **Data Sources** section in the sidebar
187+
188+
![Ingestion](./images/quickstart/ingestion_credentials.png)
189+
190+
2. Copy the provided cURL command - it contains your unique credentials
191+
3. Your endpoint will look like: `https://api.openobserve.ai/api/[YOUR_ORG]/default/_json`
192+
193+
You are ready to ingest data. Now head over to [Load sample data](#load-sample-data) section.
194+
195+
## Option 2: Self-Hosted Installation
196+
197+
**Important**: These instructions are for single-node installations. For production high-availability setups, see our [HA deployment guide](./ha_deployment.md).
198+
199+
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.
200+
201+
### Windows Installation
202+
203+
1. Download the Windows binary from our [releases page](https://github.com/openobserve/openobserve/releases)
204+
2. Open Command Prompt or PowerShell as Administrator
205+
3. Run the following commands:
206+
207+
```cmd
208+
# Command Prompt
209+
210+
set ZO_ROOT_USER_PASSWORD=Complexpass#123
211+
openobserve.exe
212+
```
213+
214+
```powershell
215+
# PowerShell
216+
$env:ZO_ROOT_USER_EMAIL="[email protected]"
217+
$env:ZO_ROOT_USER_PASSWORD="Complexpass#123"
218+
.\openobserve.exe
219+
```
220+
> **Note:** You can set email and password based on your preference
221+
222+
### macOS/Linux Installation
223+
224+
**Option A: Quick Install Script**
225+
```bash
226+
# Download and install latest version automatically
227+
curl -L https://raw.githubusercontent.com/openobserve/openobserve/main/download.sh | sh
228+
229+
# Run OpenObserve
230+
ZO_ROOT_USER_EMAIL="[email protected]" ZO_ROOT_USER_PASSWORD="Complexpass#123" ./openobserve
231+
```
232+
233+
**Option B: Manual Download**
234+
235+
1. Download the appropriate binary from our [releases page](https://github.com/openobserve/openobserve/releases)
236+
2. Make it executable: `chmod +x openobserve`
237+
3. Run with environment variables as shown:
238+
```bash
239+
# Run OpenObserve
240+
ZO_ROOT_USER_EMAIL="[email protected]" ZO_ROOT_USER_PASSWORD="Complexpass#123" ./openobserve
241+
```
242+
243+
**Troubleshooting glibc Errors**
244+
245+
If you see an error like `version GLIBC_2.27 not found`, download the `musl` binary instead:
246+
- Look for files ending in `-linux-musl.tar.gz` on the releases page
247+
248+
> Note: musl binaries have slightly lower performance but no external dependencies
249+
250+
### Docker Installation
251+
252+
**Prerequisites**: Ensure Docker is installed and running on your system.
253+
254+
Docker images are available at [https://gallery.ecr.aws/zinclabs/openobserve](https://gallery.ecr.aws/zinclabs/openobserve)
255+
256+
```bash
257+
# Create a data directory
258+
mkdir -p ./openobserve-data
259+
260+
# Run OpenObserve container
261+
docker run -d \
262+
--name openobserve \
263+
-v ./openobserve-data:/data \
264+
-e ZO_DATA_DIR="/data" \
265+
-e ZO_ROOT_USER_EMAIL="[email protected]" \
266+
-e ZO_ROOT_USER_PASSWORD="Complexpass#123" \
267+
-p 5080:5080 \
268+
public.ecr.aws/zinclabs/openobserve:latest
269+
```
270+
271+
**Windows Docker Command**:
272+
```cmd
273+
# Windows Command Prompt
274+
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
275+
```
276+
277+
**Docker Image Options**:
278+
279+
- `latest`: Compatible with most environments
280+
- `latest-simd`: Optimized for systems with AVX512 (Intel) or NEON (ARM) for better performance
281+
282+
**Troubleshooting Docker Issues**:
283+
284+
If you encounter AWS ECR login issues:
285+
```bash
286+
aws ecr-public get-login-password --region us-east-1 | docker login --username AWS --password-stdin public.ecr.aws
287+
```
288+
289+
### Kubernetes Installation
290+
291+
**Prerequisites**: Ensure `kubectl` is configured and you have cluster access.
292+
293+
1. Create namespace:
294+
```bash
295+
kubectl create namespace openobserve
296+
```
297+
298+
2. Deploy OpenObserve:
299+
```bash
300+
kubectl apply -f https://raw.githubusercontent.com/zinclabs/openobserve/main/deploy/k8s/statefulset.yaml
301+
```
302+
303+
3. Access the service:
304+
```bash
305+
kubectl -n openobserve port-forward svc/openobserve 5080:5080
306+
```
307+
308+
## Verify Installation
309+
310+
After installation, verify OpenObserve is running:
311+
312+
1. Open your browser and navigate to:
313+
- **Self-hosted**: [http://localhost:5080](http://localhost:5080)
314+
- **Cloud**: [https://cloud.openobserve.ai](https://cloud.openobserve.ai)
315+
316+
2. Log in with your credentials:
317+
- **Self-hosted**: Use the email/password you set in environment variables
318+
- **Cloud**: Use your account credentials
319+
320+
3. You should see the OpenObserve dashboard
321+
322+
323+
## Load Sample Data
324+
325+
Let's load some real-world log data to explore OpenObserve's features.
326+
327+
### Step 1: Download Sample Data
328+
329+
```bash
330+
# Download and extract sample Kubernetes logs
331+
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
332+
unzip k8slog_json.json.zip
333+
```
334+
335+
**What's in the sample data**: This file contains real Kubernetes application logs with various log levels (info, warning, error) and structured JSON fields.
336+
337+
### Step 2: Load Data into OpenObserve
338+
339+
**For OpenObserve Cloud**:
340+
```bash
341+
# Use the cURL command from your Ingestion page
342+
curl -u [email protected]:your-password \
343+
-H "Content-Type: application/json" \
344+
https://api.openobserve.ai/api/YOUR_ORG/default/_json \
345+
-d "@k8slog_json.json"
346+
```
347+
348+
**For Self-Hosted Installation**:
349+
```bash
350+
curl -u "[email protected]:Complexpass#123" \
351+
-H "Content-Type: application/json" \
352+
http://localhost:5080/api/default/default/_json \
353+
-d "@k8slog_json.json"
354+
```
355+
356+
### Step 3: Verify Data Upload
357+
358+
You should see output similar to:
359+
```json
360+
{"code":200,"status":"ok","records":1000}
361+
```
362+
363+
If you see errors, check:
364+
- Your credentials are correct
365+
- The JSON file was downloaded completely
366+
- OpenObserve is running and accessible
367+
368+
369+
## Search Your Data
370+
371+
Now let's explore the data you just loaded.
372+
373+
**Step 1: Access the Logs Interface**
374+
375+
1. Navigate to your OpenObserve instance
376+
2. Click on **Logs** in the left sidebar
377+
3. Select **default** from the stream dropdown (top-left)
378+
379+
![Logs page](./images/quickstart/logs_page.png)
380+
381+
382+
**Step 2: Try These Sample Searches**
383+
384+
**Basic searches** (click the **Run Query** button after each):
385+
386+
1. **View all logs**: Leave search box empty and click search
387+
2. **Find errors**: `level='error'` or `match_all('error')`
388+
389+
*Congratulations! You now have OpenObserve running with sample data.*
390+
391+
392+
## Next Steps - Send Your Own Data
393+
394+
- **Application logs**: Use our [logging libraries](./ingestion/logs/otlp.md) for your applications
395+
- **Metrics**: Set up [Prometheus integration](./ingestion/metrics/prometheus.md)
396+
- **Traces**: Configure [OpenTelemetry](./ingestion/traces/opentelemetry.md) for distributed tracing
397+
398+
399+
## Troubleshooting Common Issues
400+
401+
**Can't access OpenObserve web interface**:
402+
403+
- Check if the process is running
404+
- Verify port 5080 is not blocked by firewall
405+
- For Docker: ensure port mapping is correct (`-p 5080:5080`)
406+
407+
**Authentication errors**:
408+
409+
- Verify your email/password combination
410+
- For self-hosted: ensure environment variables were set correctly
411+
- For cloud: check your account credentials
412+
413+
**Data not appearing**:
414+
415+
- Verify the curl command returned success (200 status)
416+
- Check the time range in the web interface
417+
- Ensure you selected the correct stream/index
418+
419+
**Performance issues**:
420+
421+
- Consider using the SIMD Docker image for better performance
422+
- Check available memory and CPU resources
423+
- For large datasets, consider the high-availability deployment
424+
425+
### Getting Support
426+
427+
If you're still having issues, Join our [Slack Community](https://short.openobserve.ai/community) for help
428+
>>>>>>> 5ff082c (modified getting started page)

0 commit comments

Comments
 (0)