ec2

README

Amazon EC2/ Linux Server

Introduction

• 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

• Your server's OS supports systemd
• root user

Usage

• 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 ec2 --project <postman-insights-project-id>

To check the status or logs please use

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-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-insights-agent

Documentation

Index

• Variables

Variables

var Cmd = &cobra.Command{
	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,
}

var RemoveFromEC2Cmd = &cobra.Command{
	Use:          "remove",
	Short:        "Remove the Postman Insights Agent from EC2.",
	Long:         "Remove a previously installed Postman Insights agent from an EC2 server.",
	SilenceUsage: true,
	RunE:         removeAgentFromEC2,

	Hidden: true,
}

var SetupInEC2Cmd = &cobra.Command{
	Use:          "setup",
	Short:        Cmd.Short,
	Long:         Cmd.Long,
	SilenceUsage: true,
	RunE:         addAgentToEC2,
}

'postman-insights-agent ec2' should default to 'postman-insights-agent ec2 setup'