Skip to content

Latest commit

 

History

History
76 lines (53 loc) · 3.02 KB

CONTRIBUTING.md

File metadata and controls

76 lines (53 loc) · 3.02 KB
Raw

How to Contribute

There are primarily 3 charts in the SigNoz Helm Charts repository:

  • SigNoz (frontend, query service, otel collector, and otel collector metrics)
  • ClickHouse
  • Alertmanager

SigNoz chart is where most of the developments are done. ClickHouse chart is seldom updated to to sync major enhancements. Alertmanager chart is rarely updated.

To run helm chart for local development

  • run git clone https://github.com/SigNoz/charts.git followed by 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.
  • run kubectl -n platform port-forward svc/my-release-signoz-frontend 3301:3301 to make SigNoz UI available at localhost:3301

To install HotROD sample app:

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

To load data with 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

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

To delete HotROD sample app:

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

General Instructions

You can always reach out to [email protected] to understand more about the SigNoz helm chart. We are very responsive over slack.

Please use the label helm-chart for your issues and pull requests.

  • If you find any bugs, please create an issue
  • If you find anything missing in documentation, you can create an issue with label documentation
  • If you want to build any new feature, please create an issue with label enhancement
  • If you want to discuss something about the helm chart, please use the Helm chart discussion

Conventions to follow when submitting commits, PRs

  1. We try to follow https://www.conventionalcommits.org/en/v1.0.0/

More specifically the commits and PRs should have type specifiers prefixed in the name. This should give you a better idea.

  1. Follow GitHub Flow guidelines for your contribution flows

  2. Feel free to ping us on #contributing on our slack community if you need any help on this :)