mirror of
https://github.com/SigNoz/signoz.git
synced 2025-12-17 15:36:48 +00:00
updates to readme
This commit is contained in:
parent
3c90d3c742
commit
b43b25dab0
3
.gitignore
vendored
3
.gitignore
vendored
@ -21,4 +21,5 @@ frontend/yarn-debug.log*
|
||||
frontend/yarn-error.log*
|
||||
|
||||
**/.vscode
|
||||
*.tgz
|
||||
*.tgz
|
||||
**/build
|
||||
@ -1,3 +1,23 @@
|
||||
docker build -t signoz/flattener-processor:v0.1.0 .
|
||||
docker push signoz/flattener-processor:v0.1.0
|
||||
# Flattener Processor
|
||||
|
||||
Flattener Processor is a spream processing application that reads spans from topic `otlp_spans` and writes to topic `flattened_spans`. It is written in **Golang**. Flattener Processor is responsible to convert the incoming spans into a flat model that can be ingested to Apache Druid.
|
||||
|
||||
|
||||
#### Configuration
|
||||
Flattener Processor needs below `env` variables to run:
|
||||
```
|
||||
KAFKA_BROKER: signoz-kafka:9092
|
||||
KAFKA_INPUT_TOPIC: otlp_spans
|
||||
KAFKA_OUTPUT_TOPIC: flattened_spans
|
||||
```
|
||||
The above values are the default ones used by SigNoz and are kept at `deploy/kubernetes/platform/signoz-charts/flattener-processor/values.yaml`
|
||||
|
||||
#### Build and Run locally
|
||||
```console
|
||||
cd pkg/processors/flattener
|
||||
go build -o build/flattener-processor main.go
|
||||
KAFKA_BROKER=xxxx KAFKA_INPUT_TOPIC=otlp_spans KAFKA_OUTPUT_TOPIC=flattened_spans build/flattener-processor
|
||||
```
|
||||
|
||||
#### Docker Images
|
||||
The docker images of flattener-processor is available at https://hub.docker.com/r/signoz/flattener-processor
|
||||
@ -1,2 +1,29 @@
|
||||
docker build -t signoz/query-service:v0.1.0 .
|
||||
docker push signoz/query-service:v0.1.0
|
||||
# Query Service
|
||||
|
||||
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
|
||||
- create relevant Druid queries (and all other supported database queries)
|
||||
- parse response from databases and handle error if any
|
||||
- build response in the format accepted by Frontend
|
||||
|
||||
|
||||
#### Druid Queries
|
||||
Internally we use both native and sql queries to Druid.
|
||||
|
||||
#### Configuration
|
||||
Query Service needs below `env` variables to run:
|
||||
```
|
||||
DruidClientUrl: http://signoz-druid-router:8888
|
||||
DruidDatasource: flattened_spans
|
||||
```
|
||||
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
|
||||
```console
|
||||
cd pkg/query-service
|
||||
go build -o build/query-service main.go
|
||||
DruidClientUrl=xxxx DruidDatasource=flattened_spans build/query-service
|
||||
```
|
||||
|
||||
#### Docker Images
|
||||
The docker images of query-service is available at https://hub.docker.com/r/signoz/query-service
|
||||
Loading…
x
Reference in New Issue
Block a user