[extension/sumologicextension] removing collector name from credential path for sumologic

.chloggen/sumologicextension-v2-credentials.yaml

@@ -0,0 +1,27 @@
+# Use this changelog template to create an entry for release notes.
+
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: enhancement
+
+# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
+component: extension/SumologicExtension
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: "removing collector name from credential path for sumologic extension"
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [42511]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext:
+
+# If your change doesn't affect end users or the exported elements of any package,
+# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
+# Optional: The change log or logs in which this entry should be included.
+# e.g. '[user]' or '[user, api]'
+# Include 'user' if the change is relevant to end users.
+# Include 'api' if there is a change to a library API.
+# Default: '[user]'
+change_logs: []

extension/sumologicextension/extension.go

@@ -61,10 +61,11 @@ type SumologicExtension struct {
 	stickySessionCookieLock sync.RWMutex
 	stickySessionCookie     string
 
-	closeChan chan struct{}
-	closeOnce sync.Once
-	backOff   *backoff.ExponentialBackOff
-	id        component.ID
+	closeChan            chan struct{}
+	closeOnce            sync.Once
+	backOff              *backoff.ExponentialBackOff
+	id                   component.ID
+	collectorCredentials credentials.CollectorCredentials
 }
 
 const (
@@ -129,7 +130,16 @@ func newSumologicExtension(conf *Config, logger *zap.Logger, id component.ID, bu
 	var (
 		collectorName string
 		hashKey       = createHashKey(conf)
+		hashKeyV2     = createHashKeyV2(conf)
 	)
+
+	_, err = credentialsStore.Get(hashKeyV2)
+	if err != nil {
+		logger.Info("credentials not found, trying legacy credentials", zap.Error(err))
+	} else {
+		logger.Debug("v2 credentials found")
+		hashKey = hashKeyV2
+	}
 	if conf.CollectorName == "" {
 		// If collector name is not set by the user, check if the collector was restarted
 		// and that we can reuse collector name save in credentials store.
@@ -178,6 +188,13 @@ func createHashKey(conf *Config) string {
 	)
 }
 
+func createHashKeyV2(conf *Config) string {
+	return fmt.Sprintf("%s%s",
+		conf.Credentials.InstallationToken,
+		strings.TrimSuffix(conf.APIBaseURL, "/"),
+	)
+}
+
 func (se *SumologicExtension) Start(ctx context.Context, host component.Host) error {
 	var err error
 	se.host = host
@@ -191,6 +208,7 @@ func (se *SumologicExtension) Start(ctx context.Context, host component.Host) er
 	}
 
 	colCreds, err := se.getCredentials(ctx)
+	se.collectorCredentials = colCreds
 	if err != nil {
 		return err
 	}
@@ -218,8 +236,18 @@ func (se *SumologicExtension) Start(ctx context.Context, host component.Host) er
 	return nil
 }
 
-// Shutdown is invoked during service shutdown.
 func (se *SumologicExtension) Shutdown(ctx context.Context) error {
+	hashKeyV2 := createHashKeyV2(se.conf)
+	_, err := se.credentialsStore.Get(hashKeyV2)
+	se.logger.Debug("Shutting down Sumo Logic extension migrating to hashkeyV2 ")
+	if err != nil {
+		se.logger.Warn("Failed to get collector v2 credentials on shutdown, migrating to v2", zap.Error(err))
+		err := se.credentialsStore.Store(hashKeyV2, se.collectorCredentials)
+		if err != nil {
+			se.logger.Warn("Failed to migrate collector credentials to v2 on shutdown", zap.Error(err))
+		}
+	}
+
 	se.closeOnce.Do(func() { close(se.closeChan) })
 	select {
 	case <-ctx.Done():

extension/sumologicextension/extension_test.go

@@ -375,6 +375,92 @@ func TestStoreCredentials_PreexistingCredentialsAreUsed(t *testing.T) {
 	require.EqualValues(t, 2, atomic.LoadInt32(&reqCount))
 }
 
+func TestStoreCredentials_V2CredentialsAreUsed(t *testing.T) {
+	t.Parallel()
+
+	getServer := func() *httptest.Server {
+		return httptest.NewServer(http.HandlerFunc(
+			func(w http.ResponseWriter, req *http.Request) {
+				switch req.URL.Path {
+				case heartbeatURL:
+					w.WriteHeader(http.StatusNoContent)
+				case metadataURL:
+					w.WriteHeader(http.StatusOK)
+				default:
+					w.WriteHeader(http.StatusInternalServerError)
+				}
+			}))
+	}
+
+	getConfig := func(url string) *Config {
+		cfg := createDefaultConfig().(*Config)
+		cfg.CollectorName = "collector_name"
+		cfg.APIBaseURL = url
+		cfg.Credentials.InstallationToken = "dummy_install_token"
+		return cfg
+	}
+
+	logger, err := zap.NewDevelopment()
+	require.NoError(t, err)
+
+	dir := t.TempDir()
+	t.Logf("Using dir: %s", dir)
+
+	store, err := credentials.NewLocalFsStore(
+		credentials.WithCredentialsDirectory(dir),
+		credentials.WithLogger(logger),
+	)
+	require.NoError(t, err)
+
+	srv := getServer()
+	t.Cleanup(func() { srv.Close() })
+
+	cfg := getConfig(srv.URL)
+	cfg.CollectorCredentialsDirectory = dir
+
+	hashKey := createHashKey(cfg)
+
+	require.NoError(t,
+		store.Store(hashKey, credentials.CollectorCredentials{
+			CollectorName: "collector_name",
+			Credentials: api.OpenRegisterResponsePayload{
+				CollectorCredentialID:  "collectorId",
+				CollectorCredentialKey: "collectorKey",
+				CollectorID:            "id",
+			},
+		}),
+	)
+
+	se, err := newSumologicExtension(cfg, logger, component.NewID(metadata.Type), "1.0.0")
+	require.NoError(t, err)
+
+	fileName, err := credentials.HashKeyToFilename(hashKey)
+	require.NoError(t, err)
+	credsPath := path.Join(dir, fileName)
+	// Credentials file exists before starting the extension because we created
+	// it directly via store.Store()
+	require.FileExists(t, credsPath)
+
+	require.NoError(t, se.Start(t.Context(), componenttest.NewNopHost()))
+	require.NoError(t, se.Shutdown(t.Context()))
+	require.FileExists(t, credsPath)
+	hashKeyV2 := createHashKeyV2(cfg)
+	v2Creds, _ := store.Get(hashKeyV2)
+
+	fileName, err = credentials.HashKeyToFilename(hashKeyV2)
+	require.NoError(t, err)
+	credsPath = path.Join(dir, fileName)
+	require.Equal(t, credentials.CollectorCredentials{
+		CollectorName: "collector_name",
+		Credentials: api.OpenRegisterResponsePayload{
+			CollectorCredentialID:  "collectorId",
+			CollectorCredentialKey: "collectorKey",
+			CollectorID:            "id",
+		},
+	}, v2Creds)
+	require.FileExists(t, credsPath)
+}
+
 func TestLocalFSCredentialsStore_WorkCorrectlyForMultipleExtensions(t *testing.T) {
 	t.Parallel()