[POA-860] Replace postman lc with postman insights (#256)

Done changes acc to this:
https://postmanlabs.atlassian.net/wiki/spaces/PO/pages/4911792297/Plan+Agent+rebranding#User-visible-strings-in-the-binary

---------

Co-authored-by: Jed Liu <[email protected]>

Author: mudit-postman

.github/workflows/security-scan.yaml

@@ -11,6 +11,5 @@ jobs:
    name: Security Scan Job
    uses: postmanlabs/gh-security-scan-workflow/.github/workflows/[email protected]
    with: 
-     imagename: postman-lc-agent
+     imagename: postman-insights-agent
      language: "['go']"
-  

.gitignore

@@ -4,7 +4,7 @@
 *.dll
 *.so
 *.dylib
-postman-lc-agent
+postman-insights-agent
 bin/
 
 # Test binary, built with `go test -c`

Makefile

@@ -3,7 +3,7 @@
 export GO111MODULE = on
 
 build: clean
-	go build -o bin/postman-lc-agent .
+	go build -o bin/postman-insights-agent .
 
 clean:
 	go clean

apidump/net.go

@@ -47,7 +47,7 @@ func showPermissionErrors(sampleError error) error {
 				printer.Warningf("It might be that you are in a PaaS that disallows packet capture, or the local configuration has disabled that privilege by default.\n")
 				return NewApidumpError(api_schema.ApidumpError_PCAPPermission, "Insufficient permissions in container.")
 			} else {
-				printer.Warningf("Although you are running as root, the Postman Live Collections Agent lacks the CAP_NET_RAW capability.\n")
+				printer.Warningf("Although you are running as root, the Postman Insights Agent lacks the CAP_NET_RAW capability.\n")
 				printer.Warningf("It might be that you are in a restricted environment which disallows packet capture, even as the root user.\n")
 				return NewApidumpError(api_schema.ApidumpError_PCAPPermission, "Insufficient permissions.")
 			}
@@ -63,23 +63,23 @@ func showPermissionErrors(sampleError error) error {
 
 		printer.Warningf(
 			"The agent received \"Function not implemented\" when trying to read from your network interfaces. "+
-				"This often indicates that the Postman Live Collections Agent was built for a different architecture than your host architecture. "+
-				"This Postman Live Collections Agent binary was built for %s.\n",
+				"This often indicates that the Postman Insights Agent was built for a different architecture than your host architecture. "+
+				"This Postman Insights Agent binary was built for %s.\n",
 			arch,
 		)
 
 		if env.InDocker() {
 			return NewApidumpErrorf(
 				api_schema.ApidumpError_PCAPInterfaceNotImplemented,
 				"Unable to read network interfaces. If your host architecture is not %s, try using "+
-					"`docker pull --platform $YOUR_ARCHITECTURE docker.postman.com/postman-lc-agent:latest` to pull a Postman Live Collections Agent "+
+					"`docker pull --platform $YOUR_ARCHITECTURE docker.postman.com/postman-insights-agent:latest` to pull a Postman Insights Agent "+
 					"built for your architecture.",
 				arch,
 			)
 		} else {
 			return NewApidumpErrorf(
 				api_schema.ApidumpError_PCAPInterfaceNotImplemented,
-				"Unable to read network interfaces. If your host architecture is not %s, try using the Postman Live Collections Agent install script: `bash -c \"$(curl -L https://releases.observability.postman.com/scripts/install-postman-lc-agent.sh)\"`",
+				"Unable to read network interfaces. If your host architecture is not %s, try using the Postman Insights Agent install script: `bash -c \"$(curl -L https://releases.observability.postman.com/scripts/install-postman-insights-agent.sh)\"`",
 				arch,
 			)
 		}

apidump/summary.go

@@ -301,7 +301,7 @@ func (s *Summary) PrintWarnings() {
 				s.PrefilterSummary.Total().HTTPRequests)
 		}
 		if env.InDocker() && env.HasDockerInternalHostAddress() {
-			printer.Stderr.Infof("If you're using macOS and your service is not running in a Docker container, try using the native Postman Live Collections Agent with `brew install postman-lc-agent`.\n")
+			printer.Stderr.Infof("If you're using macOS and your service is not running in a Docker container, try using the native Postman Insights Agent with `brew install postman-insights-agent`.\n")
 		}
 		printer.Stderr.Errorf("%s 🛑\n\n", printer.Color.Red("No HTTP calls captured!"))
 		return

apispec/har.go

@@ -31,7 +31,7 @@ func ProcessHAR(col trace.Collector, p string) (int, error) {
 	if errs.TotalCount > 0 {
 		entriesCount := len(harContent.Log.Entries)
 		printer.Stderr.Warningf("Encountered errors with %d HAR file entries.\n", entriesCount-successCount)
-		printer.Stderr.Warningf("Postman Live Insights will ignore entries with errors and generate a spec from the %d entries successfully processed.\n", successCount)
+		printer.Stderr.Warningf("Postman Insights will ignore entries with errors and generate a spec from the %d entries successfully processed.\n", successCount)
 
 		printer.Stderr.Warningf("Sample errors:\n")
 		for _, e := range errs.Samples {

cmd/internal/cmderr/checks.go

@@ -35,7 +35,7 @@ func RequirePostmanAPICredentials(explanation string) (string, error) {
 		if env.InDocker() {
 			printer.Infof("Please set the POSTMAN_API_KEY environment variables on the Docker command line.\n")
 		} else {
-			printer.Infof("Use the POSTMAN_API_KEY environment variables, or run 'postman-lc-agent login'.\n")
+			printer.Infof("Use the POSTMAN_API_KEY environment variables, or run 'postman-insights-agent login'.\n")
 		}
 
 		return "", AkitaErr{Err: errors.New("could not find an Postman API key to use")}

cmd/internal/ec2/README.md

@@ -2,8 +2,8 @@
 
 ### Introduction
 
-- The Postman Live Collection Agent (LCA) runs as a systemd service on your server
-- The Postman collection is populated with endpoints observed from the traffic arriving at your service.
+- The Postman Insights Agent runs as a systemd service on your server
+- The Postman Insights project is populated with endpoints observed from the traffic arriving at your service.
 
 ### Prerequisites
 
@@ -14,23 +14,23 @@
 
 - Log in as root user, or use `sudo su` to enable root before running the below command
 ```
-POSTMAN_API_KEY=<postman-api-key> postman-lc-agent setup --collection <postman-collectionID>
+POSTMAN_API_KEY=<postman-api-key> postman-insights-agent setup --collection <postman-collectionID>
 ```
 
 To check the status or logs please use
 
 ```
-journalctl -fu postman-lc-agent
+journalctl -fu postman-insights-agent
 ```
 
 #### Why is root required?
 
 - To enable and configure the agent as a systemd services
-- Env Configuration file location `/etc/default/postman-lc-agent`
-- Systemd service file location `/usr/lib/systemd/system/postman-lc-agent.service`
+- Env Configuration file location `/etc/default/postman-insights-agent`
+- Systemd service file location `/usr/lib/systemd/system/postman-insights-agent.service`
 
 ### Uninstall
 
 - You can disable the systemd service using
 
-`sudo systemctl disable --now postman-lc-agent`
+`sudo systemctl disable --now postman-insights-agent`

cmd/internal/ec2/add.go

@@ -15,30 +15,30 @@ import (
 )
 
 const (
-	envFileName         = "postman-lc-agent"
-	envFileTemplateName = "postman-lc-agent.tmpl"
+	envFileName         = "postman-insights-agent"
+	envFileTemplateName = "postman-insights-agent.tmpl"
 	envFileBasePath     = "/etc/default/"
 	envFilePath         = envFileBasePath + envFileName
 
-	serviceFileName     = "postman-lc-agent.service"
+	serviceFileName     = "postman-insights-agent.service"
 	serviceFileBasePath = "/usr/lib/systemd/system/"
 	serviceFilePath     = serviceFileBasePath + serviceFileName
 
-	// Output of command: systemctl is-enabled postman-lc-agent
+	// Output of command: systemctl is-enabled postman-insights-agent
 	// Refer: https://www.freedesktop.org/software/systemd/man/latest/systemctl.html#Exit%20status
-	enabled     = "enabled"                                                                               // exit code: 0
-	disabled    = "disabled"                                                                              // exit code: 1
-	nonExisting = "Failed to get unit file state for postman-lc-agent.service: No such file or directory" // exit code: 1
+	enabled     = "enabled"                                                                                     // exit code: 0
+	disabled    = "disabled"                                                                                    // exit code: 1
+	nonExisting = "Failed to get unit file state for postman-insights-agent.service: No such file or directory" // exit code: 1
 )
 
 // Embed files inside the binary. Requires Go >=1.16
 
-//go:embed postman-lc-agent.service
+//go:embed postman-insights-agent.service
 var serviceFile string
 
 // FS is used for easier template parsing
 
-//go:embed postman-lc-agent.tmpl
+//go:embed postman-insights-agent.tmpl
 var envFileFS embed.FS
 
 // Helper function for reporting telemetry
@@ -73,8 +73,8 @@ func setupAgentForServer(collectionId string) error {
 func askToReconfigure() error {
 	var isReconfigure bool
 
-	printer.Infof("postman-lc-agent is already present as a systemd service\n")
-	printer.Infof("Helpful commands \n Check status: systemctl status postman-lc-agent \n Disable agent: systemctl disable --now postman-lc-agent \n Check Logs: journalctl -fu postman-lc-agent\n Check env file: cat %s \n Check systemd service file: cat %s \n", envFilePath, serviceFilePath)
+	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)
 
 	err := survey.AskOne(
 		&survey.Confirm{
@@ -98,7 +98,7 @@ func askToReconfigure() error {
 // Check is systemd service already exists
 func checkReconfiguration() error {
 
-	cmd := exec.Command("systemctl", []string{"is-enabled", "postman-lc-agent"}...)
+	cmd := exec.Command("systemctl", []string{"is-enabled", "postman-insights-agent"}...)
 	out, err := cmd.CombinedOutput()
 
 	if err != nil {
@@ -113,7 +113,7 @@ func checkReconfiguration() error {
 				return nil
 			}
 		}
-		return errors.Wrapf(err, "failed to run systemctl is-enabled posman-lc-agent")
+		return errors.Wrapf(err, "failed to run systemctl is-enabled postman-insights-agent")
 	}
 	if strings.Contains(string(out), enabled) {
 		return askToReconfigure()
@@ -125,7 +125,7 @@ func checkReconfiguration() error {
 func checkUserPermissions() error {
 
 	// Exact permissions required are
-	// read/write permissions on /etc/default/postman-lc-agent
+	// read/write permissions on /etc/default/postman-insights-agent
 	// read/write permission on /usr/lib/system/systemd
 	// enable, daemon-reload, start, stop permission for systemctl
 
@@ -214,9 +214,9 @@ func configureSystemdFiles(collectionId string) error {
 	return nil
 }
 
-// Starts the postman LCA agent as a systemd service
+// Starts the Postman Insights Agent as a systemd service
 func enablePostmanAgent() error {
-	message := "Enabling postman-lc-agent as a service"
+	message := "Enabling postman-insights-agent as a service"
 	reportStep(message)
 	printer.Infof(message + "\n")
 
@@ -225,14 +225,14 @@ func enablePostmanAgent() error {
 	if err != nil {
 		return errors.Wrapf(err, "failed to run systemctl daemon-reload")
 	}
-	// systemctl start postman-lc-service
+	// systemctl start postman-insights-agent.service
 	cmd = exec.Command("systemctl", []string{"enable", "--now", serviceFileName}...)
 	_, err = cmd.CombinedOutput()
 	if err != nil {
 		return errors.Wrapf(err, "faild to run systemctl enable --now")
 	}
-	printer.Infof("Postman LC Agent enabled as a systemd service. Please check logs using the below command \n")
-	printer.Infof("journalctl -fu postman-lc-agent \n")
+	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")
 
 	return nil
 }

cmd/internal/ec2/ec2.go

@@ -19,16 +19,16 @@ var (
 var Cmd = &cobra.Command{
 	Deprecated:   "This is no longer supported and might be removed in a future release.",
 	Use:          "setup",
-	Short:        "Add the Postman Live Collections Agent to the current server.",
-	Long:         "The CLI will add the Postman Live Collections Agent as a systemd service to your current server.",
+	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.",
 	SilenceUsage: true,
 	RunE:         addAgentToEC2,
 }
 
 var RemoveFromEC2Cmd = &cobra.Command{
 	Use:          "remove",
-	Short:        "Remove the Postman Live Collections Agent from EC2.",
-	Long:         "Remove a previously installed Postman agent from an EC2 server.",
+	Short:        "Remove the Postman Insights Agent from EC2.",
+	Long:         "Remove a previously installed Postman Insights agent from an EC2 server.",
 	SilenceUsage: true,
 	RunE:         removeAgentFromEC2,
 
@@ -45,7 +45,7 @@ func init() {
 
 func addAgentToEC2(cmd *cobra.Command, args []string) error {
 	// Check for API key
-	_, err := cmderr.RequirePostmanAPICredentials("The Postman Live Collections Agent must have an API key in order to capture traces.")
+	_, err := cmderr.RequirePostmanAPICredentials("The Postman Insights Agent must have an API key in order to capture traces.")
 	if err != nil {
 		return err
 	}

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

@@ -1,14 +1,14 @@
 [Unit]
-Description=Postman Live Collections Agent
+Description=Postman Insights Agent
 Wants=network-online.target
 After=network-online.target NetworkManager.service systemd-resolved.service
 
 [Service]
-EnvironmentFile=/etc/default/postman-lc-agent
+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-lc-agent apidump --collection "${COLLECTION_ID}" --interfaces "${INTERFACES}" --filter "${FILTER}" "$EXTRA_APIDUMP_ARGS"
+ExecStart=/usr/bin/postman-insights-agent apidump --collection "${COLLECTION_ID}" --interfaces "${INTERFACES}" --filter "${FILTER}" "$EXTRA_APIDUMP_ARGS"
 
 [Install]
 WantedBy=multi-user.target

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

@@ -7,7 +7,7 @@
 POSTMAN_API_KEY={{.PostmanAPIKey}}
 
 
-# Add your your Postman Live Collection ID. 
+# Add your your Postman Collection ID. 
 #This is required.
 
 COLLECTION_ID={{.CollectionId}}
@@ -30,7 +30,7 @@ FILTER=
 
 
 # Configure any extra arguments you wish to provide to the
-# 'postman-lc-agent apidump' command. For example,
+# 'postman-insights-agent apidump' command. For example,
 #
 #   EXTRA_APIDUMP_ARGS="--rate-limit 100"
 #

cmd/internal/ecs/add.go

@@ -86,20 +86,21 @@ type AddWorkflow struct {
 const (
 	// Tag to use for objects created by the Akita CLI
 	akitaCreationTagKey       = "postman:created_by"
-	akitaCreationTagValue     = "Postman Live Insights ECS integration"
+	akitaCreationTagValue     = "Postman Insights ECS integration"
 	akitaModificationTagKey   = "postman:modified_by"
-	akitaModificationTagValue = "Postman Live Insights ECS integration"
+	akitaModificationTagValue = "Postman Insights ECS integration"
 
 	// Separate AWS secrets for the key ID and key secret
 	// TODO: make these configurable
 	akitaSecretPrefix    = "postman/"
 	defaultKeyIDName     = akitaSecretPrefix + "api_key_id"
 	defaultKeySecretName = akitaSecretPrefix + "api_key_secret"
 
-	// Postman Live Collections Agent image locations
+	// Akita CLI image location
 	akitaECRImage    = "public.ecr.aws/akitasoftware/akita-cli"
 	akitaDockerImage = "akitasoftware/cli"
-	postmanECRImage  = "docker.postman.com/postman-lc-agent"
+	// Postman Insights Agent image location
+	postmanECRImage = "docker.postman.com/postman-insights-agent"
 )
 
 // Run the "add to ECS" workflow until we complete or get an error.
@@ -486,7 +487,7 @@ func getTaskState(wf *AddWorkflow) (nextState optionals.Optional[AddWorkflowStat
 	err = survey.AskOne(
 		&survey.Select{
 			Message: "Which task should be monitored?",
-			Help:    "Select the ECS task definition to modify. We will add the Postman Live Collections Agent as a sidecar to the task.",
+			Help:    "Select the ECS task definition to modify. We will add the Postman Insights Agent as a sidecar to the task.",
 			Options: tasks,
 		},
 		&taskAnswer,
@@ -529,11 +530,11 @@ func getTaskState(wf *AddWorkflow) (nextState optionals.Optional[AddWorkflowStat
 		}
 	}
 
-	// Check that the postman-lc-agent is not already present
+	// Check that the postman-insights-agent is not already present
 	for _, container := range output.ContainerDefinitions {
 		image := aws.ToString(container.Image)
 		if matchesImage(image, postmanECRImage) || matchesImage(image, akitaECRImage) || matchesImage(image, akitaDockerImage) {
-			printer.Errorf("The selected task definition already has the image %q; postman-lc-agent is already installed.\n", image)
+			printer.Errorf("The selected task definition already has the image %q; postman-insights-agent is already installed.\n", image)
 			printer.Infof("Please select a different task definition, or hit Ctrl+C to exit.\n")
 			return awf_next(getTaskState)
 		}
@@ -668,7 +669,7 @@ func (wf *AddWorkflow) showPlannedChanges() {
 				defaultKeySecretName, wf.awsRegion)
 		}
 	}
-	printer.Infof("Create a new version %d of task definition %q which includes the Postman Live Collections Agent as a sidecar.\n",
+	printer.Infof("Create a new version %d of task definition %q which includes the Postman Insights Agent as a sidecar.\n",
 		wf.ecsTaskDefinition.Revision+1, wf.ecsTaskDefinitionFamily)
 	printer.Infof("Update service %q in cluster %q to the new task definition.\n",
 		wf.ecsService, wf.ecsCluster)
@@ -808,7 +809,7 @@ func addSecretState(wf *AddWorkflow) (nextState optionals.Optional[AddWorkflowSt
 	return awf_next(modifyTaskState)
 }
 
-// Create a new revision of the task definition which includes the postman-lc-agent container.
+// Create a new revision of the task definition which includes the postman-insights-agent container.
 func modifyTaskState(wf *AddWorkflow) (nextState optionals.Optional[AddWorkflowState], err error) {
 	reportStep("Modify ECS Task Definition")
 
@@ -851,13 +852,13 @@ func modifyTaskState(wf *AddWorkflow) (nextState optionals.Optional[AddWorkflowS
 	var entryPoint []string
 
 	if collectionId != "" {
-		entryPoint = []string{"/postman-lc-agent", "apidump", "--collection", collectionId}
+		entryPoint = []string{"/postman-insights-agent", "apidump", "--collection", collectionId}
 	} else {
-		entryPoint = []string{"/postman-lc-agent", "apidump", "--project", projectId}
+		entryPoint = []string{"/postman-insights-agent", "apidump", "--project", projectId}
 	}
 
 	agentContainer := types.ContainerDefinition{
-		Name:       aws.String("postman-lc-agent"),
+		Name:       aws.String("postman-insights-agent"),
 		EntryPoint: entryPoint,
 		Environment: append(envs, []types.KeyValuePair{
 			{Name: aws.String("POSTMAN_API_KEY"), Value: &pKey},
@@ -1028,6 +1029,6 @@ func waitForRestartState(wf *AddWorkflow) (nextState optionals.Optional[AddWorkf
 	}
 
 	reportStep("ECS Service Updated")
-	printer.Infof("Deployment successful! Please return to the Postman Live collection you created.\n")
+	printer.Infof("Deployment successful! Please return to the Postman Insights project that you created.\n")
 	return awf_done()
 }