Merge branch 'develop' into SIG-6148

README.md

@@ -1,8 +1,11 @@
-<p align="center">
- <img src="https://res.cloudinary.com/dcv3epinx/image/upload/v1618904450/signoz-images/LogoGithub_sigfbu.svg" alt="SigNoz-logo" width="240" />
+<h1 align="center" style="border-bottom: none">
+ <a href="https://signoz.io" target="_blank">
+  <img alt="SigNoz" src="https:/user-attachments/assets/ef9a33f7-12d7-4c94-8908-0a02b22f0c18" width="100" height="100">
+ </a>
+ <br>SigNoz
+</h1>
 
- <p align="center">Monitor your applications and troubleshoot problems in your deployed applications, an open-source alternative to DataDog, New Relic, etc.</p>
-</p>
+<p align="center">All your logs, metrics, and traces in one place. Monitor your application, spot issues before they occur and troubleshoot downtime quickly with rich context. SigNoz is a cost-effective open-source alternative to Datadog and New Relic. Visit <a href="https://signoz.io" target="_blank">signoz.io</a> for the full documentation, tutorials, and guide.</p>
 
 <p align="center">
  <img alt="Downloads" src="https://img.shields.io/docker/pulls/signoz/query-service?label=Docker Downloads"> </a>
@@ -21,110 +24,99 @@
  <a href="https://twitter.com/SigNozHq"><b>Twitter</b></a>
 </h3>
 
-##
-
-SigNoz helps developers monitor applications and troubleshoot problems in their deployed applications. With SigNoz, you can:
+## Features
 
-👉 Visualise Metrics, Traces and Logs in a single pane of glass
 
-👉 You can see metrics like p99 latency, error rates for your services, external API calls and individual end points.
+### Application Performance Monitoring
 
-👉 You can find the root cause of the problem by going to the exact traces which are causing the problem and see detailed flamegraphs of individual request traces.
+Use SigNoz APM to monitor your applications and services. It comes with out-of-box charts for key application metrics like p99 latency, error rate, Apdex and operations per second. You can also monitor the database and external calls made from your application. Read [more](https://signoz.io/application-performance-monitoring/).
 
-👉 Run aggregates on trace data to get business relevant metrics
+You can [instrument](https://signoz.io/docs/instrumentation/) your application with OpenTelemetry to get started.
 
-👉 Filter and query logs, build dashboards and alerts based on attributes in logs
+![apm-cover](https:/user-attachments/assets/fa5c0396-0854-4c8b-b972-9b62fd2a70d2)
 
-👉 Record exceptions automatically in Python, Java, Ruby, and Javascript
 
-👉 Easy to set alerts with DIY query builder
+### Logs Management
 
+SigNoz can be used as a centralized log management solution. We use ClickHouse (used by likes of Uber & Cloudflare) as a datastore, ⎯ an extremely fast and highly optimized storage for logs data. Instantly search through all your logs using quick filters and a powerful query builder.
 
-### Application Metrics
+You can also create charts on your logs and monitor them with customized dashboards. Read [more](https://signoz.io/log-management/).
 
-![application_metrics](https://user-images.githubusercontent.com/83692067/226637410-900dbc5e-6705-4b11-a10c-bd0faeb2a92f.png)
+![logs-management-cover](https://github.com/user-attachments/assets/343588ee-98fb-4310-b3d2-c5bacf9c7384)
 
 
 ### Distributed Tracing
-<img width="2068" alt="distributed_tracing_2 2" src="https://user-images.githubusercontent.com/83692067/226536447-bae58321-6a22-4ed3-af80-e3e964cb3489.png">
 
-<img width="2068" alt="distributed_tracing_1" src="https://user-images.githubusercontent.com/83692067/226536462-939745b6-4f9d-45a6-8016-814837e7f7b4.png">
+Distributed Tracing is essential to troubleshoot issues in microservices applications. Powered by OpenTelemetry, distributed tracing in SigNoz can help you track user requests across services to help you identify performance bottlenecks. 
 
-### Logs Management
+See user requests in a detailed breakdown with the help of Flamegraphs and Gantt Charts. Click on any span to see the entire trace represented beautifully, which will help you make sense of where issues actually occurred in the flow of requests.
 
-<img width="2068" alt="logs_management" src="https://user-images.githubusercontent.com/83692067/226536482-b8a5c4af-b69c-43d5-969c-338bd5eaf1a5.png">
+Read [more](https://signoz.io/distributed-tracing/).
 
-### Infrastructure Monitoring
+![distributed-tracing-cover](https:/user-attachments/assets/9bfe060a-0c40-4922-9b55-8a97e1a4076c)
 
-<img width="2068" alt="infrastructure_monitoring" src="https://user-images.githubusercontent.com/83692067/226536496-f38c4dbf-e03c-4158-8be0-32d4a61158c7.png">
 
-### Exceptions Monitoring
 
-![exceptions_light](https://user-images.githubusercontent.com/83692067/226637967-4188d024-3ac9-4799-be95-f5ea9c45436f.png)
+### Metrics and Dashboards
+
+Ingest metrics from your infrastructure or applications and create customized dashboards to monitor them. Create visualization that suits your needs with a variety of panel types like pie chart, time-series, bar chart, etc.
+
+Create queries on your metrics data quickly with an easy-to-use metrics query builder. Add multiple queries and combine those queries with formulae to create really complex queries quickly.
 
+Read [more](https://signoz.io/metrics-and-dashboards/).
+
+![metrics-n-dashboards-cover](https:/user-attachments/assets/a536fd71-1d2c-4681-aa7e-516d754c47a5)
 
 ### Alerts
 
-<img width="2068" alt="alerts_management" src="https://user-images.githubusercontent.com/83692067/226536548-2c81e2e8-c12d-47e8-bad7-c6be79055def.png">
+Use alerts in SigNoz to get notified when anything unusual happens in your application. You can set alerts on any type of telemetry signal (logs, metrics, traces), create thresholds and set up a notification channel to get notified. Advanced features like alert history and anomaly detection can help you create smarter alerts.
 
+Alerts in SigNoz help you identify issues proactively so that you can address them before they reach your customers.
 
-<br /><br />
+Read [more](https://signoz.io/alerts-management/).
 
+![alerts-cover](https:/user-attachments/assets/03873bb8-1b62-4adf-8f56-28bb7b1750ea)
 
-## Join our Slack community
+### Exceptions Monitoring
 
-Come say Hi to us on [Slack](https://signoz.io/slack) 👋
+Monitor exceptions automatically in Python, Java, Ruby, and Javascript. For other languages, just drop in a few lines of code and start monitoring exceptions.
 
-<br /><br />
+See the detailed stack trace for all exceptions caught in your application. You can also log in custom attributes to add more context to your exceptions. For example, you can add attributes to identify users for which exceptions occurred.
 
+Read [more](https://signoz.io/exceptions-monitoring/).
 
-## Features:
 
-- Unified UI for metrics, traces and logs. No need to switch from Prometheus to Jaeger to debug issues, or use a logs tool like Elastic separate from your metrics and traces stack. 
-- 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.
-- Run aggregates on trace data (events/spans) to get business relevant metrics. e.g. You can get error rate and 99th percentile latency of `customer_type: gold` or `deployment_version: v2` or `external_call: paypal`
-- Native support for OpenTelemetry Logs, advanced log query builder, and automatic log collection from k8s cluster
-- Lightning quick log analytics ([Logs Perf. Benchmark](https://signoz.io/blog/logs-performance-benchmark/))
-- End-to-End visibility into infrastructure performance, ingest metrics from all kinds of host environments
-- Easy to set alerts with DIY query builder
+![exceptions-cover](https:/user-attachments/assets/4be37864-59f2-4e8a-8d6e-e29ad04298c5)
 
-<br /><br />
 
+<br /><br />
 
 ## Why SigNoz?
 
-Being developers, we found it annoying to rely on closed source SaaS vendors for every small feature we wanted. Closed source vendors often surprise you with huge month end bills without any transparency.
+SigNoz is a single tool for all your monitoring and observability needs. Here are a few reasons why you should choose SigNoz:
 
-We wanted to make a self-hosted & open source version of tools like DataDog, NewRelic for companies that have privacy and security concerns about having customer data going to third party services.
+- Single tool for observability(logs, metrics, and traces)
 
-Being open source also gives you complete control of your configuration, sampling, uptimes. You can also build modules over SigNoz to extend business specific capabilities
+- Built on top of [OpenTelemetry](https://opentelemetry.io/), the open-source standard which frees you from any type of vendor lock-in
 
-### Languages supported:
+- Correlated logs, metrics and traces for much richer context while debugging
 
-We support [OpenTelemetry](https://opentelemetry.io) as the library which you can use to instrument your applications. So any framework and language supported by OpenTelemetry is also supported by SigNoz. Some of the main supported languages are:
+- Uses ClickHouse (used by likes of Uber & Cloudflare) as datastore - an extremely fast and highly optimized storage for observability data
 
-- Java
-- Python
-- Node.js
-- Go
-- PHP
-- .NET
-- Ruby
-- Elixir
-- Rust
+- DIY Query builder, PromQL, and ClickHouse queries to fulfill all your use-cases around querying observability data
 
+- Open-Source - you can use open-source, our [cloud service](https://signoz.io/teams/) or a mix of both based on your use case
 
-You can find the complete list of languages here - https://opentelemetry.io/docs/
 
-<br /><br />
+## Getting Started
 
+### Create a SigNoz Cloud Account
 
-## Getting Started
+SigNoz cloud is the easiest way to get started with SigNoz. Our cloud service is for those users who want to spend more time in getting insights for their application performance without worrying about maintenance. 
+
+[Get started for free](https://signoz.io/teams/)
 
-### Deploy using Docker
+### Deploy using Docker(self-hosted)
 
 Please follow the steps listed [here](https://signoz.io/docs/install/docker/) to install using docker
 
@@ -133,20 +125,51 @@ The [troubleshooting instructions](https://signoz.io/docs/install/troubleshootin
 <p>&nbsp </p>
 
 
-### Deploy in Kubernetes using Helm
+### Deploy in Kubernetes using Helm(self-hosted)
 
 Please follow the steps listed [here](https://signoz.io/docs/deployment/helm_chart) to install using helm charts
 
 <br /><br />
 
+We also offer managed services in your infra. Check our [pricing plans](https://signoz.io/pricing/) for all details.
+
+
+## Join our Slack community
+
+Come say Hi to us on [Slack](https://signoz.io/slack) 👋
+
+<br /><br />
+
+
+### Languages supported:
+
+SigNoz supports all major programming languages for monitoring. Any framework and language supported by OpenTelemetry is supported by SigNoz. Find instructions for instrumenting different languages below:
+
+- [Java](https://signoz.io/docs/instrumentation/java/)
+- [Python](https://signoz.io/docs/instrumentation/python/)
+- [Node.js or Javascript](https://signoz.io/docs/instrumentation/javascript/)
+- [Go](https://signoz.io/docs/instrumentation/golang/)
+- [PHP](https://signoz.io/docs/instrumentation/php/)
+- [.NET](https://signoz.io/docs/instrumentation/dotnet/)
+- [Ruby](https://signoz.io/docs/instrumentation/ruby-on-rails/)
+- [Elixir](https://signoz.io/docs/instrumentation/elixir/)
+- [Rust](https://signoz.io/docs/instrumentation/rust/)
+- [Swift](https://signoz.io/docs/instrumentation/swift/)
+
+You can find our entire documentation [here](https://signoz.io/docs/introduction/).
+
+<br /><br />
+
 
 ## Comparisons to Familiar Tools
 
 ### SigNoz vs Prometheus
 
-Prometheus is good if you want to do just metrics. But if you want to have a seamless experience between metrics and traces, then current experience of stitching together Prometheus & Jaeger is not great.
+Prometheus is good if you want to do just metrics. But if you want to have a seamless experience between metrics, logs and traces, then current experience of stitching together Prometheus & other tools is not great.
+
+SigNoz is a one-stop solution for metrics and other telemetry signals. And because you will use the same standard(OpenTelemetry) to collect all telemetry signals, you can also correlate these signals to troubleshoot quickly.
 
-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.
+For example, if you see that there are issues with infrastructure metrics of your k8s cluster at a timestamp, you can jump to other signals like logs and traces to understand the issue quickly.
 
 <p>&nbsp </p>
 
@@ -158,6 +181,7 @@ Moreover, SigNoz has few more advanced features wrt Jaeger:
 
 - Jaegar UI doesn’t show any metrics on traces or on filtered traces
 - Jaeger can’t get aggregates on filtered traces. For example, p99 latency of requests which have tag - customer_type='premium'. This can be done easily on SigNoz
+- You can also go from traces to logs easily in SigNoz
 
 <p>&nbsp </p>
 

ee/query-service/app/api/queryrange.go

@@ -53,7 +53,11 @@ func (aH *APIHandler) queryRangeV4(w http.ResponseWriter, r *http.Request) {
  if anomalyQueryExists {
  // ensure all queries have metric data source, and there should be only one anomaly query
  for _, query := range queryRangeParams.CompositeQuery.BuilderQueries {
- if query.DataSource != v3.DataSourceMetrics {
+ // What is query.QueryName == query.Expression doing here?
+ // In the current implementation, the way to recognize if a query is a formula is by
+ // checking if the expression is the same as the query name. if the expression is different
+ // then it is a formula. otherwise, it is simple builder query.
+ if query.DataSource != v3.DataSourceMetrics && query.QueryName == query.Expression {
  RespondError(w, &model.ApiError{Typ: model.ErrorBadData, Err: fmt.Errorf("all queries must have metric data source")}, nil)
  return
  }
@@ -100,6 +104,13 @@ func (aH *APIHandler) queryRangeV4(w http.ResponseWriter, r *http.Request) {
  anomaly.WithReader[*anomaly.HourlyProvider](aH.opts.DataConnector),
  anomaly.WithFeatureLookup[*anomaly.HourlyProvider](aH.opts.FeatureFlags),
  )
+ default:
+ provider = anomaly.NewDailyProvider(
+ anomaly.WithCache[*anomaly.DailyProvider](aH.opts.Cache),
+ anomaly.WithKeyGenerator[*anomaly.DailyProvider](queryBuilder.NewKeyGenerator()),
+ anomaly.WithReader[*anomaly.DailyProvider](aH.opts.DataConnector),
+ anomaly.WithFeatureLookup[*anomaly.DailyProvider](aH.opts.FeatureFlags),
+ )
  }
  anomalies, err := provider.GetAnomalies(r.Context(), &anomaly.GetAnomaliesRequest{Params: queryRangeParams})
  if err != nil {

ee/query-service/model/plans.go

@@ -373,7 +373,7 @@ var EnterprisePlan = basemodel.FeatureSet{
  },
  basemodel.Feature{
  Name: basemodel.AnomalyDetection,
- Active: true,
+ Active: false,
  Usage: 0,
  UsageLimit: -1,
  Route: "",

frontend/package.json

@@ -239,6 +239,7 @@
  "debug": "4.3.4",
  "semver": "7.5.4",
  "xml2js": "0.5.0",
- "phin": "^3.7.1"
+ "phin": "^3.7.1",
+ "body-parser": "1.20.3"
  }
 }

frontend/public/locales/en-GB/alerts.json

@@ -56,6 +56,7 @@
  "option_last": "last",
  "option_above": "above",
  "option_below": "below",
+ "option_above_below": "above/below",
  "option_equal": "is equal to",
  "option_notequal": "not equal to",
  "button_query": "Query",
@@ -110,6 +111,8 @@
  "choose_alert_type": "Choose a type for the alert",
  "metric_based_alert": "Metric based Alert",
  "metric_based_alert_desc": "Send a notification when a condition occurs in the metric data.",
+ "anomaly_based_alert": "Anomaly based Alert",
+ "anomaly_based_alert_desc": "Send a notification when a condition occurs in the metric data.",
  "log_based_alert": "Log-based Alert",
  "log_based_alert_desc": "Send a notification when a condition occurs in the logs data.",
  "traces_based_alert": "Trace-based Alert",

frontend/public/locales/en-GB/rules.json

@@ -43,6 +43,7 @@
  "option_last": "last",
  "option_above": "above",
  "option_below": "below",
+ "option_above_below": "above/below",
  "option_equal": "is equal to",
  "option_notequal": "not equal to",
  "button_query": "Query",

frontend/public/locales/en/alerts.json

@@ -13,9 +13,12 @@
  "button_no": "No",
  "remove_label_confirm": "This action will remove all the labels. Do you want to proceed?",
  "remove_label_success": "Labels cleared",
- "alert_form_step1": "Step 1 - Define the metric",
- "alert_form_step2": "Step 2 - Define Alert Conditions",
- "alert_form_step3": "Step 3 - Alert Configuration",
+ "alert_form_step1": "Choose a detection method",
+ "alert_form_step2": "Define the metric",
+ "alert_form_step3": "Define Alert Conditions",
+ "alert_form_step4": "Alert Configuration",
+ "threshold_alert_desc": "An alert is triggered whenever a metric deviates from an expected threshold.",
+ "anomaly_detection_alert_desc": "An alert is triggered whenever a metric deviates from an expected pattern.",
  "metric_query_max_limit": "Can not create query. You can create maximum of 5 queries",
  "confirm_save_title": "Save Changes",
  "confirm_save_content_part1": "Your alert built with",
@@ -35,6 +38,7 @@
  "button_cancelchanges": "Cancel",
  "button_discard": "Discard",
  "text_condition1": "Send a notification when",
+ "text_condition1_anomaly": "Send notification when the observed value for",
  "text_condition2": "the threshold",
  "text_condition3": "during the last",
  "option_1min": "1 min",
@@ -56,6 +60,7 @@
  "option_last": "last",
  "option_above": "above",
  "option_below": "below",
+ "option_above_below": "above/below",
  "option_equal": "is equal to",
  "option_notequal": "not equal to",
  "button_query": "Query",
@@ -109,7 +114,9 @@
  "user_tooltip_more_help": "More details on how to create alerts",
  "choose_alert_type": "Choose a type for the alert",
  "metric_based_alert": "Metric based Alert",
+ "anomaly_based_alert": "Anomaly based Alert",
  "metric_based_alert_desc": "Send a notification when a condition occurs in the metric data.",
+ "anomaly_based_alert_desc": "Send a notification when a condition occurs in the metric data.",
  "log_based_alert": "Log-based Alert",
  "log_based_alert_desc": "Send a notification when a condition occurs in the logs data.",
  "traces_based_alert": "Trace-based Alert",

frontend/public/locales/en/rules.json

@@ -43,6 +43,7 @@
  "option_last": "last",
  "option_above": "above",
  "option_below": "below",
+ "option_above_below": "above/below",
  "option_equal": "is equal to",
  "option_notequal": "not equal to",
  "button_query": "Query",

frontend/src/constants/alerts.ts

@@ -2,6 +2,7 @@ import { AlertTypes } from 'types/api/alerts/alertTypes';
 import { DataSource } from 'types/common/queryBuilder';
 
 export const ALERTS_DATA_SOURCE_MAP: Record<AlertTypes, DataSource> = {
+ [AlertTypes.ANOMALY_BASED_ALERT]: DataSource.METRICS,
  [AlertTypes.METRICS_BASED_ALERT]: DataSource.METRICS,
  [AlertTypes.LOGS_BASED_ALERT]: DataSource.LOGS,
  [AlertTypes.TRACES_BASED_ALERT]: DataSource.TRACES,

frontend/src/constants/features.ts

@@ -22,4 +22,5 @@ export enum FeatureKeys {
  GATEWAY = 'GATEWAY',
  PREMIUM_SUPPORT = 'PREMIUM_SUPPORT',
  QUERY_BUILDER_SEARCH_V2 = 'QUERY_BUILDER_SEARCH_V2',
+ ANOMALY_DETECTION = 'ANOMALY_DETECTION',
 }

frontend/src/constants/query.ts

@@ -36,4 +36,5 @@ export enum QueryParams {
  topic = 'topic',
  partition = 'partition',
  selectedTimelineQuery = 'selectedTimelineQuery',
+ ruleType = 'ruleType',
 }