Add helpful logs for some common mistakes

pganalyze · Nov 8, 2023 · 3b9c8b7 · 3b9c8b7
1 parent b366c7f
commit 3b9c8b7
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/config/read.go b/config/read.go
@@ -696,6 +696,9 @@ func Read(logger *util.Logger, filename string) (Config, error) {
 			config.SystemID, config.SystemType, config.SystemScope, config.SystemIDFallback, config.SystemTypeFallback, config.SystemScopeFallback = identifySystem(*config)
 			conf.Servers = append(conf.Servers, *config)
 		} else {
+			if os.Getenv("API_KEY") != "" {
+				logger.PrintInfo("Environment variable API_KEY was found, but not PGA_API_KEY. Please double check the variable name")
+			}
 			return conf, fmt.Errorf("No configuration file found at %s, and no environment variables set", filename)
 		}
 	}

diff --git a/runner/logs.go b/runner/logs.go
@@ -397,8 +397,12 @@ func TestLogsForAllServers(ctx context.Context, servers []*state.Server, globalC
 			}
 		} else if server.Config.SupportsLogDownload() {
 			success = testLogDownload(ctx, &wg, server, globalCollectionOpts, prefixedLogger)
-		} else if server.Config.AzureDbServerName != "" && server.Config.AzureEventhubNamespace != "" && server.Config.AzureEventhubName != "" {
-			success = testAzureLogStream(ctx, &wg, server, globalCollectionOpts, prefixedLogger)
+		} else if server.Config.AzureEventhubNamespace != "" && server.Config.AzureEventhubName != "" {
+			if server.Config.AzureDbServerName == "" {
+				prefixedLogger.PrintError("ERROR - Detected Azure Event Hub setup but azure_db_server_name is not set")
+			} else {
+				success = testAzureLogStream(ctx, &wg, server, globalCollectionOpts, prefixedLogger)
+			}
 		} else if server.Config.GcpCloudSQLInstanceID != "" && server.Config.GcpPubsubSubscription != "" {
 			success = testGoogleCloudsqlLogStream(ctx, &wg, server, globalCollectionOpts, prefixedLogger)
 		}