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.

Sign up for GitHub

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

Jump to bottom

Remove obsolete state migration step in AM #5710

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Remove obsolete state migration step in AM #5710

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
121 changes: 1 addition & 120 deletions pkg/alertmanager/multitenant.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ import (
amconfig "github.com/prometheus/alertmanager/config"
"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/client_golang/prometheus/promauto"
tsdb_errors "github.com/prometheus/prometheus/tsdb/errors"
"github.com/weaveworks/common/httpgrpc"
"github.com/weaveworks/common/httpgrpc/server"
"github.com/weaveworks/common/user"
Expand Down Expand Up @@ -457,11 +456,6 @@ func (h *handlerForGRPCServer) ServeHTTP(w http.ResponseWriter, req *http.Reques
}

func (am *MultitenantAlertmanager) starting(ctx context.Context) (err error) {
err = am.migrateStateFilesToPerTenantDirectories()
if err != nil {
return err
}

defer func() {
if err == nil || am.subservices == nil {
return
Expand Down Expand Up @@ -534,119 +528,6 @@ func (am *MultitenantAlertmanager) starting(ctx context.Context) (err error) {
return nil
}

// migrateStateFilesToPerTenantDirectories migrates any existing configuration from old place to new hierarchy.
// TODO: Remove in Cortex 1.11.
func (am *MultitenantAlertmanager) migrateStateFilesToPerTenantDirectories() error {
migrate := func(from, to string) error {
level.Info(am.logger).Log("msg", "migrating alertmanager state", "from", from, "to", to)
err := os.Rename(from, to)
return errors.Wrapf(err, "failed to migrate alertmanager state from %v to %v", from, to)
}

st, err := am.getObsoleteFilesPerUser()
if err != nil {
return errors.Wrap(err, "failed to migrate alertmanager state files")
}

for userID, files := range st {
tenantDir := am.getTenantDirectory(userID)
err := os.MkdirAll(tenantDir, 0777)
if err != nil {
return errors.Wrapf(err, "failed to create per-tenant directory %v", tenantDir)
}

errs := tsdb_errors.NewMulti()

if files.notificationLogSnapshot != "" {
errs.Add(migrate(files.notificationLogSnapshot, filepath.Join(tenantDir, notificationLogSnapshot)))
}

if files.silencesSnapshot != "" {
errs.Add(migrate(files.silencesSnapshot, filepath.Join(tenantDir, silencesSnapshot)))
}

if files.templatesDir != "" {
errs.Add(migrate(files.templatesDir, filepath.Join(tenantDir, templatesDir)))
}

if err := errs.Err(); err != nil {
return err
}
}
return nil
}

type obsoleteStateFiles struct {
notificationLogSnapshot string
silencesSnapshot string
templatesDir string
}

// getObsoleteFilesPerUser returns per-user set of files that should be migrated from old structure to new structure.
func (am *MultitenantAlertmanager) getObsoleteFilesPerUser() (map[string]obsoleteStateFiles, error) {
files, err := os.ReadDir(am.cfg.DataDir)
if err != nil {
return nil, errors.Wrapf(err, "failed to list dir %v", am.cfg.DataDir)
}

// old names
const (
notificationLogPrefix = "nflog:"
silencesPrefix = "silences:"
templates = "templates"
)

result := map[string]obsoleteStateFiles{}

for _, f := range files {
fullPath := filepath.Join(am.cfg.DataDir, f.Name())

if f.IsDir() {
// Process templates dir.
if f.Name() != templates {
// Ignore other files -- those are likely per tenant directories.
continue
}

templateDirs, err := os.ReadDir(fullPath)
if err != nil {
return nil, errors.Wrapf(err, "failed to list dir %v", fullPath)
}

// Previously templates directory contained per-tenant subdirectory.
for _, d := range templateDirs {
if d.IsDir() {
v := result[d.Name()]
v.templatesDir = filepath.Join(fullPath, d.Name())
result[d.Name()] = v
} else {
level.Warn(am.logger).Log("msg", "ignoring unknown local file while migrating local alertmanager state files", "file", filepath.Join(fullPath, d.Name()))
}
}
continue
}

switch {
case strings.HasPrefix(f.Name(), notificationLogPrefix):
userID := strings.TrimPrefix(f.Name(), notificationLogPrefix)
v := result[userID]
v.notificationLogSnapshot = fullPath
result[userID] = v

case strings.HasPrefix(f.Name(), silencesPrefix):
userID := strings.TrimPrefix(f.Name(), silencesPrefix)
v := result[userID]
v.silencesSnapshot = fullPath
result[userID] = v

default:
level.Warn(am.logger).Log("msg", "ignoring unknown local data file while migrating local alertmanager state files", "file", fullPath)
}
}

return result, nil
}

func (am *MultitenantAlertmanager) run(ctx context.Context) error {
tick := time.NewTicker(am.cfg.PollInterval)
defer tick.Stop()
Expand Down Expand Up @@ -1297,7 +1178,7 @@ func (am *MultitenantAlertmanager) getPerUserDirectories() map[string]string {
return result
}

// UpdateState implements the Alertmanager service.
// ReadState implements the Alertmanager service.
func (am *MultitenantAlertmanager) ReadState(ctx context.Context, req *alertmanagerpb.ReadStateRequest) (*alertmanagerpb.ReadStateResponse, error) {
userID, err := tenant.TenantID(ctx)
if err != nil {
Expand Down
33 changes: 0 additions & 33 deletions pkg/alertmanager/multitenant_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -561,39 +561,6 @@ receivers:
}
}

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

const (
user1 = "user1"
user2 = "user2"
)

store := prepareInMemoryAlertStore()
require.NoError(t, store.SetAlertConfig(ctx, alertspb.AlertConfigDesc{
User: user2,
RawConfig: simpleConfigOne,
Templates: []*alertspb.TemplateDesc{},
}))

reg := prometheus.NewPedanticRegistry()
cfg := mockAlertmanagerConfig(t)
am, err := createMultitenantAlertmanager(cfg, nil, nil, store, nil, nil, log.NewNopLogger(), reg)
require.NoError(t, err)

createFile(t, filepath.Join(cfg.DataDir, "nflog:"+user1))
createFile(t, filepath.Join(cfg.DataDir, "silences:"+user1))
createFile(t, filepath.Join(cfg.DataDir, "nflog:"+user2))
createFile(t, filepath.Join(cfg.DataDir, "templates", user2, "template.tpl"))

require.NoError(t, am.migrateStateFilesToPerTenantDirectories())
require.True(t, fileExists(t, filepath.Join(cfg.DataDir, user1, notificationLogSnapshot)))
require.True(t, fileExists(t, filepath.Join(cfg.DataDir, user1, silencesSnapshot)))
require.True(t, fileExists(t, filepath.Join(cfg.DataDir, user2, notificationLogSnapshot)))
require.True(t, dirExists(t, filepath.Join(cfg.DataDir, user2, templatesDir)))
require.True(t, fileExists(t, filepath.Join(cfg.DataDir, user2, templatesDir, "template.tpl")))
}

func fileExists(t *testing.T, path string) bool {
return checkExists(t, path, false)
}
Expand Down
Loading