|
1 |
| -# Quickstart |
| 1 | +# OpenObserve Quickstart Guide |
2 | 2 |
|
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. |
4 | 4 |
|
5 |
| -OpenObserve Cloud is recommended for most users due to following benefits: |
| 5 | +## Choose Your Installation Method |
6 | 6 |
|
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)" |
11 | 8 |
|
12 |
| -## OpenObserve Cloud |
| 9 | + [OpenObserve Cloud](https://cloud.openobserve.ai) is the fastest way to get started and is recommended for most users because: |
13 | 10 |
|
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. |
15 | 14 |
|
16 |
| -Let's go through it. |
| 15 | +=== "Self-Hosted Installation" |
17 | 16 |
|
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 |
| -  |
| 17 | + Choose self-hosted if you need: |
22 | 18 |
|
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 |
24 | 22 |
|
25 |
| - |
26 | 23 |
|
27 |
| -Now head over to [Load sample data](#load-sample-data) section |
| 24 | +## Option 1: OpenObserve Cloud Setup |
28 | 25 |
|
| 26 | +??? "Step 1: Create Your Account" |
29 | 27 |
|
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 |
31 | 30 |
|
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 | +  |
33 | 32 |
|
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" |
35 | 34 |
|
36 |
| -=== "Windows" |
| 35 | + 1. After logging in, navigate to the **Data Sources** section in the sidebar |
37 | 36 |
|
38 |
| - Binaries can be downloaded from [releases](https://github.com/openobserve/openobserve/releases) page for appropriate platform. |
| 37 | +  |
39 | 38 |
|
| 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` |
40 | 41 |
|
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. |
44 | 43 |
|
| 44 | +## Option 2: Self-Hosted Installation |
45 | 45 |
|
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). |
47 | 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: |
| 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 | + ``` |
50 | 64 |
|
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 |
52 | 74 |
|
53 |
| - Once downloaded run it using below command: |
54 | 75 |
|
55 |
| - ZO_ROOT_USER_EMAIL="[email protected]" ZO_ROOT_USER_PASSWORD="Complexpass#123" ./openobserve |
| 76 | +=== "MacOS/Linux Binaries" |
56 | 77 |
|
| 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 |
57 | 82 |
|
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 | + ``` |
59 | 86 |
|
60 |
| - **Getting glibc error running binary** |
| 87 | + **Option B: Manual Download** |
61 | 88 |
|
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 |
64 | 95 | ```
|
65 | 96 |
|
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 |
67 | 102 |
|
68 | 103 | === "Docker"
|
69 | 104 |
|
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. |
71 | 106 |
|
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 | + ``` |
75 | 119 |
|
| 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 | + ``` |
76 | 125 |
|
77 |
| - Now point your browser to [http://localhost:5080](http://localhost:5080) and login |
| 126 | + **Docker Image Options:** |
78 | 127 |
|
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 |
80 | 130 |
|
81 |
| - If you have AWS CLI installed and get login error then run below command: |
| 131 | + !!! Troubleshooting |
82 | 132 |
|
| 133 | + If you encounter AWS ECR login issues: |
| 134 | + ```bash |
83 | 135 | aws ecr-public get-login-password --region us-east-1 | docker login --username AWS --password-stdin public.ecr.aws
|
| 136 | + ``` |
84 | 137 |
|
85 |
| - |
86 |
| - *** Docker tags *** |
| 138 | +=== "Kubernetes - Manifest" |
| 139 | + |
| 140 | + **Prerequisites**: Ensure `kubectl` is configured and you have cluster access. |
87 | 141 |
|
88 |
| - - `public.ecr.aws/zinclabs/openobserve:latest` |
| 142 | + 1. **Create namespace:** |
| 143 | + ```bash |
| 144 | + kubectl create namespace openobserve |
| 145 | + ``` |
89 | 146 |
|
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 | + ``` |
91 | 151 |
|
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 | + ``` |
93 | 156 |
|
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 | 157 |
|
96 |
| -=== "Kubernetes - Manifest" |
97 | 158 |
|
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" |
99 | 226 |
|
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) |
101 | 230 |
|
102 |
| - Create the deployment and port forward: |
| 231 | +  |
103 | 232 |
|
104 |
| - kubectl apply -f https://raw.githubusercontent.com/zinclabs/openobserve/main/deploy/k8s/statefulset.yaml |
105 | 233 |
|
106 |
| - Expose the openobserve service by port-forwarding: |
| 234 | +??? "Step 2: Try These Sample Searches" |
107 | 235 |
|
108 |
| - kubectl -n openobserve port-forward svc/openobserve 5080:5080 |
| 236 | + **Basic searches** (click the **Run Query** button after each): |
109 | 237 |
|
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')` |
111 | 240 |
|
112 |
| -## Load sample data |
| 241 | +*Congratulations! You now have OpenObserve running with sample data.* |
113 | 242 |
|
114 |
| -We will use JSON API to load sample log data. |
115 | 243 |
|
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 |
117 | 245 |
|
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 |
119 | 249 |
|
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 | 250 |
|
125 |
| -**Load sample data** |
| 251 | +## Troubleshooting Common Issues |
126 | 252 |
|
127 |
| -*Note*: Replace the URL you got from OpenObserve Cloud and append it with `@k8slog_json.json` |
| 253 | +??? "Can't access OpenObserve web interface" |
128 | 254 |
|
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`) |
132 | 258 |
|
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" |
136 | 260 |
|
| 261 | + - Verify your email/password combination |
| 262 | + - For self-hosted: ensure environment variables were set correctly |
| 263 | + - For cloud: check your account credentials |
137 | 264 |
|
138 |
| -## Search for data |
| 265 | +??? "Data not appearing" |
139 | 266 |
|
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 |
141 | 270 |
|
142 |
| -1. Visit `logs` page |
143 |
| -1. Select the index `default` from drop down in the left |
144 |
| - |
145 |
| -1. Type `match_all('error')` in search bar and click the search button on right. |
| 271 | +??? "Performance issues" |
146 | 272 |
|
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 |
148 | 276 |
|
| 277 | +If you're still having issues, Join our [Slack Community](https://short.openobserve.ai/community) for help |
0 commit comments