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

Updated ReadMe (#229)

Browse Source 
* updated readme - docs link
This commit is contained in:
Pranay Prateek 2021-07-17 14:57:43 +05:30 committed by GitHub
parent 76e7bd5292
commit 1d479ca158
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
README.md
View File

@ -66,45 +66,20 @@ You can find the complete list of languages here - https://opentelemetry.io/docs
## Getting Started ## Getting Started
### Deploy using docker-compose ### Deploy using docker-compose
We have a tiny-cluster setup and a standard setup to deploy using docker-compose. Please follow the steps listed [here](https://signoz.io/docs/deployment/docker/) to install using docker-compose
Follow the steps listed at https://signoz.io/docs/deployment/docker/.
The troubleshooting instructions at https://signoz.io/docs/deployment/docker/#troubleshooting may be helpful The [troubleshooting instructions](https://signoz.io/docs/deployment/docker/#troubleshooting) may be helpful if you face any issues.
<p>&nbsp </p>
### Deploy in Kubernetes using Helm ### Deploy in Kubernetes using Helm
Below steps will install the SigNoz in `platform` namespace inside your k8s cluster. Please follow the steps listed [here](https://signoz.io/docs/deployment/helm_chart) to install using helm charts
```console
git clone https://github.com/SigNoz/signoz.git && cd signoz
helm dependency update deploy/kubernetes/platform
kubectl create ns platform
helm -n platform install signoz deploy/kubernetes/platform
kubectl -n platform apply -Rf deploy/kubernetes/jobs
kubectl -n platform apply -f deploy/kubernetes/otel-collector
```
\*_You can choose a different namespace too. In that case, you need to point your applications to correct address to send traces. In our sample application just change the `JAEGER_ENDPOINT` environment variable in `sample-apps/hotrod/deployment.yaml`_
### Test HotROD application with SigNoz
```console
kubectl create ns sample-application
kubectl -n sample-application apply -Rf sample-apps/hotrod/
```
### How to generate load
`kubectl -n sample-application run strzal --image=djbingham/curl --restart='OnFailure' -i --tty --rm --command -- curl -X POST -F 'locust_count=6' -F 'hatch_rate=2' http://locust-master:8089/swarm`
### See UI
`kubectl -n platform port-forward svc/signoz-frontend 3000:3000`
### How to stop load
`kubectl -n sample-application run strzal --image=djbingham/curl --restart='OnFailure' -i --tty --rm --command -- curl http://locust-master:8089/stop`
<br /><br /> <br /><br />
@ -118,6 +93,8 @@ Prometheus is good if you want to do just metrics. But if you want to have a sea
Our goal is to provide an integrated UI between metrics & traces - similar to what SaaS vendors like Datadog provides - and give advanced filtering and aggregation over traces, something which Jaeger currently lack. Our goal is to provide an integrated UI between metrics & traces - similar to what SaaS vendors like Datadog provides - and give advanced filtering and aggregation over traces, something which Jaeger currently lack.
<p>&nbsp </p>
### SigNoz and Jaeger ### SigNoz and Jaeger
Jaeger only does distributed tracing. SigNoz does both metrics and traces, and we also have log management in our roadmap. Jaeger only does distributed tracing. SigNoz does both metrics and traces, and we also have log management in our roadmap.
@ -133,7 +110,7 @@ Moreover, SigNoz has few more advanced features wrt Jaeger:
## Documentation ## Documentation
You can find docs at https://signoz.io/docs/deployment/docker. If you need any clarification or find something missing, feel free to raise a GitHub issue with the label `documentation` or reach out to us at the community slack channel. You can find docs at https://signoz.io/docs/. If you need any clarification or find something missing, feel free to raise a GitHub issue with the label `documentation` or reach out to us at the community slack channel.
<br /><br /> <br /><br />