Merge branch 'postmanlabs/observability-cli:main' into main (#11)

Author: liujed

cmd/internal/cmderr/checks.go

@@ -15,12 +15,12 @@ func RequirePostmanAPICredentials(explanation string) (string, error) {
 	if key == "" {
 		printer.Errorf("No Postman API key configured. %s\n", explanation)
 		if env.InDocker() {
-			printer.Infof("Please set the POSTMAN_API_KEY environment variables on the Docker command line.\n")
+			printer.Infof("Please set the POSTMAN_API_KEY environment variable on the Docker command line.\n")
 		} else {
-			printer.Infof("Use the POSTMAN_API_KEY environment variables, or run 'postman-insights-agent login'.\n")
+			printer.Infof("Please set the POSTMAN_API_KEY environment variable, either in your shell session or prepend it to postman-insights-agent command.\n")
 		}
-
-		return "", AkitaErr{Err: errors.New("could not find an Postman API key to use")}
+		//lint:ignore ST1005 This is a user-facing error message
+		return "", AkitaErr{Err: errors.New("Could not find a Postman API key to use")}
 	}
 
 	return key, nil

cmd/internal/ecs/ecs.go

@@ -150,7 +150,7 @@ func checkAPIKeyAndProjectID() error {
 		return err
 	}
 
-	// Check that a collection or project is provided.
+	// Check that project ID is provided.
 	if projectId == "" {
 		return errors.New("--project must be specified")
 	}

rest/http.go

@@ -14,6 +14,7 @@ import (
 	"github.com/pkg/errors"
 
 	"github.com/akitasoftware/akita-cli/cfg"
+	"github.com/akitasoftware/akita-cli/consts"
 	"github.com/akitasoftware/akita-cli/printer"
 	"github.com/akitasoftware/akita-cli/version"
 	"github.com/akitasoftware/akita-libs/spec_util"
@@ -22,6 +23,9 @@ import (
 const (
 	// TODO: Make this tunable.
 	defaultClientTimeout = 5 * time.Second
+	unexpectedErrMsg     = "Unexpected error occured while making request, status code: %d. " +
+		"If the issue persists, run the agent with debug logs enabled (--debug), and " +
+		"contact Postman support (" + consts.SupportEmail + ") with the error logs."
 )
 
 var (
@@ -40,7 +44,8 @@ func (he HTTPError) Error() string {
 	if he.StatusCode == 401 {
 		return `Invalid credentials. Ensure the POSTMAN_API_KEY environment variable has a valid API key for Postman.`
 	}
-	return fmt.Sprintf("received status code %d, body: %s", he.StatusCode, string(he.Body))
+	printer.Debugln("Unexpected error, received status code:", he.StatusCode, "body:", string(he.Body))
+	return fmt.Sprintf(unexpectedErrMsg, he.StatusCode)
 }
 
 // Implements retryablehttp LeveledLogger interface using printer.

util/util.go

@@ -98,7 +98,7 @@ func GetServiceIDByName(c rest.FrontClient, name string) (akid.ServiceID, error)
 }
 
 func GetServiceNameByServiceID(c rest.FrontClient, serviceID akid.ServiceID) (string, error) {
-	unexpectedErrMsg := "Something went wrong while starting the Agent. " +
+	unexpectedErrMsg := "Something went wrong while starting the agent. " +
 		"Please contact Postman support (" + consts.SupportEmail + ") with the error details"
 	failedToGetProjectErrMsg := "Failed to get project for given projectID: %s\n"
 
@@ -173,8 +173,7 @@ func GetServiceIDByPostmanCollectionID(c rest.FrontClient, ctx context.Context,
 func GetOrCreateServiceIDByPostmanCollectionID(c rest.FrontClient, collectionID string) (akid.ServiceID, error) {
 	// Normalize the collectionID.
 	collectionID = strings.ToLower(collectionID)
-	unexpectedErrMsg := "Something went wrong while starting the Agent. " +
-		"Please contact Postman support (" + consts.SupportEmail + ") with the error details"
+	unexpectedErrMsg := "Something went wrong while starting the agent."
 	failedToCreateProjectErrMsg := "Failed to create project for given collectionID: %s\n"
 
 	if id, found := postmanCollectionIDCache.Get(collectionID); found {