GitHub-Proxy/signoz
1
0
Fork 0
mirror of https://git.mirrors.martin98.com/https://github.com/SigNoz/signoz synced 2025-08-04 18:40:37 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #762 from axaysagathiya/issue-740

Browse Source 
Fix: update documentation for query-service.
This commit is contained in:
Ankit Nayan 2022-02-25 17:05:45 +05:30 committed by GitHub
commit 79fa4e7b74
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 22 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
CONTRIBUTING.md
View File

@ -48,8 +48,15 @@ Need to update [https://github.com/SigNoz/signoz/tree/main/pkg/query-service](ht
- git clone https://github.com/SigNoz/signoz.git - git clone https://github.com/SigNoz/signoz.git
- run `sudo make dev-setup` to configure local setup to run query-service - run `sudo make dev-setup` to configure local setup to run query-service
- comment out frontend service section at `docker/clickhouse-setup/docker-compose.yaml#L59` - comment out frontend service section at `docker/clickhouse-setup/docker-compose.yaml#L45`
- comment out query-service section at `docker/clickhouse-setup/docker-compose.yaml#L38` - comment out query-service section at `docker/clickhouse-setup/docker-compose.yaml#L28`
- add below configuration to clickhouse section at `docker/clickhouse-setup/docker-compose.yaml`
```
expose:
- 9000
ports:
- 9001:9000
```
- Install signoz locally without the frontend and query-service - Install signoz locally without the frontend and query-service
- If you are using x86_64 processors (All Intel/AMD processors) run `sudo make run-x86` - If you are using x86_64 processors (All Intel/AMD processors) run `sudo make run-x86`
- If you are on arm64 processors (Apple M1 Macbooks) run `sudo make run-arm` - If you are on arm64 processors (Apple M1 Macbooks) run `sudo make run-arm`

23
pkg/query-service/README.md
View File

@ -2,27 +2,30 @@
Query service is the interface between forntend and databases. It is written in **Golang**. It will have modules for all supported databases. Query service is responsible to: Query service is the interface between forntend and databases. It is written in **Golang**. It will have modules for all supported databases. Query service is responsible to:
- parse the request from Frontend - parse the request from Frontend
- create relevant Druid queries (and all other supported database queries) - create relevant Clickhouse queries (and all other supported database queries)
- parse response from databases and handle error if any - parse response from databases and handle error if any
- build response in the format accepted by Frontend - clickhouse response in the format accepted by Frontend
#### Druid Queries
Internally we use both native and sql queries to Druid.
#### Configuration #### Configuration
Query Service needs below `env` variables to run: - Open ./constants/constants.go
- Replace ```const RELATIONAL_DATASOURCE_PATH = "/var/lib/signoz/signoz.db"``` \
with ```const RELATIONAL_DATASOURCE_PATH = "./signoz.db".```
- Query Service needs below `env` variables to run:
``` ```
DruidClientUrl: http://signoz-druid-router:8888 ClickHouseUrl=tcp://localhost:9001
DruidDatasource: flattened_spans STORAGE=clickhouse
``` ```
The above values are the default ones used by SigNoz and are kept at `deploy/kubernetes/platform/signoz-charts/query-service/values.yaml`
<!-- The above values are the default ones used by SigNoz and are kept at `deploy/kubernetes/platform/signoz-charts/query-service/values.yaml` -->
#### Build and Run locally #### Build and Run locally
```console ```console
cd pkg/query-service cd pkg/query-service
go build -o build/query-service main.go go build -o build/query-service main.go
DruidClientUrl=xxxx DruidDatasource=flattened_spans build/query-service ClickHouseUrl=tcp://localhost:9001 STORAGE=clickhouse build/query-service
``` ```
#### Docker Images #### Docker Images