feat: docker/swarm deployment restructuring and improvements

.dockerignore

@@ -3,4 +3,7 @@
 .vscode
 README.md
 deploy
-sample-apps
+sample-apps
+
+# frontend
+node_modules

.github/workflows/releaser.yaml

@@ -7,6 +7,7 @@ on:
 
 jobs:
   detect:
+    if: ${{ !startsWith(github.event.release.tag_name, 'histogram-quantile/') }}
     runs-on: ubuntu-latest
     outputs:
       release_type: ${{ steps.find.outputs.release_type }}
@@ -22,6 +23,7 @@ jobs:
           fi
           echo "release_type=${release_type}" >> "$GITHUB_OUTPUT"
   charts:
+    if: ${{ !startsWith(github.event.release.tag_name, 'histogram-quantile/') }}
     uses: signoz/primus.workflows/.github/workflows/github-trigger.yaml@main
     secrets: inherit
     needs: [detect]

.gitignore

@@ -52,7 +52,7 @@ ee/query-service/tests/test-deploy/data/
 /deploy/docker/clickhouse-setup/data/
 /deploy/docker-swarm/clickhouse-setup/data/
 bin/
-
+.local/
 */query-service/queries.active
 
 # e2e
@@ -70,5 +70,9 @@ vendor/
 
 # git-town
 .git-branches.toml
+
 # goreleaser
 dist/
+
+# ignore user_scripts that is fetched by init-clickhouse
+deploy/common/clickhouse/user_scripts/

.gitpod.yml

@@ -3,16 +3,10 @@
 
 
 tasks:
-  - name: Run Script to Comment ut required lines
-    init: |
-      cd ./.scripts
-      sh commentLinesForSetup.sh
-
   - name: Run Docker Images
     init: |
-      cd ./deploy
-      sudo docker-compose -f docker/clickhouse-setup/docker-compose.yaml up -d
-    # command:
+      cd ./deploy/docker
+      sudo docker compose up -d
 
   - name: Run Frontend
     init: |

CONTRIBUTING.md

@@ -141,24 +141,24 @@ Depending upon your area of expertise & interest, you can choose one or more to
 
 # 3. Develop Frontend 🌚
 
-**Need to Update: [https://github.com/SigNoz/signoz/tree/develop/frontend](https://github.com/SigNoz/signoz/tree/develop/frontend)**
+**Need to Update: [https://github.com/SigNoz/signoz/tree/main/frontend](https://github.com/SigNoz/signoz/tree/main/frontend)**
 
-Also, have a look at [Frontend README.md](https://github.com/SigNoz/signoz/blob/develop/frontend/README.md) sections for more info on how to setup SigNoz frontend locally (with and without Docker).
+Also, have a look at [Frontend README.md](https://github.com/SigNoz/signoz/blob/main/frontend/README.md) sections for more info on how to setup SigNoz frontend locally (with and without Docker).
 
 ## 3.1 Contribute to Frontend with Docker installation of SigNoz
 
 - Clone the SigNoz repository and cd into signoz directory,
   ```
   git clone https://github.com/SigNoz/signoz.git && cd signoz
   ```
-- Comment out `frontend` service section at [`deploy/docker/clickhouse-setup/docker-compose.yaml#L68`](https://github.com/SigNoz/signoz/blob/develop/deploy/docker/clickhouse-setup/docker-compose.yaml#L68)
+- Comment out `frontend` service section at [`deploy/docker/docker-compose.yaml#L68`](https://github.com/SigNoz/signoz/blob/main/deploy/docker/docker-compose.yaml#L68)
 
 ![develop-frontend](https://user-images.githubusercontent.com/52788043/179009217-6692616b-17dc-4d27-b587-9d007098d739.jpeg)
 
 
 - run `cd deploy` to move to deploy directory,
 - Install signoz locally **without** the frontend,
-    - Add / Uncomment the below configuration to query-service section at [`deploy/docker/clickhouse-setup/docker-compose.yaml#L47`](https://github.com/SigNoz/signoz/blob/develop/deploy/docker/clickhouse-setup/docker-compose.yaml#L47)
+    - Add / Uncomment the below configuration to query-service section at [`deploy/docker/docker-compose.yaml#L47`](https://github.com/SigNoz/signoz/blob/main/deploy/docker/docker-compose.yaml#L47)
     ```
     ports:
       - "8080:8080"
@@ -167,9 +167,10 @@ Also, have a look at [Frontend README.md](https://github.com/SigNoz/signoz/blob/
 
   - Next run,
     ```
-    sudo docker-compose -f docker/clickhouse-setup/docker-compose.yaml up -d
+    cd deploy/docker
+    sudo docker compose up -d
     ```
-- `cd ../frontend` and change baseURL in file [`frontend/src/constants/env.ts#L2`](https://github.com/SigNoz/signoz/blob/develop/frontend/src/constants/env.ts#L2) and for that, you need to create a `.env` file in the `frontend` directory with the following environment variable (`FRONTEND_API_ENDPOINT`) matching your configuration.
+- `cd ../frontend` and change baseURL in file [`frontend/src/constants/env.ts#L2`](https://github.com/SigNoz/signoz/blob/main/frontend/src/constants/env.ts#L2) and for that, you need to create a `.env` file in the `frontend` directory with the following environment variable (`FRONTEND_API_ENDPOINT`) matching your configuration.
 
     If you have backend api exposed via frontend nginx:
     ```
@@ -186,11 +187,6 @@ Also, have a look at [Frontend README.md](https://github.com/SigNoz/signoz/blob/
   yarn dev
   ```
 
-### Important Notes:
-The Maintainers / Contributors who will change Line Numbers of `Frontend` & `Query-Section`, please update line numbers in [`/.scripts/commentLinesForSetup.sh`](https://github.com/SigNoz/signoz/blob/develop/.scripts/commentLinesForSetup.sh)
-
- **[`^top^`](#contributing-guidelines)**
-
 ## 3.2 Contribute to Frontend without installing SigNoz backend
 
 If you don't want to install the SigNoz backend just for doing frontend development, we can provide you with test environments that you can use as the backend. 
@@ -216,7 +212,7 @@ Please ping us in the [`#contributing`](https://signoz-community.slack.com/archi
 
 # 4. Contribute to Backend (Query-Service) 🌑
 
-**Need to Update: [https://github.com/SigNoz/signoz/tree/develop/pkg/query-service](https://github.com/SigNoz/signoz/tree/develop/pkg/query-service)**
+**Need to Update: [https://github.com/SigNoz/signoz/tree/main/pkg/query-service](https://github.com/SigNoz/signoz/tree/main/pkg/query-service)**
 
 ## 4.1 Prerequisites
 
@@ -242,13 +238,13 @@ Please ping us in the [`#contributing`](https://signoz-community.slack.com/archi
     git clone https://github.com/SigNoz/signoz.git && cd signoz
     ```
 - run `sudo make dev-setup` to configure local setup to run query-service,
-- Comment out `frontend` service section at [`deploy/docker/clickhouse-setup/docker-compose.yaml#L68`](https://github.com/SigNoz/signoz/blob/develop/deploy/docker/clickhouse-setup/docker-compose.yaml#L68)
+- Comment out `frontend` service section at [`deploy/docker/docker-compose.yaml#L68`](https://github.com/SigNoz/signoz/blob/main/deploy/docker/docker-compose.yaml#L68)
 <img width="982" alt="develop-frontend" src="https://user-images.githubusercontent.com/52788043/179043977-012be8b0-a2ed-40d1-b2e6-2ab72d7989c0.png">
 
-- Comment out `query-service` section at [`deploy/docker/clickhouse-setup/docker-compose.yaml#L41`,](https://github.com/SigNoz/signoz/blob/develop/deploy/docker/clickhouse-setup/docker-compose.yaml#L41)
+- Comment out `query-service` section at [`deploy/docker/docker-compose.yaml#L41`,](https://github.com/SigNoz/signoz/blob/main/deploy/docker/docker-compose.yaml#L41)
 <img width="1068" alt="Screenshot 2022-07-14 at 22 48 07" src="https://user-images.githubusercontent.com/52788043/179044151-a65ba571-db0b-4a16-b64b-ca3fadcf3af0.png">
 
-- add below configuration to `clickhouse` section at [`deploy/docker/clickhouse-setup/docker-compose.yaml`,](https://github.com/SigNoz/signoz/blob/develop/deploy/docker/clickhouse-setup/docker-compose.yaml)
+- add below configuration to `clickhouse` section at [`deploy/docker/docker-compose.yaml`,](https://github.com/SigNoz/signoz/blob/main/deploy/docker/docker-compose.yaml)
   ```
   ports:
     - 9001:9000
@@ -258,9 +254,9 @@ Please ping us in the [`#contributing`](https://signoz-community.slack.com/archi
 - run `cd pkg/query-service/` to move to `query-service` directory,
 - Then, you need to create a `.env` file with the following environment variable 
     ```
-    SIGNOZ_LOCAL_DB_PATH="./signoz.db"
+    SIGNOZ_SQLSTORE_SQLITE_PATH="./signoz.db"
     ```
-to set your local environment with the right `RELATIONAL_DATASOURCE_PATH` as mentioned in [`./constants/constants.go#L38`,](https://github.com/SigNoz/signoz/blob/develop/pkg/query-service/constants/constants.go#L38)
+to set your local environment with the right `RELATIONAL_DATASOURCE_PATH` as mentioned in [`./constants/constants.go#L38`,](https://github.com/SigNoz/signoz/blob/main/pkg/query-service/constants/constants.go#L38)
 
 - Now, 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`
@@ -294,13 +290,10 @@ docker pull signoz/query-service:develop
 ```
 
 ### Important Note:
-The Maintainers / Contributors who will change Line Numbers of `Frontend` & `Query-Section`, please update line numbers in [`/.scripts/commentLinesForSetup.sh`](https://github.com/SigNoz/signoz/blob/develop/.scripts/commentLinesForSetup.sh)
-
-
 
 **Query Service should now be available at** [`http://localhost:8080`](http://localhost:8080)
 
-If you want to see how the frontend plays with query service, you can run the frontend also in your local env with the baseURL changed to `http://localhost:8080` in file [`frontend/src/constants/env.ts`](https://github.com/SigNoz/signoz/blob/develop/frontend/src/constants/env.ts) as the `query-service` is now running at port `8080`.
+If you want to see how the frontend plays with query service, you can run the frontend also in your local env with the baseURL changed to `http://localhost:8080` in file [`frontend/src/constants/env.ts`](https://github.com/SigNoz/signoz/blob/main/frontend/src/constants/env.ts) as the `query-service` is now running at port `8080`.
 
 <!-- Instead of configuring a local setup, you can also use [Gitpod](https://www.gitpod.io/), a VSCode-based Web IDE.
 

Makefile

@@ -15,8 +15,8 @@ DEV_BUILD ?= "" # set to any non-empty value to enable dev build
 FRONTEND_DIRECTORY ?= frontend
 QUERY_SERVICE_DIRECTORY ?= pkg/query-service
 EE_QUERY_SERVICE_DIRECTORY ?= ee/query-service
-STANDALONE_DIRECTORY ?= deploy/docker/clickhouse-setup
-SWARM_DIRECTORY ?= deploy/docker-swarm/clickhouse-setup
+STANDALONE_DIRECTORY ?= deploy/docker
+SWARM_DIRECTORY ?= deploy/docker-swarm
 CH_HISTOGRAM_QUANTILE_DIRECTORY ?= scripts/clickhouse/histogramquantile
 
 GOOS ?= $(shell go env GOOS)
@@ -143,16 +143,6 @@ dev-setup:
 	@echo "--> Local Setup completed"
 	@echo "------------------"
 
-run-local:
-	@docker-compose -f \
-	$(STANDALONE_DIRECTORY)/docker-compose-core.yaml -f $(STANDALONE_DIRECTORY)/docker-compose-local.yaml \
-	up --build -d
-
-down-local:
-	@docker-compose -f \
-	$(STANDALONE_DIRECTORY)/docker-compose-core.yaml -f $(STANDALONE_DIRECTORY)/docker-compose-local.yaml \
-	down -v
-
 pull-signoz:
 	@docker-compose -f $(STANDALONE_DIRECTORY)/docker-compose.yaml pull
 

README.de-de.md

@@ -13,9 +13,9 @@
 
 <h3 align="center">
   <a href="https://signoz.io/docs"><b>Dokumentation</b></a> &bull;
-  <a href="https://github.com/SigNoz/signoz/blob/develop/README.md"><b>Readme auf Englisch </b></a> &bull;
-  <a href="https://github.com/SigNoz/signoz/blob/develop/README.zh-cn.md"><b>ReadMe auf Chinesisch</b></a> &bull;
-  <a href="https://github.com/SigNoz/signoz/blob/develop/README.pt-br.md"><b>ReadMe auf Portugiesisch</b></a> &bull;
+  <a href="https://github.com/SigNoz/signoz/blob/main/README.md"><b>Readme auf Englisch </b></a> &bull;
+  <a href="https://github.com/SigNoz/signoz/blob/main/README.zh-cn.md"><b>ReadMe auf Chinesisch</b></a> &bull;
+  <a href="https://github.com/SigNoz/signoz/blob/main/README.pt-br.md"><b>ReadMe auf Portugiesisch</b></a> &bull;
   <a href="https://signoz.io/slack"><b>Slack Community</b></a> &bull;
   <a href="https://twitter.com/SigNozHq"><b>Twitter</b></a>
 </h3>

README.md

@@ -17,9 +17,9 @@
 
 <h3 align="center">
   <a href="https://signoz.io/docs"><b>Documentation</b></a> &bull;
-  <a href="https://github.com/SigNoz/signoz/blob/develop/README.zh-cn.md"><b>ReadMe in Chinese</b></a> &bull;
-  <a href="https://github.com/SigNoz/signoz/blob/develop/README.de-de.md"><b>ReadMe in German</b></a> &bull;
-  <a href="https://github.com/SigNoz/signoz/blob/develop/README.pt-br.md"><b>ReadMe in Portuguese</b></a> &bull;
+  <a href="https://github.com/SigNoz/signoz/blob/main/README.zh-cn.md"><b>ReadMe in Chinese</b></a> &bull;
+  <a href="https://github.com/SigNoz/signoz/blob/main/README.de-de.md"><b>ReadMe in German</b></a> &bull;
+  <a href="https://github.com/SigNoz/signoz/blob/main/README.pt-br.md"><b>ReadMe in Portuguese</b></a> &bull;
   <a href="https://signoz.io/slack"><b>Slack Community</b></a> &bull;
   <a href="https://twitter.com/SigNozHq"><b>Twitter</b></a>
 </h3>

README.zh-cn.md

@@ -12,9 +12,9 @@
 
 <h3 align="center">
   <a href="https://signoz.io/docs"><b>文档</b></a> •
-  <a href="https://github.com/SigNoz/signoz/blob/develop/README.zh-cn.md"><b>中文ReadMe</b></a> •
-  <a href="https://github.com/SigNoz/signoz/blob/develop/README.de-de.md"><b>德文ReadMe</b></a> •
-  <a href="https://github.com/SigNoz/signoz/blob/develop/README.pt-br.md"><b>葡萄牙语ReadMe</b></a> •
+  <a href="https://github.com/SigNoz/signoz/blob/main/README.zh-cn.md"><b>中文ReadMe</b></a> •
+  <a href="https://github.com/SigNoz/signoz/blob/main/README.de-de.md"><b>德文ReadMe</b></a> •
+  <a href="https://github.com/SigNoz/signoz/blob/main/README.pt-br.md"><b>葡萄牙语ReadMe</b></a> •
   <a href="https://signoz.io/slack"><b>Slack 社区</b></a> •
   <a href="https://twitter.com/SigNozHq"><b>Twitter</b></a>
 </h3>

deploy/README.md

@@ -18,65 +18,64 @@ Now run the following command to install:
 
 ### Using Docker Compose
 
-If you don't have docker-compose set up, please follow [this guide](https://docs.docker.com/compose/install/)
+If you don't have docker compose set up, please follow [this guide](https://docs.docker.com/compose/install/)
 to set up docker compose before proceeding with the next steps.
 
-For x86 chip (amd):
-
 ```sh
-docker-compose -f docker/clickhouse-setup/docker-compose.yaml up -d
+cd deploy/docker
+docker compose up -d
 ```
 
-Open http://localhost:3301 in your favourite browser. In couple of minutes, you should see
-the data generated from hotrod in SigNoz UI.
+Open http://localhost:3301 in your favourite browser.
 
-## Kubernetes
+To start collecting logs and metrics from your infrastructure, run the following command:
 
-### Using Helm
+```sh
+cd generator/infra
+docker compose up -d
+```
 
-#### Bring up SigNoz cluster
+To start generating sample traces, run the following command:
 
 ```sh
-helm repo add signoz https://charts.signoz.io
+cd generator/hotrod
+docker compose up -d
+```
 
-kubectl create ns platform
+In a couple of minutes, you should see the data generated from hotrod in SigNoz UI.
 
-helm -n platform install my-release signoz/signoz
-```
+For more details, please refer to the [SigNoz documentation](https://signoz.io/docs/install/docker/).
 
-To access the UI, you can `port-forward` the frontend service:
+## Docker Swarm
+
+To install SigNoz using Docker Swarm, run the following command:
 
 ```sh
-kubectl -n platform port-forward svc/my-release-frontend 3301:3301
+cd deploy/docker-swarm
+docker stack deploy -c docker-compose.yaml signoz
 ```
 
-Open http://localhost:3301 in your favourite browser. Few minutes after you generate load
-from the HotROD application, you should see the data generated from hotrod in SigNoz UI.
+Open http://localhost:3301 in your favourite browser.
 
-#### Test HotROD application with SigNoz
+To start collecting logs and metrics from your infrastructure, run the following command:
 
 ```sh
-kubectl create ns sample-application
-
-kubectl -n sample-application apply -f https://raw.githubusercontent.com/SigNoz/signoz/main/sample-apps/hotrod/hotrod.yaml
+cd generator/infra
+docker stack deploy -c docker-compose.yaml infra
 ```
 
-To generate load:
+To start generating sample traces, run the following command:
 
 ```sh
-kubectl -n sample-application run strzal --image=djbingham/curl \
---restart='OnFailure' -i --tty --rm --command -- curl -X POST -F \
-'user_count=6' -F 'spawn_rate=2' http://locust-master:8089/swarm
+cd generator/hotrod
+docker stack deploy -c docker-compose.yaml hotrod
 ```
 
-To stop load:
+In a couple of minutes, you should see the data generated from hotrod in SigNoz UI.
 
-```sh
-kubectl -n sample-application run strzal --image=djbingham/curl \
- --restart='OnFailure' -i --tty --rm --command -- curl \
- http://locust-master:8089/stop
-```
+For more details, please refer to the [SigNoz documentation](https://signoz.io/docs/install/docker-swarm/).
 
 ## Uninstall/Troubleshoot?
 
 Go to our official documentation site [signoz.io/docs](https://signoz.io/docs) for more.
+

deploy/docker-swarm/clickhouse-setup/clickhouse-cluster.xml → deploy/common/clickhouse/cluster.ha.xml

@@ -10,14 +10,14 @@
             <host>zookeeper-1</host>
             <port>2181</port>
         </node>
-        <!-- <node index="2">
+        <node index="2">
             <host>zookeeper-2</host>
             <port>2181</port>
         </node>
         <node index="3">
             <host>zookeeper-3</host>
             <port>2181</port>
-        </node> -->
+        </node>
     </zookeeper>
 
     <!-- Configuration of clusters that could be used in Distributed tables.
@@ -58,7 +58,7 @@
                     <!-- <priority>1</priority> -->
                 </replica>
             </shard>
-            <!-- <shard>
+            <shard>
                 <replica>
                     <host>clickhouse-2</host>
                     <port>9000</port>
@@ -69,7 +69,7 @@
                     <host>clickhouse-3</host>
                     <port>9000</port>
                 </replica>
-            </shard> -->
+            </shard>
         </cluster>
     </remote_servers>
-</clickhouse>
+</clickhouse>

deploy/docker/clickhouse-setup/clickhouse-cluster.xml → deploy/common/clickhouse/cluster.xml

@@ -72,4 +72,4 @@
             </shard> -->
         </cluster>
     </remote_servers>
-</clickhouse>
+</clickhouse>