package app import ( "bytes" "context" "encoding/json" "errors" "fmt" "io" "net" "net/http" _ "net/http/pprof" // http profiler "net/url" "os" "strings" "time" "github.com/gorilla/handlers" "github.com/gorilla/mux" "github.com/jmoiron/sqlx" "github.com/rs/cors" "github.com/soheilhy/cmux" "go.signoz.io/signoz/pkg/query-service/agentConf" "go.signoz.io/signoz/pkg/query-service/app/clickhouseReader" "go.signoz.io/signoz/pkg/query-service/app/dashboards" "go.signoz.io/signoz/pkg/query-service/app/integrations" "go.signoz.io/signoz/pkg/query-service/app/logparsingpipeline" "go.signoz.io/signoz/pkg/query-service/app/opamp" opAmpModel "go.signoz.io/signoz/pkg/query-service/app/opamp/model" "go.signoz.io/signoz/pkg/query-service/app/preferences" "go.signoz.io/signoz/pkg/query-service/common" v3 "go.signoz.io/signoz/pkg/query-service/model/v3" "go.signoz.io/signoz/pkg/query-service/app/explorer" "go.signoz.io/signoz/pkg/query-service/auth" "go.signoz.io/signoz/pkg/query-service/cache" "go.signoz.io/signoz/pkg/query-service/constants" "go.signoz.io/signoz/pkg/query-service/dao" "go.signoz.io/signoz/pkg/query-service/featureManager" "go.signoz.io/signoz/pkg/query-service/healthcheck" am "go.signoz.io/signoz/pkg/query-service/integrations/alertManager" "go.signoz.io/signoz/pkg/query-service/interfaces" "go.signoz.io/signoz/pkg/query-service/model" pqle "go.signoz.io/signoz/pkg/query-service/pqlEngine" "go.signoz.io/signoz/pkg/query-service/rules" "go.signoz.io/signoz/pkg/query-service/telemetry" "go.signoz.io/signoz/pkg/query-service/utils" "go.uber.org/zap" ) type ServerOptions struct { PromConfigPath string SkipTopLvlOpsPath string HTTPHostPort string PrivateHostPort string // alert specific params DisableRules bool RuleRepoURL string PreferSpanMetrics bool MaxIdleConns int MaxOpenConns int DialTimeout time.Duration CacheConfigPath string FluxInterval string Cluster string } // Server runs HTTP, Mux and a grpc server type Server struct { serverOptions *ServerOptions ruleManager *rules.Manager // public http router httpConn net.Listener httpServer *http.Server // private http privateConn net.Listener privateHTTP *http.Server opampServer *opamp.Server unavailableChannel chan healthcheck.Status } // HealthCheckStatus returns health check status channel a client can subscribe to func (s Server) HealthCheckStatus() chan healthcheck.Status { return s.unavailableChannel } // NewServer creates and initializes Server func NewServer(serverOptions *ServerOptions) (*Server, error) { if err := dao.InitDao("sqlite", constants.RELATIONAL_DATASOURCE_PATH); err != nil { return nil, err } if err := preferences.InitDB(constants.RELATIONAL_DATASOURCE_PATH); err != nil { return nil, err } localDB, err := dashboards.InitDB(constants.RELATIONAL_DATASOURCE_PATH) explorer.InitWithDSN(constants.RELATIONAL_DATASOURCE_PATH) if err != nil { return nil, err } localDB.SetMaxOpenConns(10) // initiate feature manager fm := featureManager.StartManager() readerReady := make(chan bool) var reader interfaces.Reader storage := os.Getenv("STORAGE") if storage == "clickhouse" { zap.L().Info("Using ClickHouse as datastore ...") clickhouseReader := clickhouseReader.NewReader( localDB, serverOptions.PromConfigPath, fm, serverOptions.MaxIdleConns, serverOptions.MaxOpenConns, serverOptions.DialTimeout, serverOptions.Cluster, ) go clickhouseReader.Start(readerReady) reader = clickhouseReader } else { return nil, fmt.Errorf("storage type: %s is not supported in query service", storage) } skipConfig := &model.SkipConfig{} if serverOptions.SkipTopLvlOpsPath != "" { // read skip config skipConfig, err = model.ReadSkipConfig(serverOptions.SkipTopLvlOpsPath) if err != nil { return nil, err } } <-readerReady rm, err := makeRulesManager(serverOptions.PromConfigPath, constants.GetAlertManagerApiPrefix(), serverOptions.RuleRepoURL, localDB, reader, serverOptions.DisableRules, fm) if err != nil { return nil, err } var c cache.Cache if serverOptions.CacheConfigPath != "" { cacheOpts, err := cache.LoadFromYAMLCacheConfigFile(serverOptions.CacheConfigPath) if err != nil { return nil, err } c = cache.NewCache(cacheOpts) } fluxInterval, err := time.ParseDuration(serverOptions.FluxInterval) if err != nil { return nil, err } integrationsController, err := integrations.NewController(localDB) if err != nil { return nil, fmt.Errorf("couldn't create integrations controller: %w", err) } logParsingPipelineController, err := logparsingpipeline.NewLogParsingPipelinesController( localDB, "sqlite", integrationsController.GetPipelinesForInstalledIntegrations, ) if err != nil { return nil, err } telemetry.GetInstance().SetReader(reader) apiHandler, err := NewAPIHandler(APIHandlerOpts{ Reader: reader, SkipConfig: skipConfig, PreferSpanMetrics: serverOptions.PreferSpanMetrics, MaxIdleConns: serverOptions.MaxIdleConns, MaxOpenConns: serverOptions.MaxOpenConns, DialTimeout: serverOptions.DialTimeout, AppDao: dao.DB(), RuleManager: rm, FeatureFlags: fm, IntegrationsController: integrationsController, LogsParsingPipelineController: logParsingPipelineController, Cache: c, FluxInterval: fluxInterval, }) if err != nil { return nil, err } s := &Server{ // logger: logger, // tracer: tracer, ruleManager: rm, serverOptions: serverOptions, unavailableChannel: make(chan healthcheck.Status), } httpServer, err := s.createPublicServer(apiHandler) if err != nil { return nil, err } s.httpServer = httpServer privateServer, err := s.createPrivateServer(apiHandler) if err != nil { return nil, err } s.privateHTTP = privateServer _, err = opAmpModel.InitDB(localDB) if err != nil { return nil, err } agentConfMgr, err := agentConf.Initiate(&agentConf.ManagerOptions{ DB: localDB, DBEngine: "sqlite", AgentFeatures: []agentConf.AgentFeature{ logParsingPipelineController, }, }) if err != nil { return nil, err } s.opampServer = opamp.InitializeServer( &opAmpModel.AllAgents, agentConfMgr, ) return s, nil } func (s *Server) createPrivateServer(api *APIHandler) (*http.Server, error) { r := NewRouter() r.Use(setTimeoutMiddleware) r.Use(s.analyticsMiddleware) r.Use(loggingMiddlewarePrivate) api.RegisterPrivateRoutes(r) c := cors.New(cors.Options{ //todo(amol): find out a way to add exact domain or // ip here for alert manager AllowedOrigins: []string{"*"}, AllowedMethods: []string{"GET", "DELETE", "POST", "PUT", "PATCH"}, AllowedHeaders: []string{"Accept", "Authorization", "Content-Type"}, }) handler := c.Handler(r) handler = handlers.CompressHandler(handler) return &http.Server{ Handler: handler, }, nil } func (s *Server) createPublicServer(api *APIHandler) (*http.Server, error) { r := NewRouter() r.Use(LogCommentEnricher) r.Use(setTimeoutMiddleware) r.Use(s.analyticsMiddleware) r.Use(loggingMiddleware) // add auth middleware getUserFromRequest := func(r *http.Request) (*model.UserPayload, error) { user, err := auth.GetUserFromRequest(r) if err != nil { return nil, err } if user.User.OrgId == "" { return nil, model.UnauthorizedError(errors.New("orgId is missing in the claims")) } return user, nil } am := NewAuthMiddleware(getUserFromRequest) api.RegisterRoutes(r, am) api.RegisterLogsRoutes(r, am) api.RegisterIntegrationRoutes(r, am) api.RegisterQueryRangeV3Routes(r, am) api.RegisterQueryRangeV4Routes(r, am) c := cors.New(cors.Options{ AllowedOrigins: []string{"*"}, AllowedMethods: []string{"GET", "DELETE", "POST", "PUT", "PATCH", "OPTIONS"}, AllowedHeaders: []string{"Accept", "Authorization", "Content-Type", "cache-control"}, }) handler := c.Handler(r) handler = handlers.CompressHandler(handler) return &http.Server{ Handler: handler, }, nil } // loggingMiddleware is used for logging public api calls func loggingMiddleware(next http.Handler) http.Handler { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { route := mux.CurrentRoute(r) path, _ := route.GetPathTemplate() startTime := time.Now() next.ServeHTTP(w, r) zap.L().Info(path, zap.Duration("timeTaken", time.Since(startTime)), zap.String("path", path)) }) } func LogCommentEnricher(next http.Handler) http.Handler { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { referrer := r.Header.Get("Referer") var path, dashboardID, alertID, page, client, viewName, tab string if referrer != "" { referrerURL, _ := url.Parse(referrer) client = "browser" path = referrerURL.Path if strings.Contains(path, "/dashboard") { // Split the path into segments pathSegments := strings.Split(referrerURL.Path, "/") // The dashboard ID should be the segment after "/dashboard/" // Loop through pathSegments to find "dashboard" and then take the next segment as the ID for i, segment := range pathSegments { if segment == "dashboard" && i < len(pathSegments)-1 { // Return the next segment, which should be the dashboard ID dashboardID = pathSegments[i+1] } } page = "dashboards" } else if strings.Contains(path, "/alerts") { urlParams := referrerURL.Query() alertID = urlParams.Get("ruleId") page = "alerts" } else if strings.Contains(path, "logs") && strings.Contains(path, "explorer") { page = "logs-explorer" viewName = referrerURL.Query().Get("viewName") } else if strings.Contains(path, "/trace") || strings.Contains(path, "traces-explorer") { page = "traces-explorer" viewName = referrerURL.Query().Get("viewName") } else if strings.Contains(path, "/services") { page = "services" tab = referrerURL.Query().Get("tab") if tab == "" { tab = "OVER_METRICS" } } } else { client = "api" } kvs := map[string]string{ "path": path, "dashboardID": dashboardID, "alertID": alertID, "source": page, "client": client, "viewName": viewName, "servicesTab": tab, } r = r.WithContext(context.WithValue(r.Context(), common.LogCommentKey, kvs)) next.ServeHTTP(w, r) }) } // loggingMiddlewarePrivate is used for logging private api calls // from internal services like alert manager func loggingMiddlewarePrivate(next http.Handler) http.Handler { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { route := mux.CurrentRoute(r) path, _ := route.GetPathTemplate() startTime := time.Now() next.ServeHTTP(w, r) zap.L().Info(path, zap.Duration("timeTaken", time.Since(startTime)), zap.String("path", path), zap.Bool("privatePort", true)) }) } type loggingResponseWriter struct { http.ResponseWriter statusCode int } func NewLoggingResponseWriter(w http.ResponseWriter) *loggingResponseWriter { // WriteHeader(int) is not called if our response implicitly returns 200 OK, so // we default to that status code. return &loggingResponseWriter{w, http.StatusOK} } func (lrw *loggingResponseWriter) WriteHeader(code int) { lrw.statusCode = code lrw.ResponseWriter.WriteHeader(code) } // Flush implements the http.Flush interface. func (lrw *loggingResponseWriter) Flush() { lrw.ResponseWriter.(http.Flusher).Flush() } func extractQueryRangeV3Data(path string, r *http.Request) (map[string]interface{}, bool) { pathToExtractBodyFrom := "/api/v3/query_range" data := map[string]interface{}{} var postData *v3.QueryRangeParamsV3 if path == pathToExtractBodyFrom && (r.Method == "POST") { if r.Body != nil { bodyBytes, err := io.ReadAll(r.Body) if err != nil { return nil, false } r.Body.Close() // must close r.Body = io.NopCloser(bytes.NewBuffer(bodyBytes)) json.Unmarshal(bodyBytes, &postData) } else { return nil, false } } else { return nil, false } signozMetricsUsed := false signozLogsUsed := false signozTracesUsed := false if postData != nil { if postData.CompositeQuery != nil { data["queryType"] = postData.CompositeQuery.QueryType data["panelType"] = postData.CompositeQuery.PanelType signozLogsUsed, signozMetricsUsed, signozTracesUsed = telemetry.GetInstance().CheckSigNozSignals(postData) } } if signozMetricsUsed || signozLogsUsed || signozTracesUsed { if signozMetricsUsed { telemetry.GetInstance().AddActiveMetricsUser() } if signozLogsUsed { telemetry.GetInstance().AddActiveLogsUser() } if signozTracesUsed { telemetry.GetInstance().AddActiveTracesUser() } data["metricsUsed"] = signozMetricsUsed data["logsUsed"] = signozLogsUsed data["tracesUsed"] = signozTracesUsed userEmail, err := auth.GetEmailFromJwt(r.Context()) if err == nil { telemetry.GetInstance().SendEvent(telemetry.TELEMETRY_EVENT_QUERY_RANGE_API, data, userEmail, true, false) } } return data, true } func getActiveLogs(path string, r *http.Request) { // if path == "/api/v1/dashboards/{uuid}" { // telemetry.GetInstance().AddActiveMetricsUser() // } if path == "/api/v1/logs" { hasFilters := len(r.URL.Query().Get("q")) if hasFilters > 0 { telemetry.GetInstance().AddActiveLogsUser() } } } func (s *Server) analyticsMiddleware(next http.Handler) http.Handler { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { ctx := auth.AttachJwtToContext(r.Context(), r) r = r.WithContext(ctx) route := mux.CurrentRoute(r) path, _ := route.GetPathTemplate() queryRangeV3data, metadataExists := extractQueryRangeV3Data(path, r) getActiveLogs(path, r) lrw := NewLoggingResponseWriter(w) next.ServeHTTP(lrw, r) data := map[string]interface{}{"path": path, "statusCode": lrw.statusCode} if metadataExists { for key, value := range queryRangeV3data { data[key] = value } } // if telemetry.GetInstance().IsSampled() { if _, ok := telemetry.EnabledPaths()[path]; ok { userEmail, err := auth.GetEmailFromJwt(r.Context()) if err == nil { telemetry.GetInstance().SendEvent(telemetry.TELEMETRY_EVENT_PATH, data, userEmail, true, false) } } // } }) } func getRouteContextTimeout(overrideTimeout string) time.Duration { var timeout time.Duration var err error if overrideTimeout != "" { timeout, err = time.ParseDuration(overrideTimeout + "s") if err != nil { timeout = constants.ContextTimeout } if timeout > constants.ContextTimeoutMaxAllowed { timeout = constants.ContextTimeoutMaxAllowed } return timeout } return constants.ContextTimeout } func setTimeoutMiddleware(next http.Handler) http.Handler { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { ctx := r.Context() var cancel context.CancelFunc // check if route is not excluded url := r.URL.Path if _, ok := constants.TimeoutExcludedRoutes[url]; !ok { ctx, cancel = context.WithTimeout(r.Context(), getRouteContextTimeout(r.Header.Get("timeout"))) defer cancel() } r = r.WithContext(ctx) next.ServeHTTP(w, r) }) } // initListeners initialises listeners of the server func (s *Server) initListeners() error { // listen on public port var err error publicHostPort := s.serverOptions.HTTPHostPort if publicHostPort == "" { return fmt.Errorf("constants.HTTPHostPort is required") } s.httpConn, err = net.Listen("tcp", publicHostPort) if err != nil { return err } zap.L().Info(fmt.Sprintf("Query server started listening on %s...", s.serverOptions.HTTPHostPort)) // listen on private port to support internal services privateHostPort := s.serverOptions.PrivateHostPort if privateHostPort == "" { return fmt.Errorf("constants.PrivateHostPort is required") } s.privateConn, err = net.Listen("tcp", privateHostPort) if err != nil { return err } zap.L().Info(fmt.Sprintf("Query server started listening on private port %s...", s.serverOptions.PrivateHostPort)) return nil } // Start listening on http and private http port concurrently func (s *Server) Start() error { // initiate rule manager first if !s.serverOptions.DisableRules { s.ruleManager.Start() } else { zap.L().Info("msg: Rules disabled as rules.disable is set to TRUE") } err := s.initListeners() if err != nil { return err } var httpPort int if port, err := utils.GetPort(s.httpConn.Addr()); err == nil { httpPort = port } go func() { zap.L().Info("Starting HTTP server", zap.Int("port", httpPort), zap.String("addr", s.serverOptions.HTTPHostPort)) switch err := s.httpServer.Serve(s.httpConn); err { case nil, http.ErrServerClosed, cmux.ErrListenerClosed: // normal exit, nothing to do default: zap.L().Error("Could not start HTTP server", zap.Error(err)) } s.unavailableChannel <- healthcheck.Unavailable }() go func() { zap.L().Info("Starting pprof server", zap.String("addr", constants.DebugHttpPort)) err = http.ListenAndServe(constants.DebugHttpPort, nil) if err != nil { zap.L().Error("Could not start pprof server", zap.Error(err)) } }() var privatePort int if port, err := utils.GetPort(s.privateConn.Addr()); err == nil { privatePort = port } fmt.Println("starting private http") go func() { zap.L().Info("Starting Private HTTP server", zap.Int("port", privatePort), zap.String("addr", s.serverOptions.PrivateHostPort)) switch err := s.privateHTTP.Serve(s.privateConn); err { case nil, http.ErrServerClosed, cmux.ErrListenerClosed: // normal exit, nothing to do zap.L().Info("private http server closed") default: zap.L().Error("Could not start private HTTP server", zap.Error(err)) } s.unavailableChannel <- healthcheck.Unavailable }() go func() { zap.L().Info("Starting OpAmp Websocket server", zap.String("addr", constants.OpAmpWsEndpoint)) err := s.opampServer.Start(constants.OpAmpWsEndpoint) if err != nil { zap.L().Info("opamp ws server failed to start", zap.Error(err)) s.unavailableChannel <- healthcheck.Unavailable } }() return nil } func (s *Server) Stop() error { if s.httpServer != nil { if err := s.httpServer.Shutdown(context.Background()); err != nil { return err } } if s.privateHTTP != nil { if err := s.privateHTTP.Shutdown(context.Background()); err != nil { return err } } s.opampServer.Stop() if s.ruleManager != nil { s.ruleManager.Stop() } return nil } func makeRulesManager( promConfigPath, alertManagerURL string, ruleRepoURL string, db *sqlx.DB, ch interfaces.Reader, disableRules bool, fm interfaces.FeatureLookup) (*rules.Manager, error) { // create engine pqle, err := pqle.FromReader(ch) if err != nil { return nil, fmt.Errorf("failed to create pql engine : %v", err) } // notifier opts notifierOpts := am.NotifierOptions{ QueueCapacity: 10000, Timeout: 1 * time.Second, AlertManagerURLs: []string{alertManagerURL}, } // create manager opts managerOpts := &rules.ManagerOptions{ NotifierOpts: notifierOpts, Queriers: &rules.Queriers{ PqlEngine: pqle, Ch: ch.GetConn(), }, RepoURL: ruleRepoURL, DBConn: db, Context: context.Background(), Logger: nil, DisableRules: disableRules, FeatureFlags: fm, Reader: ch, } // create Manager manager, err := rules.NewManager(managerOpts) if err != nil { return nil, fmt.Errorf("rule manager error: %v", err) } zap.L().Info("rules manager is ready") return manager, nil }