mirror of
https://github.com/grafana/grafana.git
synced 2025-08-02 07:12:13 +08:00
Annotation: Add clean up job for old annotations (#26156)
Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com> Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>
This commit is contained in:
Carl Bergquist
194
pkg/services/sqlstore/annotation_cleanup_test.go
Normal file
194
pkg/services/sqlstore/annotation_cleanup_test.go
Normal file
@ -0,0 +1,194 @@
|
||||
package sqlstore
|
||||
|
||||
import (
|
||||
"context"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/grafana/grafana/pkg/infra/log"
|
||||
"github.com/grafana/grafana/pkg/services/annotations"
|
||||
"github.com/grafana/grafana/pkg/setting"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
func TestAnnotationCleanUp(t *testing.T) {
|
||||
fakeSQL := InitTestDB(t)
|
||||
|
||||
t.Cleanup(func() {
|
||||
_ = fakeSQL.WithDbSession(context.Background(), func(session *DBSession) error {
|
||||
_, err := session.Exec("DELETE FROM annotation")
|
||||
require.Nil(t, err, "cleaning up all annotations should not cause problems")
|
||||
return err
|
||||
})
|
||||
})
|
||||
|
||||
createTestAnnotations(t, fakeSQL, 21, 6)
|
||||
assertAnnotationCount(t, fakeSQL, "", 21)
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
cfg *setting.Cfg
|
||||
alertAnnotationCount int64
|
||||
dashboardAnnotationCount int64
|
||||
APIAnnotationCount int64
|
||||
}{
|
||||
{
|
||||
name: "default settings should not delete any annotations",
|
||||
cfg: &setting.Cfg{
|
||||
AlertingAnnotationCleanupSetting: settingsFn(0, 0),
|
||||
DashboardAnnotationCleanupSettings: settingsFn(0, 0),
|
||||
APIAnnotationCleanupSettings: settingsFn(0, 0),
|
||||
},
|
||||
alertAnnotationCount: 7,
|
||||
dashboardAnnotationCount: 7,
|
||||
APIAnnotationCount: 7,
|
||||
},
|
||||
{
|
||||
name: "should remove annotations created before cut off point",
|
||||
cfg: &setting.Cfg{
|
||||
AlertingAnnotationCleanupSetting: settingsFn(time.Hour*48, 0),
|
||||
DashboardAnnotationCleanupSettings: settingsFn(time.Hour*48, 0),
|
||||
APIAnnotationCleanupSettings: settingsFn(time.Hour*48, 0),
|
||||
},
|
||||
alertAnnotationCount: 5,
|
||||
dashboardAnnotationCount: 5,
|
||||
APIAnnotationCount: 5,
|
||||
},
|
||||
{
|
||||
name: "should only keep three annotations",
|
||||
cfg: &setting.Cfg{
|
||||
AlertingAnnotationCleanupSetting: settingsFn(0, 3),
|
||||
DashboardAnnotationCleanupSettings: settingsFn(0, 3),
|
||||
APIAnnotationCleanupSettings: settingsFn(0, 3),
|
||||
},
|
||||
alertAnnotationCount: 3,
|
||||
dashboardAnnotationCount: 3,
|
||||
APIAnnotationCount: 3,
|
||||
},
|
||||
{
|
||||
name: "running the max count delete again should not remove any annotations",
|
||||
cfg: &setting.Cfg{
|
||||
AlertingAnnotationCleanupSetting: settingsFn(0, 3),
|
||||
DashboardAnnotationCleanupSettings: settingsFn(0, 3),
|
||||
APIAnnotationCleanupSettings: settingsFn(0, 3),
|
||||
},
|
||||
alertAnnotationCount: 3,
|
||||
dashboardAnnotationCount: 3,
|
||||
APIAnnotationCount: 3,
|
||||
},
|
||||
}
|
||||
|
||||
for _, test := range tests {
|
||||
t.Run(test.name, func(t *testing.T) {
|
||||
cleaner := &AnnotationCleanupService{batchSize: 1, log: log.New("test-logger")}
|
||||
err := cleaner.CleanAnnotations(context.Background(), test.cfg)
|
||||
require.NoError(t, err)
|
||||
|
||||
assertAnnotationCount(t, fakeSQL, alertAnnotationType, test.alertAnnotationCount)
|
||||
assertAnnotationCount(t, fakeSQL, dashboardAnnotationType, test.dashboardAnnotationCount)
|
||||
assertAnnotationCount(t, fakeSQL, apiAnnotationType, test.APIAnnotationCount)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestOldAnnotationsAreDeletedFirst(t *testing.T) {
|
||||
fakeSQL := InitTestDB(t)
|
||||
|
||||
t.Cleanup(func() {
|
||||
_ = fakeSQL.WithDbSession(context.Background(), func(session *DBSession) error {
|
||||
_, err := session.Exec("DELETE FROM annotation")
|
||||
require.Nil(t, err, "cleaning up all annotations should not cause problems")
|
||||
return err
|
||||
})
|
||||
})
|
||||
|
||||
//create some test annotations
|
||||
a := annotations.Item{
|
||||
DashboardId: 1,
|
||||
OrgId: 1,
|
||||
UserId: 1,
|
||||
PanelId: 1,
|
||||
AlertId: 10,
|
||||
Text: "",
|
||||
Created: time.Now().AddDate(-10, 0, -10).UnixNano() / int64(time.Millisecond),
|
||||
}
|
||||
|
||||
session := fakeSQL.NewSession()
|
||||
defer session.Close()
|
||||
|
||||
_, err := session.Insert(a)
|
||||
require.NoError(t, err, "cannot insert annotation")
|
||||
_, err = session.Insert(a)
|
||||
require.NoError(t, err, "cannot insert annotation")
|
||||
|
||||
a.AlertId = 20
|
||||
_, err = session.Insert(a)
|
||||
require.NoError(t, err, "cannot insert annotation")
|
||||
|
||||
// run the clean up task to keep one annotation.
|
||||
cleaner := &AnnotationCleanupService{batchSize: 1, log: log.New("test-logger")}
|
||||
err = cleaner.cleanAnnotations(context.Background(), setting.AnnotationCleanupSettings{MaxCount: 1}, alertAnnotationType)
|
||||
require.NoError(t, err)
|
||||
|
||||
// assert that the last annotations were kept
|
||||
countNew, err := session.Where("alert_id = 20").Count(&annotations.Item{})
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, int64(1), countNew, "the last annotations should be kept")
|
||||
|
||||
countOld, err := session.Where("alert_id = 10").Count(&annotations.Item{})
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, int64(0), countOld, "the two first annotations should have been deleted.")
|
||||
}
|
||||
|
||||
func assertAnnotationCount(t *testing.T, fakeSQL *SqlStore, sql string, expectedCount int64) {
|
||||
t.Helper()
|
||||
|
||||
session := fakeSQL.NewSession()
|
||||
defer session.Close()
|
||||
count, err := session.Where(sql).Count(&annotations.Item{})
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, expectedCount, count)
|
||||
}
|
||||
|
||||
func createTestAnnotations(t *testing.T, sqlstore *SqlStore, expectedCount int, oldAnnotations int) {
|
||||
t.Helper()
|
||||
|
||||
cutoffDate := time.Now()
|
||||
|
||||
for i := 0; i < expectedCount; i++ {
|
||||
a := &annotations.Item{
|
||||
DashboardId: 1,
|
||||
OrgId: 1,
|
||||
UserId: 1,
|
||||
PanelId: 1,
|
||||
Text: "",
|
||||
}
|
||||
|
||||
// mark every third as an API annotation
|
||||
// that doesnt belong to a dashboard
|
||||
if i%3 == 1 {
|
||||
a.DashboardId = 0
|
||||
}
|
||||
|
||||
// mark every third annotation as an alert annotation
|
||||
if i%3 == 0 {
|
||||
a.AlertId = 10
|
||||
a.DashboardId = 2
|
||||
}
|
||||
|
||||
// create epoch as int annotations.go line 40
|
||||
a.Created = cutoffDate.UnixNano() / int64(time.Millisecond)
|
||||
|
||||
// set a really old date for the first six annotations
|
||||
if i < oldAnnotations {
|
||||
a.Created = cutoffDate.AddDate(-10, 0, -10).UnixNano() / int64(time.Millisecond)
|
||||
}
|
||||
|
||||
_, err := sqlstore.NewSession().Insert(a)
|
||||
require.NoError(t, err, "should be able to save annotation", err)
|
||||
}
|
||||
}
|
||||
|
||||
func settingsFn(maxAge time.Duration, maxCount int64) setting.AnnotationCleanupSettings {
|
||||
return setting.AnnotationCleanupSettings{MaxAge: maxAge, MaxCount: maxCount}
|
||||
}
|
||||
Reference in New Issue
Block a user