mirror of
https://github.com/openobserve/openobserve.git
synced 2026-11-04 00:08:55 +00:00
Prabhat Sharma
ed4b26586f
* add logo, replace zinc-observe with zincobserve * refactor: add logo, replace zinc_observe * renamed missing ones
129 lines
3.9 KiB
Markdown
129 lines
3.9 KiB
Markdown
# Contributing to Zinc Observe
|
|
|
|
## Setting up development environment
|
|
|
|
### Prerequisite
|
|
|
|
Zinc Observe uses Rust & embded sled db (For server) & VueJS (For Web UI)
|
|
|
|
You must have follwing installed:
|
|
|
|
1. Git
|
|
2. Rust & Cargo 1.61.0 + (We recommend 1.66+),
|
|
3. nodejs v14+ and npm v6+
|
|
|
|
## Building from source code
|
|
|
|
### Lets clone the repo and get started
|
|
|
|
```shell
|
|
git clone https://github.com/zinclabs/zincobserve
|
|
cd zincobserve
|
|
```
|
|
|
|
### Now let's build the UI
|
|
|
|
```shell
|
|
cd web
|
|
npm install
|
|
npm run build
|
|
cd ..
|
|
```
|
|
|
|
Output will be stored in web/dist folder. web/dist will be embedded in zincobserve binary when zincobserve application is built.
|
|
|
|
It is important that you build the web app every time you make any changes to javascript code as the built code is then embedded in zincobserve application.
|
|
|
|
### Time to build the rust application now
|
|
|
|
Make sure you are in zincobserve directory & not in zincobserve/web
|
|
|
|
Simple:
|
|
|
|
```shell
|
|
cargo build --release # will build the zincobserve binary
|
|
```
|
|
|
|
## Developing
|
|
|
|
Once you have the source code cloned you can start development.
|
|
|
|
There are 2 areas of development.
|
|
|
|
1. UI
|
|
1. Server
|
|
|
|
### Server
|
|
|
|
```shell
|
|
cargo run
|
|
```
|
|
|
|
Please note by default user 'admin' with password 'Complexpass#123' is created
|
|
|
|
This will start the zincobserve API server on port 5080
|
|
|
|
environment variables ZO_USER_NAME and ZO_USER_PASSWORD can be used first time to configure default admin user when zincobserve is started.
|
|
|
|
### UI
|
|
|
|
If not alredy present create .env file in web directory & set VITE_ZINC_ENL_ENDPOINT=http://localhost:5080
|
|
|
|
```shell
|
|
cd web
|
|
npm install
|
|
npm run dev
|
|
```
|
|
|
|
This will start UI server on port 8080 , to change port specify it in vite.config.ts
|
|
|
|
In order for you to effectively use the UI you would want to have the zincobserve API server running in a seperate window that will accept requests from the UI.
|
|
|
|
## Swagger
|
|
|
|
The server also exposes a Swagger API endpoint which you can see by visiting the `/swagger/index.html` path. It uses [utoipa](https://github.com/juhaku/utoipa) to mark API endpoints with comment annotations & to generate the API spec from the annotations to Swagger Documentation 2.0.
|
|
|
|
## Build docker image
|
|
|
|
Make sure that you have [docker](https://docs.docker.com/get-docker/).
|
|
|
|
Simple build:
|
|
|
|
```shell
|
|
docker build -t zincobserve:latest-amd64 -f deploy/build/Dockerfile .
|
|
```
|
|
|
|
Multi-arch build
|
|
|
|
In order to build multi-arch builds you will need [buildx](https://docs.docker.com/buildx/working-with-buildx/) installed. You will need to pass the platform flag for the platform that you want to build.
|
|
|
|
```shell
|
|
docker build -t zincobserve:latest-amd64 -f deploy/build/Dockerfile.tag.amd64 .
|
|
```
|
|
|
|
Please check folder deploy/build for docker files.
|
|
|
|
# Checks in CI pipeline
|
|
|
|
We check for following in CI pipeline for any pull requests.
|
|
|
|
1. Unit test code coverage for rust code.
|
|
- If code coverage is less than 81% the CI tests will fail.
|
|
- You can test coverage yourself by running `./coverage.sh`
|
|
- We use [cargo-llvm-cov](https://github.com/taiki-e/cargo-llvm-cov)for code generating coverage to generate report in .json format.
|
|
- Run 'cargo llvm-cov --lcov --output-path lcov.info' to genrate report & use [Coverage Gutters](https://marketplace.visualstudio.com/items?itemName=ryanluker.vscode-coverage-gutters) with VS code for visualizing code coverage.
|
|
- You can also generate html report by using 'cargo llvm-cov --html' to generate html report in target/debug/llvm-cov/html/index.html
|
|
1. Linting in Javascript for GUI
|
|
- We run eslint for javacript anf any linting failures will result in build failures.
|
|
- You can test for linting failures by running `./eslint.sh` in web folder.
|
|
|
|
## How to contribute code
|
|
|
|
1. Fork the repository on github (e.g. awesomedev/zincobserve)
|
|
1. Clone the repo from the forked repository ( e.g. awesomedev/zincobserve) to your machine.
|
|
1. create a new branch locally.
|
|
1. Make the changes to code.
|
|
1. Push the code to your repo.
|
|
1. Create a PR
|
|
1. Make sure that the automatic CI checks pass for your PR.
|