Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use absolute path of template to decide if we need to remove it #3604

Merged
merged 2 commits into from
Dec 8, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
* [ENHANCEMENT] Ruler: Added `-ruler.alertmanager-client.tls-enabled` configuration for alertmanager client. #3432 #3597
* [ENHANCEMENT] Activity tracker logs now have `component=activity-tracker` label. #3556
* [BUGFIX] Log the names of services that are not yet running rather than `unsupported value type` when calling `/ready` and some services are not running. #3625
* [BUGFIX] Alertmanager: Fix template spurious deletion with relative data dir. #3604

### Mixin
* [BUGFIX] Alerts: Fixed `MimirCompactorSkippedBlocksWithOutOfOrderChunks` matching on non-existent label. #3628
Expand Down
6 changes: 5 additions & 1 deletion pkg/alertmanager/multitenant.go
Original file line number Diff line number Diff line change
Expand Up @@ -635,7 +635,11 @@ func (am *MultitenantAlertmanager) setConfig(cfg alertspb.AlertConfigDesc) error
// List existing files to keep track of the ones to be removed
if oldTemplateFiles, err := os.ReadDir(userTemplateDir); err == nil {
for _, file := range oldTemplateFiles {
pathsToRemove[filepath.Join(userTemplateDir, file.Name())] = struct{}{}
templateFilePath, err := safeTemplateFilepath(userTemplateDir, file.Name())
if err != nil {
return err
}
pathsToRemove[templateFilePath] = struct{}{}
}
}

Expand Down
49 changes: 49 additions & 0 deletions pkg/alertmanager/multitenant_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,55 @@ func TestMultitenantAlertmanagerConfig_Validate(t *testing.T) {
}
}

func TestMultitenantAlertmanager_relativeDataDir(t *testing.T) {
ctx := context.Background()

// Run this test using a real storage client.
store := prepareInMemoryAlertStore()
require.NoError(t, store.SetAlertConfig(ctx, alertspb.AlertConfigDesc{
User: "user",
RawConfig: simpleConfigOne + `
templates:
- 'first.tpl'
- 'second.tpl'
`,
Templates: []*alertspb.TemplateDesc{
{
Filename: "first.tpl",
Body: `{{ define "t1" }}Template 1 ... {{end}}`,
},
{
Filename: "second.tpl",
Body: `{{ define "t2" }}Template 2{{ end}}`,
},
},
}))

reg := prometheus.NewPedanticRegistry()
cfg := mockAlertmanagerConfig(t)
// Alter datadir to get a relative path
cwd, err := os.Getwd()
require.NoError(t, err)
cfg.DataDir, err = filepath.Rel(cwd, cfg.DataDir)
require.NoError(t, err)
am := setupSingleMultitenantAlertmanager(t, cfg, store, nil, log.NewNopLogger(), reg)

// Ensure the configs are synced correctly and persist across several syncs
for i := 0; i < 3; i++ {
err := am.loadAndSyncConfigs(context.Background(), reasonPeriodic)
require.NoError(t, err)
require.Len(t, am.alertmanagers, 1)

dirs := am.getPerUserDirectories()
userDir := dirs["user"]
require.NotZero(t, userDir)
require.True(t, dirExists(t, userDir))
require.True(t, dirExists(t, filepath.Join(userDir, templatesDir)))
require.True(t, fileExists(t, filepath.Join(userDir, templatesDir, "first.tpl")))
require.True(t, fileExists(t, filepath.Join(userDir, templatesDir, "second.tpl")))
}
}

func TestMultitenantAlertmanager_loadAndSyncConfigs(t *testing.T) {
ctx := context.Background()

Expand Down