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

Merge pull request #46 from pranay01/main

Browse Source 
Updated ReadMe image & title
This commit is contained in:
Pranay Prateek 2021-04-20 13:25:00 +05:30 committed by GitHub
commit 840246bd77
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -1,16 +1,21 @@
<p align="center"><img src="https://signoz.io/img/SigNozLogo-orange.svg" alt="SigNoz Logo" width="100"></p> <p align="center">
<img src="https://res.cloudinary.com/dcv3epinx/image/upload/v1618904450/signoz-images/LogoGithub_sigfbu.svg" alt="SigNoz-logo" width="240" />
<p align="center">Monitor your applications and troubleshoot problems in your deployed applications, an open-source alternative to DataDog, New Relic, etc.</p>
</p>
[![MIT](https://img.shields.io/badge/license-MIT-brightgreen)](LICENSE) [![MIT](https://img.shields.io/badge/license-MIT-brightgreen)](LICENSE)
# SigNoz ##
SigNoz is an opensource observability platform. SigNoz uses distributed tracing to gain visibility into your systems and powers data using [Kafka](https://kafka.apache.org/) (to handle high ingestion rate and backpressure) and [Apache Druid](https://druid.apache.org/) (Apache Druid is a high performance real-time analytics database), both proven in the industry to handle scale. SigNoz is an opensource observability platform. SigNoz uses distributed tracing to gain visibility into your systems and powers data using [Kafka](https://kafka.apache.org/) (to handle high ingestion rate and backpressure) and [Apache Druid](https://druid.apache.org/) (Apache Druid is a high performance real-time analytics database), both proven in the industry to handle scale.
<!-- ![SigNoz Feature](https://signoz.io/img/readme_feature1.jpg) -->
![SigNoz Feature](https://signoz.io/img/readme_feature1.jpg) ![SigNoz Feature](https://res.cloudinary.com/dcv3epinx/image/upload/v1618904032/signoz-images/screenzy-1618904013729_clssvy.png)
### Features: ### Features:
- Application overview metrics like RPS, 50th/90th/99th Percentile latencies, and Error Rate - Application overview metrics like RPS, 50th/90th/99th Percentile latencies, and Error Rate
- Slowest endpoints in your application - Slowest endpoints in your application
- See exact request trace to figure out issues in downstream services, slow DB queries, call to 3rd party services like payment gateways, etc - See exact request trace to figure out issues in downstream services, slow DB queries, call to 3rd party services like payment gateways, etc
@ -20,17 +25,14 @@ SigNoz is an opensource observability platform. SigNoz uses distributed tracing
- In-built workflows to reduce your efforts in detecting common issues like new deployment failures, 3rd party slow APIs, etc (Coming Soon) - In-built workflows to reduce your efforts in detecting common issues like new deployment failures, 3rd party slow APIs, etc (Coming Soon)
- Anomaly Detection Framework (Coming Soon) - Anomaly Detection Framework (Coming Soon)
### Motivation: ### Motivation:
- SaaS vendors charge an insane amount to provide Application Monitoring. They often surprise you with huge month end bills without any transparency of data sent to them. - SaaS vendors charge an insane amount to provide Application Monitoring. They often surprise you with huge month end bills without any transparency of data sent to them.
- Data privacy and compliance demands data to not leave the network boundary - Data privacy and compliance demands data to not leave the network boundary
- Highly scalable architecture - Highly scalable architecture
- No more magic happening in agents installed in your infra. You take control of sampling, uptime, configuration. - No more magic happening in agents installed in your infra. You take control of sampling, uptime, configuration.
- Build modules over SigNoz to extend business specific capabilities - Build modules over SigNoz to extend business specific capabilities
# Getting Started # Getting Started
## Deploy using docker-compose ## Deploy using docker-compose
@ -39,7 +41,6 @@ We have a tiny-cluster setup and a standard setup to deploy using docker-compose
Follow the steps listed at https://signoz.io/docs/deployment/docker/. 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 at https://signoz.io/docs/deployment/docker/#troubleshooting may be helpful
## Deploy in Kubernetes using Helm. ## Deploy in Kubernetes using Helm.
Below steps will install the SigNoz in platform namespace inside your k8s cluster. Below steps will install the SigNoz in platform namespace inside your k8s cluster.
@ -53,7 +54,7 @@ kubectl -n platform apply -Rf deploy/kubernetes/jobs
kubectl -n platform apply -f deploy/kubernetes/otel-collector 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`* \*_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 ### Test HotROD application with SigNoz
@ -67,17 +68,19 @@ kubectl -n sample-application apply -Rf sample-apps/hotrod/
`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` `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 ### See UI
`kubectl -n platform port-forward svc/signoz-frontend 3000:3000` `kubectl -n platform port-forward svc/signoz-frontend 3000:3000`
### How to stop load ### 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` `kubectl -n sample-application run strzal --image=djbingham/curl --restart='OnFailure' -i --tty --rm --command -- curl http://locust-master:8089/stop`
# 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/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.
# Community # Community
Join the [slack community](https://app.slack.com/client/T01HWUTP0LT#/) to know more about distributed tracing, observability, or SigNoz and to connect with other users and contributors. Join the [slack community](https://app.slack.com/client/T01HWUTP0LT#/) to know more about distributed tracing, observability, or SigNoz and to connect with other users and contributors.
If you have any ideas, questions, or any feedback, please share on our [Github Discussions](https://github.com/SigNoz/signoz/discussions) If you have any ideas, questions, or any feedback, please share on our [Github Discussions](https://github.com/SigNoz/signoz/discussions)