From 15471090d52c046e4340f8c0c17ad75479bea181 Mon Sep 17 00:00:00 2001 From: Pranay Prateek Date: Tue, 20 Apr 2021 01:28:06 +0530 Subject: [PATCH 1/4] updated image & title in README --- README.md | 39 ++++++++++++++++++++++----------------- 1 file changed, 22 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 4e3bdf4574..53e3b763e8 100644 --- a/README.md +++ b/README.md @@ -1,48 +1,49 @@ -

SigNoz Logo

+

+ SigNoz-logo + +

Monitor your applications and troubleshoot problems in your deployed applications, an open-source alternative to DataDog, New Relic, etc.

+

[![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 Feature](https://signoz.io/img/readme_feature1.jpg) - - +![SigNoz Feature](https://res.cloudinary.com/dcv3epinx/image/upload/v1618861225/signoz-images/application-github-readme_rkpklh.jpg) ### Features: + - Application overview metrics like RPS, 50th/90th/99th Percentile latencies, and Error Rate - 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 -- Filter traces by service name, operation, latency, error, tags/annotations. +- Filter traces by service name, operation, latency, error, tags/annotations. - Aggregate metrics on filtered traces. Eg, you can get error rate and 99th percentile latency of `customer_type: gold` or `deployment_version: v2` or `external_call: paypal` - Unified UI for metrics and traces. No need to switch from Prometheus to Jaeger to debug issues. - 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) - ### 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. - Data privacy and compliance demands data to not leave the network boundary - Highly scalable architecture - 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 - - - # Getting Started ## Deploy using docker-compose 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 +## 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. ```console git clone https://github.com/SigNoz/signoz.git && cd signoz @@ -52,8 +53,8 @@ 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`* + +\*_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 @@ -67,17 +68,21 @@ 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` ### 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` - # 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. +# Why use SigNoz rather than Prometheus/Jaeger + # 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. If you have any ideas, questions, or any feedback, please share on our [Github Discussions](https://github.com/SigNoz/signoz/discussions) From ba95b36e09426a108e8be97c2b2e7b690279f670 Mon Sep 17 00:00:00 2001 From: Pranay Prateek Date: Tue, 20 Apr 2021 13:06:31 +0530 Subject: [PATCH 2/4] updated README image --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 53e3b763e8..e6a582bdc7 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ SigNoz is an opensource observability platform. SigNoz uses distributed tracing -![SigNoz Feature](https://res.cloudinary.com/dcv3epinx/image/upload/v1618861225/signoz-images/application-github-readme_rkpklh.jpg) +![SigNoz Feature](https://res.cloudinary.com/dcv3epinx/image/upload/v1618904032/signoz-images/screenzy-1618904013729_clssvy.png) ### Features: From 3d7b79fecd894856072a4735ddede55ed6d369c1 Mon Sep 17 00:00:00 2001 From: Pranay Prateek Date: Tue, 20 Apr 2021 13:12:03 +0530 Subject: [PATCH 3/4] updated README image --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e6a582bdc7..7c4ff9518b 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@

- SigNoz-logo + SigNoz-logo

Monitor your applications and troubleshoot problems in your deployed applications, an open-source alternative to DataDog, New Relic, etc.

From 4403a5c33401f472611c3780ed9d9e9d4ed44b1c Mon Sep 17 00:00:00 2001 From: Pranay Prateek Date: Tue, 20 Apr 2021 13:23:37 +0530 Subject: [PATCH 4/4] updated README image --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 7c4ff9518b..68c810b99e 100644 --- a/README.md +++ b/README.md @@ -79,8 +79,6 @@ kubectl -n sample-application apply -Rf sample-apps/hotrod/ 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. -# Why use SigNoz rather than Prometheus/Jaeger - # 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.