Observing an API

Postman Monitors can be used to track functionality and end-to-end performance of your APIs and response time. You can also view New Relic metrics for your API, and see relevant New Relic dashboards and deployments within Postman.

Using monitors

You can link monitors in your current workspace to an API version. This enables you to check an API's performance and response times at scheduled intervals. From an API version's Monitoring tab, you can create a new monitor or add an existing monitor.

Schema Monitors

Creating a new monitor

In the API version Monitoring tab, next to Monitors, select Add Monitor and choose Create new monitor.

You can choose between generating a collection from your API schema, using an existing collection, or creating a new collection:

  • Generate a collection from a schema:
    1. Specify a name for the collection.
    2. Configure how the collection will be generated by clicking Show advanced settings.
    3. Select Generate collection and continue.
  • Use an existing collection:
    1. Choose an existing collection in the dropdown list.
    2. Select Select Collection and Continue.
  • Create a new collection:
    1. Add the requests you plan to monitor, specifying the method and URL, as well as the status code and response time you want to check.
    2. Click Create Collection and Continue.

Next, configure the new monitor. For details, see Setting up a monitor.

Adding an existing monitor

You can add an existing monitor to your API:

  1. In the API version Monitoring tab, next to Monitors, select Add Monitor and choose Add existing monitor.

  2. Select a monitor from the list and click Add Monitor. You will only see available monitors in your workspace in the list.

For more about creating a monitor, see Setting up a monitor.

Viewing New Relic APM metrics

New Relic is an application performance management (APM) solution to monitor real-time and trending data for your processes or web apps. The API Builder has a New Relic integration that enables you to access New Relic APM metrics from directly within Postman.

With this integration, each version of your API in Postman can be linked to multiple services from New Relic. Each service can correspond to a running instance of the API, such as beta, prod1, and prod2. You can also optionally link multiple dashboards from New Relic to your API.

You can also send Postman monitor results to New Relic. Note that sending monitor results to New Relic is a separate integration from viewing APM metrics and uses a different New Relic API key. Learn more about configuring a Postman monitor integration with New Relic.

Connecting to New Relic

Before beginning, you must set up APM services for each deployment of your API. See the New Relic APM documentation for more details.

To connect an API to New Relic:

  1. Open an API version and select the Monitoring tab.
  2. Under Connect to APM, select New Relic.
  3. On the Authenticate tab:
    • Enter a nickname.

    • Enter a New Relic User API Key.

      There are multiple types of API keys in New Relic. Make sure to use a User key for connecting an API to New Relic. For more information on API keys in New Relic, see the New Relic API keys documentation.

    • Select your New Relic region.

    • Select Authenticate.

  4. On the Select Services tab:
    • Select one or more of your New Relic APM services.
    • Optionally, select one or more of your New Relic Dashboards.
    • Select Connect.

Using the APM dashboard

Once your New Relic connection is established, the Monitoring tab will show a table of your services, along with their latency, error rate, apdex (ratio of successful to total requests), and health status.

Health status is based on violations of alert conditions in New Relic, as shown in the table below. For more information, see the New Relic documentation for viewing alert violations.

Status Description
Healthy No entity has violations and there are no alerts
Warning An entity has a warning violation in progress
Critical An entity has a critical violation in progress
Not configured No entity is configured for alerting

You can also select Dashboard Quicklinks to choose a link to any of your configured New Relic dashboards. The links will open the dashboard page in New Relic in a new browser window.

Select the name of a service to open a new tab in Postman containing an APM dashboard. The dashboard is continually updated with:

  • Graphs for web transaction time, throughput, error rate, and apdex score. Select a point on a graph to show an exact value for that time.
  • Tables of violation Events, slowest transactions by time, and deployments.
  • Status if the service is still healthy.

At the top of the dashboard tab, you can:

  • Choose another service to view.

  • Select View on New Relic to open the APM summary in New Relic in a new browser window.

  • Choose a time range for the metrics shown.

  • Refresh the data in the tab.

    New Relic APM

To reconfigure the connection to New Relic, select Three dots icon and choose Edit integration. You can then change the nickname, API key, services, dashboads or region. You can also choose Delete integration to remove the connection.

Last modified: 2022/01/21