package cleanup import ( "context" "errors" "io/ioutil" "os" "path" "time" "github.com/grafana/grafana/pkg/services/queryhistory" "github.com/grafana/grafana/pkg/services/shorturls" "github.com/grafana/grafana/pkg/services/sqlstore" "github.com/grafana/grafana/pkg/infra/log" "github.com/grafana/grafana/pkg/infra/serverlock" "github.com/grafana/grafana/pkg/models" "github.com/grafana/grafana/pkg/services/annotations" "github.com/grafana/grafana/pkg/setting" ) func ProvideService(cfg *setting.Cfg, serverLockService *serverlock.ServerLockService, shortURLService shorturls.Service, store sqlstore.Store, queryHistoryService queryhistory.Service) *CleanUpService { s := &CleanUpService{ Cfg: cfg, ServerLockService: serverLockService, ShortURLService: shortURLService, QueryHistoryService: queryHistoryService, store: store, log: log.New("cleanup"), } return s } type CleanUpService struct { log log.Logger store sqlstore.Store Cfg *setting.Cfg ServerLockService *serverlock.ServerLockService ShortURLService shorturls.Service QueryHistoryService queryhistory.Service } func (srv *CleanUpService) Run(ctx context.Context) error { srv.cleanUpTmpFiles() ticker := time.NewTicker(time.Minute * 10) for { select { case <-ticker.C: ctxWithTimeout, cancelFn := context.WithTimeout(ctx, time.Minute*9) defer cancelFn() srv.cleanUpTmpFiles() srv.deleteExpiredSnapshots(ctx) srv.deleteExpiredDashboardVersions(ctx) srv.cleanUpOldAnnotations(ctxWithTimeout) srv.expireOldUserInvites(ctx) srv.deleteStaleShortURLs(ctx) srv.deleteStaleQueryHistory(ctx) err := srv.ServerLockService.LockAndExecute(ctx, "delete old login attempts", time.Minute*10, func(context.Context) { srv.deleteOldLoginAttempts(ctx) }) if err != nil { srv.log.Error("failed to lock and execute cleanup of old login attempts", "error", err) } case <-ctx.Done(): return ctx.Err() } } } func (srv *CleanUpService) cleanUpOldAnnotations(ctx context.Context) { cleaner := annotations.GetAnnotationCleaner() affected, affectedTags, err := cleaner.CleanAnnotations(ctx, srv.Cfg) if err != nil && !errors.Is(err, context.DeadlineExceeded) { srv.log.Error("failed to clean up old annotations", "error", err) } else { srv.log.Debug("Deleted excess annotations", "annotations affected", affected, "annotation tags affected", affectedTags) } } func (srv *CleanUpService) cleanUpTmpFiles() { folders := []string{ srv.Cfg.ImagesDir, srv.Cfg.CSVsDir, } for _, f := range folders { srv.cleanUpTmpFolder(f) } } func (srv *CleanUpService) cleanUpTmpFolder(folder string) { if _, err := os.Stat(folder); os.IsNotExist(err) { return } files, err := ioutil.ReadDir(folder) if err != nil { srv.log.Error("Problem reading dir", "folder", folder, "error", err) return } var toDelete []os.FileInfo var now = time.Now() for _, file := range files { if srv.shouldCleanupTempFile(file.ModTime(), now) { toDelete = append(toDelete, file) } } for _, file := range toDelete { fullPath := path.Join(folder, file.Name()) err := os.Remove(fullPath) if err != nil { srv.log.Error("Failed to delete temp file", "file", file.Name(), "error", err) } } srv.log.Debug("Found old rendered file to delete", "folder", folder, "deleted", len(toDelete), "kept", len(files)) } func (srv *CleanUpService) shouldCleanupTempFile(filemtime time.Time, now time.Time) bool { if srv.Cfg.TempDataLifetime == 0 { return false } return filemtime.Add(srv.Cfg.TempDataLifetime).Before(now) } func (srv *CleanUpService) deleteExpiredSnapshots(ctx context.Context) { cmd := models.DeleteExpiredSnapshotsCommand{} if err := srv.store.DeleteExpiredSnapshots(ctx, &cmd); err != nil { srv.log.Error("Failed to delete expired snapshots", "error", err.Error()) } else { srv.log.Debug("Deleted expired snapshots", "rows affected", cmd.DeletedRows) } } func (srv *CleanUpService) deleteExpiredDashboardVersions(ctx context.Context) { cmd := models.DeleteExpiredVersionsCommand{} if err := srv.store.DeleteExpiredVersions(ctx, &cmd); err != nil { srv.log.Error("Failed to delete expired dashboard versions", "error", err.Error()) } else { srv.log.Debug("Deleted old/expired dashboard versions", "rows affected", cmd.DeletedRows) } } func (srv *CleanUpService) deleteOldLoginAttempts(ctx context.Context) { if srv.Cfg.DisableBruteForceLoginProtection { return } cmd := models.DeleteOldLoginAttemptsCommand{ OlderThan: time.Now().Add(time.Minute * -10), } if err := srv.store.DeleteOldLoginAttempts(ctx, &cmd); err != nil { srv.log.Error("Problem deleting expired login attempts", "error", err.Error()) } else { srv.log.Debug("Deleted expired login attempts", "rows affected", cmd.DeletedRows) } } func (srv *CleanUpService) expireOldUserInvites(ctx context.Context) { maxInviteLifetime := srv.Cfg.UserInviteMaxLifetime cmd := models.ExpireTempUsersCommand{ OlderThan: time.Now().Add(-maxInviteLifetime), } if err := srv.store.ExpireOldUserInvites(ctx, &cmd); err != nil { srv.log.Error("Problem expiring user invites", "error", err.Error()) } else { srv.log.Debug("Expired user invites", "rows affected", cmd.NumExpired) } } func (srv *CleanUpService) deleteStaleShortURLs(ctx context.Context) { cmd := models.DeleteShortUrlCommand{ OlderThan: time.Now().Add(-time.Hour * 24 * 7), } if err := srv.ShortURLService.DeleteStaleShortURLs(ctx, &cmd); err != nil { srv.log.Error("Problem deleting stale short urls", "error", err.Error()) } else { srv.log.Debug("Deleted short urls", "rows affected", cmd.NumDeleted) } } func (srv *CleanUpService) deleteStaleQueryHistory(ctx context.Context) { // Delete query history from 14+ days ago with exception of starred queries maxQueryHistoryLifetime := time.Hour * 24 * 14 olderThan := time.Now().Add(-maxQueryHistoryLifetime).Unix() rowsCount, err := srv.QueryHistoryService.DeleteStaleQueriesInQueryHistory(ctx, olderThan) if err != nil { srv.log.Error("Problem deleting stale query history", "error", err.Error()) } else { srv.log.Debug("Deleted stale query history", "rows affected", rowsCount) } // Enforce 200k limit for query_history table queryHistoryLimit := 200000 rowsCount, err = srv.QueryHistoryService.EnforceRowLimitInQueryHistory(ctx, queryHistoryLimit, false) if err != nil { srv.log.Error("Problem with enforcing row limit for query_history", "error", err.Error()) } else { srv.log.Debug("Enforced row limit for query_history", "rows affected", rowsCount) } // Enforce 150k limit for query_history_star table queryHistoryStarLimit := 150000 rowsCount, err = srv.QueryHistoryService.EnforceRowLimitInQueryHistory(ctx, queryHistoryStarLimit, true) if err != nil { srv.log.Error("Problem with enforcing row limit for query_history_star", "error", err.Error()) } else { srv.log.Debug("Enforced row limit for query_history_star", "rows affected", rowsCount) } }