Skip to content

Commit c70b81b

Browse files
committed
resolving conflict for pages file
1 parent 89e87bd commit c70b81b

File tree

2 files changed

+145
-6
lines changed

2 files changed

+145
-6
lines changed

docs/.pages

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ nav:
1010
- Architecture: architecture.md
1111
=======
1212
- Overview: overview
13-
- Getting started: quickstart.md
13+
- Getting started: getting-started.md
1414
- Features: features
1515
- Enterprise Edition Installation Guide: openobserve-enterprise-edition-installation-guide.md
1616
- Releases: releases.md

docs/getting-started.md

Lines changed: 144 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,148 @@
1-
# Getting Started
1+
# Quickstart
22

3-
Check [quickstart](./quickstart.md) to experience the power and simplicity of OpenObserve.
3+
You can get started with [OpenObserve Cloud](https://cloud.openobserve.ai) or a self hosted installation.
44

5-
Check the below video for a quick demo/getting started of OpenObserve.
5+
OpenObserve Cloud is recommended for most users due to following benefits:
66

7-
## OpenObserve introduction video
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...
11+
12+
## OpenObserve Cloud
13+
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.
15+
16+
Let's go through it.
17+
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)
22+
23+
3. Now head over to `Ingestion` section and grab `CURL` command
24+
25+
![Ingestion](./images/quickstart/ingestion_credentials.png)
26+
27+
Now head over to [Load sample data](#load-sample-data) section
28+
29+
30+
## Self hosted Installation
31+
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.
33+
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.
35+
36+
=== "Windows"
37+
38+
Binaries can be downloaded from [releases](https://github.com/openobserve/openobserve/releases) page for appropriate platform.
39+
40+
41+
42+
set ZO_ROOT_USER_PASSWORD=Complexpass#123
43+
openobserve.exe
44+
45+
46+
Now point your browser to [http://localhost:5080](http://localhost:5080) and login
47+
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:
50+
51+
curl -L https://raw.githubusercontent.com/openobserve/openobserve/main/download.sh | sh
52+
53+
Once downloaded run it using below command:
54+
55+
ZO_ROOT_USER_EMAIL="[email protected]" ZO_ROOT_USER_PASSWORD="Complexpass#123" ./openobserve
56+
57+
58+
Now point your browser to [http://localhost:5080](http://localhost:5080) and login
59+
60+
**Getting glibc error running binary**
61+
62+
```shell
63+
./openobserve: `/lib/libm.so.6`: version `GLIBC_2.27` not found (required by ./openobserve)
64+
```
65+
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.
67+
68+
=== "Docker"
69+
70+
Docker images are available at [https://gallery.ecr.aws/zinclabs/openobserve](https://gallery.ecr.aws/zinclabs/openobserve)
71+
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
75+
76+
77+
Now point your browser to [http://localhost:5080](http://localhost:5080) and login
78+
79+
**Error pulling image if you have AWS CLI installed?**
80+
81+
If you have AWS CLI installed and get login error then run below command:
82+
83+
aws ecr-public get-login-password --region us-east-1 | docker login --username AWS --password-stdin public.ecr.aws
84+
85+
86+
*** Docker tags ***
87+
88+
- `public.ecr.aws/zinclabs/openobserve:latest`
89+
90+
Compatible with environments of most users
91+
92+
- `public.ecr.aws/zinclabs/openobserve:latest-simd`
93+
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.
95+
96+
=== "Kubernetes - Manifest"
97+
98+
Create a namespace:
99+
100+
kubectl create ns openobserve
101+
102+
Create the deployment and port forward:
103+
104+
kubectl apply -f https://raw.githubusercontent.com/zinclabs/openobserve/main/deploy/k8s/statefulset.yaml
105+
106+
Expose the openobserve service by port-forwarding:
107+
108+
kubectl -n openobserve port-forward svc/openobserve 5080:5080
109+
110+
Now point your browser to [http://localhost:5080](http://localhost:5080) and login
111+
112+
## Load sample data
113+
114+
We will use JSON API to load sample log data.
115+
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.
117+
118+
**Download sample data**
119+
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+
```
124+
125+
**Load sample data**
126+
127+
*Note*: Replace the URL you got from OpenObserve Cloud and append it with `@k8slog_json.json`
128+
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+
```
132+
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+
```
136+
137+
138+
## Search for data
139+
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
141+
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.
146+
147+
Click on the "syntax guide" button next to the search bar to see examples on how to search.
8148

9-
[![OpenObserve Youtube](./images/zo_intro_youtube.webp)](https://www.youtube.com/watch?v=fZ-ErfMdF-o)

0 commit comments

Comments
 (0)