starred/openobserve
1
0
Fork 0
mirror of https://github.com/openobserve/openobserve.git synced 2026-11-04 08:09:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor: add logo, replace zinc-observe with zincobserve (#78)

Browse Source 
* add logo, replace zinc-observe with zincobserve

* refactor: add logo, replace zinc_observe

* renamed missing ones
This commit is contained in:
Prabhat Sharma
2023-02-15 07:51:37 +05:30
committed by GitHub
parent 66d8c1d13b
commit ed4b26586f
25 changed files with 219 additions and 221 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+27 -28
View File
@@ -9,7 +9,7 @@ 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+),
2. Rust & Cargo 1.61.0 + (We recommend 1.66+),
3. nodejs v14+ and npm v6+
## Building from source code
@@ -17,8 +17,8 @@ You must have follwing installed:
### Lets clone the repo and get started
```shell
git clone https://github.com/zinclabs/zinc-observe
cd zinc-observe
git clone https://github.com/zinclabs/zincobserve
cd zincobserve
```
### Now let's build the UI
@@ -30,20 +30,20 @@ npm run build
cd ..
```
Output will be stored in web/dist folder. web/dist will be embedded in zinc-observe binary when zinc-observe application is built.
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 zinc-observe application.
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 zinc-observe directory & not in zinc-observe/web
Make sure you are in zincobserve directory & not in zincobserve/web
Simple:
```shell
cargo build --release # will build the zinc-observe binary
cargo build --release # will build the zincobserve binary
```
## Developing
Once you have the source code cloned you can start development.
@@ -56,14 +56,14 @@ There are 2 areas of development.
### Server
```shell
cargo run
cargo run
```
Please note by default user 'admin' with password 'Complexpass#123' is created
This will start the zinc-observe API server on port 5080
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 zinc-observe is started.
environment variables ZO_USER_NAME and ZO_USER_PASSWORD can be used first time to configure default admin user when zincobserve is started.
### UI
@@ -77,13 +77,12 @@ 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 Zinc-Observe API server running in a seperate window that will accept requests from the UI.
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/).
@@ -91,15 +90,15 @@ Make sure that you have [docker](https://docs.docker.com/get-docker/).
Simple build:
```shell
docker build -t zinc-observe:latest-amd64 -f deploy/build/Dockerfile .
````
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 zinc-observe:latest-amd64 -f deploy/build/Dockerfile.tag.amd64 .
docker build -t zincobserve:latest-amd64 -f deploy/build/Dockerfile.tag.amd64 .
```
Please check folder deploy/build for docker files.
@@ -109,21 +108,21 @@ Please check folder deploy/build for docker files.
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
- 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.
- 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/zinc-observe)
1. Clone the repo from the forked repository ( e.g. awesomedev/zinc-observe) to your machine.
1. create a new branch locally.
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.
1. Make sure that the automatic CI checks pass for your PR.