Install Postman Insights Agent on EC2

The Postman Insights Agent listens to the traffic arriving at the service you want to monitor and automatically populates your Insights Projects with endpoints.

To use the Insights Agent with a standalone Linux instance of Amazon EC2, complete the following steps. Then, you'll be automatically directed to the Endpoints tab.

Requirements

• Your server's OS supports systemd.
• Root user privileges in order to edit systemd files.

Install Insights Agent on EC2

To install the Insights Agent, do the following:

1. Select Insights in the sidebar and select Add to create a new Insights Project.

   

   The onboarding workflow displays, listing the installation instructions and supported deployments.

2. Select AWS EC2.

   

3. Log in to the EC2 instance. For more information, see Connect to your EC2 Instance.

4. As shown on the Insights onboarding screen, run the install script on that instance.

   bash -c "$(curl -L https://releases.observability.postman.com/scripts/install-postman-insights-agent.sh)"
   

5. On the Insights onboarding screen, select Add API key, and then copy and paste the command in your shell.

   In the example command below, the angle brackets and the text between them are placeholders. The command you copy in the onboarding screen will contain your correct API key and project ID.

   sudo POSTMAN_API_KEY=<your-api-key> postman-insights-agent ec2 setup --project <projectId>
   

   In the resulting output, the server checks for user permissions and the presence of systemd, configures systemd files, and enables Postman Insights Agent as a systemd service.

6. Check the status or logs. Run the journalctl command:

   sudo journalctl -fu postman-insights-agent
   

7. In Postman, check out the Insight Project's Endpoints tab to see the list of endpoints the Insights Agent generates as it gathers data.

Run the help command for other configuration parameters.

postman-insights-agent ec2 --help

Your Insights Project can take a few minutes to populate.

You are ready to customize your insights and debug your endpoints. You can also review any traffic errors if your endpoints aren't populating.

Uninstall the Insights Agent

To stop the systemd service, run the following:

sudo systemctl disable postman-insights-agent.service