[POA-1415] Re-enable support for EC2 commands (#20)

In this PR, we are re-enabling support for EC2 in our agent.
Changes done:
* Replaced `--collection` flag with `--project` in EC2 command
* Added a base`ec2` command since the `setup` command can be confusing.
* So `postman-insights-agent setup ...` -> `postman-insights-agent ec2
setup ...`
  * Only `ec2` command also defaults to `ec2 setup`
* Moved the `CheckAPIKeyAndInsightsProjectID` function out from `ecs.go`
to `check.go`
* Other small syntactic or typo changes

Author: mudit-postman

cmd/internal/cmderr/checks.go

@@ -1,11 +1,14 @@
 package cmderr
 
 import (
-	"errors"
-
+	"github.com/akitasoftware/akita-libs/akid"
+	"github.com/pkg/errors"
 	"github.com/postmanlabs/postman-insights-agent/cfg"
 	"github.com/postmanlabs/postman-insights-agent/env"
 	"github.com/postmanlabs/postman-insights-agent/printer"
+	"github.com/postmanlabs/postman-insights-agent/rest"
+	"github.com/postmanlabs/postman-insights-agent/telemetry"
+	"github.com/postmanlabs/postman-insights-agent/util"
 )
 
 // Checks that a user has configured their Postman API key and returned them.
@@ -19,9 +22,37 @@ func RequirePostmanAPICredentials(explanation string) (string, error) {
 		} else {
 			printer.Infof("Please set the POSTMAN_API_KEY environment variable, either in your shell session or prepend it to postman-insights-agent command.\n")
 		}
-		//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
 }
+
+// Checks that an API key and a project ID are provided, and that the API key is
+// valid for the project ID.
+func CheckAPIKeyAndInsightsProjectID(projectID string) error {
+	// Check for API key.
+	_, err := RequirePostmanAPICredentials("The Postman Insights Agent must have an API key in order to capture traces.")
+	if err != nil {
+		return err
+	}
+
+	// Check that project ID is provided.
+	if projectID == "" {
+		return errors.New("project ID is missing, it must be specified")
+	}
+
+	frontClient := rest.NewFrontClient(rest.Domain, telemetry.GetClientID())
+	var serviceID akid.ServiceID
+	err = akid.ParseIDAs(projectID, &serviceID)
+	if err != nil {
+		return errors.Wrap(err, "failed to parse project ID")
+	}
+
+	_, err = util.GetServiceNameByServiceID(frontClient, serviceID)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}

cmd/internal/ec2/README.md

@@ -14,7 +14,7 @@
 
 - Log in as root user, or use `sudo su` to enable root before running the below command
 ```
-POSTMAN_API_KEY=<postman-api-key> postman-insights-agent setup --collection <postman-collectionID>
+POSTMAN_API_KEY=<postman-api-key> postman-insights-agent ec2 --project <postman-insights-project-id>
 ```
 
 To check the status or logs please use

cmd/internal/ec2/add.go

@@ -47,7 +47,7 @@ func reportStep(stepName string) {
 	telemetry.WorkflowStep("Starting systemd conguration", stepName)
 }
 
-func setupAgentForServer(collectionId string) error {
+func setupAgentForServer(projectID string) error {
 
 	err := checkUserPermissions()
 	if err != nil {
@@ -58,12 +58,12 @@ func setupAgentForServer(collectionId string) error {
 		return err
 	}
 
-	err = configureSystemdFiles(collectionId)
+	err = configureSystemdFiles(projectID)
 	if err != nil {
 		return err
 	}
 
-	err = enablePostmanAgent()
+	err = enablePostmanInsightsAgent()
 	if err != nil {
 		return err
 	}
@@ -75,11 +75,17 @@ func askToReconfigure() error {
 	var isReconfigure bool
 
 	printer.Infof("postman-insights-agent is already present as a systemd service\n")
-	printer.Infof("Helpful commands \n Check status: systemctl status postman-insights-agent \n Disable agent: systemctl disable --now postman-insights-agent \n Check Logs: journalctl -fu postman-insights-agent\n Check env file: cat %s \n Check systemd service file: cat %s \n", envFilePath, serviceFilePath)
+	printer.Infof("Helpful commands\n"+
+		"Check status: systemctl status postman-insights-agent\n"+
+		"Disable agent: systemctl disable --now postman-insights-agent\n"+
+		"Check Logs: journalctl -fu postman-insights-agent\n"+
+		"Check env file: cat %s\n"+
+		"Check systemd service file: cat %s\n",
+		envFilePath, serviceFilePath)
 
 	err := survey.AskOne(
 		&survey.Confirm{
-			Message: "Overwrite old API key and Collection ID values in systemd configuration file with current values?",
+			Message: "Overwrite old API key and Project ID values in systemd configuration file with current values?",
 			Default: true,
 			Help:    "Any edits made to systemd configuration files will be over-written.",
 		},
@@ -119,7 +125,7 @@ func checkReconfiguration() error {
 	if strings.Contains(string(out), enabled) {
 		return askToReconfigure()
 	}
-	return errors.Errorf("The systemctl is-enabled command produced output this tool doesn't recognize: %q.\nPlease send this log message to %s for assistance\n", string(out), consts.SupportEmail)
+	return errors.Errorf("The systemctl is-enabled command produced output the agent doesn't recognize: %q.\nPlease send this log message to %s for assistance\n", string(out), consts.SupportEmail)
 
 }
 
@@ -155,7 +161,7 @@ func checkSystemdExists() error {
 	return nil
 }
 
-func configureSystemdFiles(collectionId string) error {
+func configureSystemdFiles(projectID string) error {
 	message := "Configuring systemd files"
 	printer.Infof(message + "\n")
 	reportStep(message)
@@ -165,19 +171,18 @@ func configureSystemdFiles(collectionId string) error {
 		return err
 	}
 
-	// Write collectionId and postman-api-key to go template file
-
+	// Write projectID and Postman API Key to go template file
 	tmpl, err := template.ParseFS(envFileFS, envFileTemplateName)
 	if err != nil {
 		return errors.Wrapf(err, "systemd env file parsing failed")
 	}
 
 	data := struct {
 		PostmanAPIKey string
-		CollectionId  string
+		ProjectID     string
 	}{
 		PostmanAPIKey: os.Getenv("POSTMAN_API_KEY"),
-		CollectionId:  collectionId,
+		ProjectID:     projectID,
 	}
 
 	// Ensure /etc/default exists
@@ -216,7 +221,7 @@ func configureSystemdFiles(collectionId string) error {
 }
 
 // Starts the Postman Insights Agent as a systemd service
-func enablePostmanAgent() error {
+func enablePostmanInsightsAgent() error {
 	message := "Enabling postman-insights-agent as a service"
 	reportStep(message)
 	printer.Infof(message + "\n")
@@ -230,7 +235,7 @@ func enablePostmanAgent() error {
 	cmd = exec.Command("systemctl", []string{"enable", "--now", serviceFileName}...)
 	_, err = cmd.CombinedOutput()
 	if err != nil {
-		return errors.Wrapf(err, "faild to run systemctl enable --now")
+		return errors.Wrapf(err, "failed to run systemctl enable --now")
 	}
 	printer.Infof("Postman Insights Agent enabled as a systemd service. Please check logs using the below command \n")
 	printer.Infof("journalctl -fu postman-insights-agent \n")

cmd/internal/ec2/ec2.go

@@ -3,24 +3,28 @@ package ec2
 import (
 	"fmt"
 
-	"github.com/pkg/errors"
 	"github.com/postmanlabs/postman-insights-agent/cmd/internal/cmderr"
-	"github.com/postmanlabs/postman-insights-agent/rest"
-	"github.com/postmanlabs/postman-insights-agent/telemetry"
-	"github.com/postmanlabs/postman-insights-agent/util"
 	"github.com/spf13/cobra"
 )
 
 var (
-	// Mandatory flag: Postman collection id
-	collectionId string
+	// Postman Insights project id
+	projectID string
 )
 
 var Cmd = &cobra.Command{
-	Deprecated:   "This is no longer supported and might be removed in a future release.",
+	Use:          "ec2",
+	Short:        "Add the Postman Insights Agent to the EC2 server.",
+	Long:         "The CLI will add the Postman Insights Agent as a systemd service to your current EC2 server.",
+	SilenceUsage: true,
+	RunE:         addAgentToEC2,
+}
+
+// 'postman-insights-agent ec2' should default to 'postman-insights-agent ec2 setup'
+var SetupInEC2Cmd = &cobra.Command{
 	Use:          "setup",
-	Short:        "Add the Postman Insights Agent to the current server.",
-	Long:         "The CLI will add the Postman Insights Agent as a systemd service to your current server.",
+	Short:        Cmd.Short,
+	Long:         Cmd.Long,
 	SilenceUsage: true,
 	RunE:         addAgentToEC2,
 }
@@ -37,30 +41,21 @@ var RemoveFromEC2Cmd = &cobra.Command{
 }
 
 func init() {
-	Cmd.PersistentFlags().StringVar(&collectionId, "collection", "", "Your Postman collection ID")
-	Cmd.MarkPersistentFlagRequired("collection")
+	Cmd.PersistentFlags().StringVar(&projectID, "project", "", "Your Insights Project ID")
+	Cmd.MarkPersistentFlagRequired("project")
 
+	Cmd.AddCommand(SetupInEC2Cmd)
 	Cmd.AddCommand(RemoveFromEC2Cmd)
 }
 
 func addAgentToEC2(cmd *cobra.Command, args []string) error {
-	// Check for API key
-	_, err := cmderr.RequirePostmanAPICredentials("The Postman Insights Agent must have an API key in order to capture traces.")
-	if err != nil {
-		return err
-	}
-
-	// Check collecton Id's existence
-	if collectionId == "" {
-		return errors.New("Must specify the ID of your collection with the --collection flag.")
-	}
-	frontClient := rest.NewFrontClient(rest.Domain, telemetry.GetClientID())
-	_, err = util.GetOrCreateServiceIDByPostmanCollectionID(frontClient, collectionId)
+	// Check if the API key and Insights project ID are valid
+	err := cmderr.CheckAPIKeyAndInsightsProjectID(projectID)
 	if err != nil {
 		return err
 	}
 
-	return setupAgentForServer(collectionId)
+	return setupAgentForServer(projectID)
 }
 
 func removeAgentFromEC2(cmd *cobra.Command, args []string) error {

cmd/internal/ec2/postman-insights-agent.service

@@ -8,7 +8,7 @@ EnvironmentFile=/etc/default/postman-insights-agent
 # DO NOT CHANGE
 # "${FOO}" uses the arguement as is, while "$FOO" splits the string on white space 
 # Reference: https://www.freedesktop.org/software/systemd/man/systemd.service.html#Command%20lines
-ExecStart=/usr/bin/postman-insights-agent apidump --collection "${COLLECTION_ID}" --interfaces "${INTERFACES}" --filter "${FILTER}" "$EXTRA_APIDUMP_ARGS"
+ExecStart=/usr/bin/postman-insights-agent apidump --project "${PROJECT_ID}" --interfaces "${INTERFACES}" --filter "${FILTER}" "$EXTRA_APIDUMP_ARGS"
 
 [Install]
 WantedBy=multi-user.target

cmd/internal/ec2/postman-insights-agent.tmpl

@@ -1,25 +1,26 @@
 # Add your Postman API key below. For example:
 #
-#   POSTMAN_API_KEY=PMAC-XXXXXXX
+#   POSTMAN_API_KEY=PMAK-XXXXXXX
 #
 # This is required.
 
 POSTMAN_API_KEY={{.PostmanAPIKey}}
 
 
-# Add your your Postman Collection ID. 
-#This is required.
-
-COLLECTION_ID={{.CollectionId}}
+# Add your your Postman Project ID. 
+#
+#   PROJECT_ID=svc_XXXXXXX
+#
+# This is required.
 
-# For example,
-#   COLLECTION_ID=1234567-890abcde-f123-4567-890a-bcdef1234567
+PROJECT_ID={{.ProjectID}}
 
 
 # INTERFACES is optional. If left blank, the agent will listen on all available
 # network interfaces.
 #
 # FILTER is optional. If left blank, no packet-capture filter will be applied.
+# 
 # For example
 #   INTERFACES=lo,eth0,eth1
 #   FILTER="port 80 or port 8080"

cmd/internal/ecs/ecs.go

@@ -3,7 +3,6 @@ package ecs
 import (
 	"fmt"
 
-	"github.com/akitasoftware/akita-libs/akid"
 	"github.com/akitasoftware/go-utils/optionals"
 	"github.com/aws/aws-sdk-go-v2/aws"
 	"github.com/aws/aws-sdk-go-v2/service/ecs/types"
@@ -12,9 +11,6 @@ import (
 	ecs_cloudformation_utils "github.com/postmanlabs/postman-insights-agent/aws_utils/cloudformation/ecs"
 	ecs_console_utils "github.com/postmanlabs/postman-insights-agent/aws_utils/console/ecs"
 	"github.com/postmanlabs/postman-insights-agent/cmd/internal/cmderr"
-	"github.com/postmanlabs/postman-insights-agent/rest"
-	"github.com/postmanlabs/postman-insights-agent/telemetry"
-	"github.com/postmanlabs/postman-insights-agent/util"
 	"github.com/spf13/cobra"
 )
 
@@ -141,37 +137,9 @@ func init() {
 	Cmd.AddCommand(RemoveFromECSCmd)
 }
 
-// Checks that an API key and a project ID are provided, and that the API key is
-// valid for the project ID.
-func checkAPIKeyAndProjectID() error {
-	// Check for API key.
-	_, err := cmderr.RequirePostmanAPICredentials("The Postman Insights Agent must have an API key in order to capture traces.")
-	if err != nil {
-		return err
-	}
-
-	// Check that project ID is provided.
-	if projectId == "" {
-		return errors.New("--project must be specified")
-	}
-
-	frontClient := rest.NewFrontClient(rest.Domain, telemetry.GetClientID())
-	var serviceID akid.ServiceID
-	err = akid.ParseIDAs(projectId, &serviceID)
-	if err != nil {
-		return errors.Wrap(err, "failed to parse service ID")
-	}
-
-	_, err = util.GetServiceNameByServiceID(frontClient, serviceID)
-	if err != nil {
-		return err
-	}
-
-	return nil
-}
-
 func addAgentToECS(cmd *cobra.Command, args []string) error {
-	err := checkAPIKeyAndProjectID()
+	// Check if the API key and Insights project ID are valid
+	err := cmderr.CheckAPIKeyAndInsightsProjectID(projectId)
 	if err != nil {
 		return err
 	}
@@ -184,7 +152,7 @@ func removeAgentFromECS(cmd *cobra.Command, args []string) error {
 }
 
 func printCloudFormationFragment(cmd *cobra.Command, args []string) error {
-	err := checkAPIKeyAndProjectID()
+	err := cmderr.CheckAPIKeyAndInsightsProjectID(projectId)
 	if err != nil {
 		return err
 	}
@@ -211,7 +179,7 @@ func printCloudFormationFragment(cmd *cobra.Command, args []string) error {
 }
 
 func printECSTaskDefinition(cmd *cobra.Command, args []string) error {
-	err := checkAPIKeyAndProjectID()
+	err := cmderr.CheckAPIKeyAndInsightsProjectID(projectId)
 	if err != nil {
 		return err
 	}