Skip to content

Latest commit

 

History

History
396 lines (281 loc) · 19.2 KB

CONTRIBUTING.md

File metadata and controls

396 lines (281 loc) · 19.2 KB
Raw

Contributing Guidelines

Welcome to SigNoz Contributing section 🎉

Hi there! We're thrilled that you'd like to contribute to this project, thank you for your interest. Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community.

Please read through this document before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your bug report or contribution.

Finding contributions to work on 💬

Looking at the existing issues is a great way to find something to contribute on. Also, have a look at these good first issues label to start with.

Sections:

1. General Instructions 📝

1.1 For Creating Issue(s)

Before making any significant changes and before filing a new issue, please check existing open, or recently closed issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can.

Issue Types - Bug Report | Feature Request | Performance Issue Report | Request Dashboard | Report a Security Vulnerability

Details like these are incredibly useful:

  • Requirement - what kind of use case are you trying to solve?
  • Proposal - what do you suggest to solve the problem or improve the existing situation?
  • Any open questions to address❓

If you are reporting a bug, details like these are incredibly useful:

  • A reproducible test case or series of steps.
  • The version of our code being used.
  • Any modifications you've made relevant to the bug🐞.
  • Anything unusual about your environment or deployment.

Discussing your proposed changes ahead of time will make the contribution process smooth for everyone 🙌.

^top^

1.2 For Pull Request(s)

Contributions via pull requests are much appreciated. Once the approach is agreed upon ✅, make your changes and open a Pull Request(s). Before sending us a pull request, please ensure that,

  • Fork the SigNoz repo on GitHub, clone it on your machine.
  • Create a branch with your changes.
  • You are working against the latest source on the develop branch.
  • Modify the source; please focus only on the specific change you are contributing.
  • Ensure local tests pass.
  • Commit to your fork using clear commit messages.
  • Send us a pull request, answering any default questions in the pull request interface.
  • Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation
  • Once you've pushed your commits to GitHub, make sure that your branch can be auto-merged (there are no merge conflicts). If not, on your computer, merge main into your branch, resolve any merge conflicts, make sure everything still runs correctly and passes all the tests, and then push up those changes.
  • Once the change has been approved and merged, we will inform you in a comment.

GitHub provides additional document on forking a repository and creating a pull request.

Note: Unless your change is small, please consider submitting different Pull Request(s):

  • 1️⃣ First PR should include the overall structure of the new component:
    • Readme, configuration, interfaces or base classes, etc...
    • This PR is usually trivial to review, so the size limit does not apply to it.
  • 2️⃣ Second PR should include the concrete implementation of the component. If the size of this PR is larger than the recommended size, consider splitting ⚔️ it into multiple PRs.
  • If there are multiple sub-component then ideally each one should be implemented as a separate pull request.
  • Last PR should include changes to any user-facing documentation. And should include end-to-end tests if applicable. The component must be enabled only after sufficient testing, and there is enough confidence in the stability and quality of the component.

You can always reach out to [email protected] to understand more about the repo and product. We are very responsive over email and slack community.

Pointers:

  • If you find any bugs → please create an issue.
  • If you find anything missing in documentation → you can create an issue with the label documentation.
  • If you want to build any new feature → please create an issue with the label enhancement.
  • If you want to discuss something about the product, start a new discussion.
  • If you want to request a new dashboard template → please create an issue here.

Conventions to follow when submitting Commits and Pull Request(s).

We try to follow Conventional Commits, more specifically the commits and PRs should have type specifiers prefixed in the name. This should give you a better idea.

e.g. If you are submitting a fix for an issue in frontend, the PR name should be prefixed with fix(FE):

^top^

2. How to Contribute 🙋🏻‍♂️

There are primarily 2 areas in which you can contribute to SigNoz

Depending upon your area of expertise & interest, you can choose one or more to contribute. Below are detailed instructions to contribute in each area.

Please note: If you want to work on an issue, please add a brief description of your solution on the issue before starting work on it.

^top^

3. Develop Frontend 🌚

Need to Update: https://github.com/SigNoz/signoz/tree/develop/frontend

Also, have a look at 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

develop-frontend

query service

  • Next run,

    sudo docker-compose -f docker/clickhouse-setup/docker-compose.yaml up -d

  • cd ../frontend and change baseURL in file 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:

    FRONTEND_API_ENDPOINT=http://localhost:3301

    If not:

    FRONTEND_API_ENDPOINT=http://localhost:8080

  • Next,

    yarn install
yarn dev

Important Notes:

The Maintainers / Contributors who will change Line Numbers of Frontend & Query-Section, please update line numbers in /.scripts/commentLinesForSetup.sh

^top^

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.

  • Clone the SigNoz repository and cd into signoz/frontend directory, 
    git clone https://github.com/SigNoz/signoz.git && cd signoz/frontend
  • Create a file .env in the frontend directory with FRONTEND_API_ENDPOINT=<test environment URL>
  • Next, 
    yarn install
yarn dev

Please ping us in the #contributing channel or ask @Prashant Shahi in our Slack Community and we will DM you with <test environment URL>.

Frontend should now be accessible at http://localhost:3301/services

^top^

4. Contribute to Backend (Query-Service) 🌑

Need to Update: https://github.com/SigNoz/signoz/tree/develop/pkg/query-service

4.1 Prerequisites

4.1.1 Install SQLite3

  • Run sqlite3 command to check if you already have SQLite3 installed on your machine.

  • If not installed already, Install using below command

    • on Linux
      • on Debian / Ubuntu 
          sudo apt install sqlite3
      • on CentOS / Fedora / RedHat 
          sudo yum install sqlite3

4.2 To run ClickHouse setup (recommended for local development)

  • Clone the SigNoz repository and cd into signoz directory, 
    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

develop-frontend

Screenshot 2022-07-14 at 22 48 07

Screenshot 2022-07-14 at 22 50 37

  • 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"

to set your local environment with the right RELATIONAL_DATASOURCE_PATH as mentioned in ./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
    • If you are on arm64 processors (Apple M1 Macs) run sudo make run-arm

Run locally,

ClickHouseUrl=tcp://localhost:9001 STORAGE=clickhouse go run main.go

Build and Run locally

cd pkg/query-service
go build -o build/query-service main.go
ClickHouseUrl=tcp://localhost:9001 STORAGE=clickhouse build/query-service

Docker Images

The docker images of query-service is available at https://hub.docker.com/r/signoz/query-service

docker pull signoz/query-service

docker pull signoz/query-service:latest

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

Query Service should now be available at 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 as the query-service is now running at port 8080.

^top^

5. Contribute to SigNoz Helm Chart 📊

Need to Update: https://github.com/SigNoz/charts.

5.1 To run helm chart for local development

  • Clone the SigNoz repository and cd into charts directory, 
    git clone https://github.com/SigNoz/charts.git && cd charts
  • It is recommended to use lightweight kubernetes (k8s) cluster for local development:
  • create a k8s cluster and make sure kubectl points to the locally created k8s cluster,
  • run make dev-install to install SigNoz chart with my-release release name in platform namespace,
  • next run, 
    kubectl -n platform port-forward svc/my-release-signoz-frontend 3301:3301

to make SigNoz UI available at localhost:3301

5.1.1 To install the HotROD sample app:

curl -sL https://github.com/SigNoz/signoz/raw/develop/sample-apps/hotrod/hotrod-install.sh \
  | HELM_RELEASE=my-release SIGNOZ_NAMESPACE=platform bash

5.1.2 To load data with the HotROD sample app:

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

5.1.3 To stop the load generation:

kubectl -n sample-application run strzal --image=djbingham/curl \
  --restart='OnFailure' -i --tty --rm --command -- curl \
  http://locust-master:8089/stop

5.1.4 To delete the HotROD sample app:

curl -sL https://github.com/SigNoz/signoz/raw/develop/sample-apps/hotrod/hotrod-delete.sh \
  | HOTROD_NAMESPACE=sample-application bash

^top^

6. Contribute to Dashboards 📈

Need to Update: https://github.com/SigNoz/dashboards

To contribute a new dashboard template for any service, follow the contribution guidelines in the Dashboard Contributing Guide. In brief:

  1. Create a dashboard JSON file.
  2. Add a README file explaining the dashboard, the metrics ingested, and the configurations needed.
  3. Include screenshots of the dashboard in the assets/ directory.
  4. Submit a pull request for review.

Other Ways to Contribute

There are many other ways to get involved with the community and to participate in this project:

  • Use the product, submitting GitHub issues when a problem is found.
  • Help code review pull requests and participate in issue threads.
  • Submit a new feature request as an issue.
  • Help answer questions on forums such as Stack Overflow and SigNoz Community Slack Channel.
  • Tell others about the project on Twitter, your blog, etc.

Again, Feel free to ping us on #contributing or #contributing-frontend on our slack community if you need any help on this :)

Thank You!