Monitoring IT infrastructure is critical. As always-on services and the interdependencies between them have risen, expectations for availability have also increased. Postman monitors enable teams to monitor their endpoints for performance, uptime, and functionality. And while monitoring is a great start, coupling it with incident management tools results in effective and proactive remediation of issues.
When organizations assign groups of engineers on on-call rotations to fix issues for software services as soon as they happen, the on-call engineer will get notified when something breaks and is responsible for quickly fixing the issue or escalating it if they can’t fix it. Because on-call engineers are the first line of defense, setting up a robust on-call process is critical for managing issues proactively. An on-call process can be embedded into existing workflows by using communication tools, application monitoring tools, and incident management tools.
Postman already has integrations with Slack, MS Teams, PagerDuty, VictorOps, Datadog, and more to effectively monitor and address any issues with your APIs. Adding to that list, we are now introducing a new integration with Opsgenie, a leading incident management tool that provides numerous alert/incident management, collaboration, and communication features.
What is Opsgenie?
Opsgenie is a service-aware incident management tool. Incidents are special alerts that indicate high-priority service interruption. Services represent the internal and external business services in which clear separation of ownership is defined. Opsgenie enables you to map incidents to the business services they impact and have a clear understanding of which teams need to respond. Multiple workflows can be enabled for the incoming alerts based on predefined incident templates with specific response teams, stakeholders, and collaboration channels.
How Postman’s Opsgenie integration helps
Opsgenie can be used to receive notifications for critical Postman monitor alerts via SMS, phone calls, and iOS or Android push notifications, and to respond to those alerts directly from mobile devices using the Opsgenie app.
When you adopt Opsgenie, you gain the following capabilities:
- On-call schedule management and escalations: Define notification schedules and escalation rules, which enable you to route the alert to the person accountable.
- Consolidated alerting: You can use Opsgenie to group alerts, notify via multiple channels, filter excess alerts, and provide alert context.
- Advanced reporting and analytics: The platform automatically logs all alerting and event-related data for easy auditing, analysis, and reporting.
Receiving context around each alert
While triaging and remediating an alert, knowing the context around what went wrong is extremely important; what happens after the alert is triggered is almost always determined by the context with an alert. This information can be critical in determining actions, responses, and escalations. The alert sent by Postman contains:
- Failing tests: Exact failures in the test script written in Postman
- The number of failed tests
- The number of passed tests
- The number of errors: Errors occur when we are not able to fetch the response from your API
- Response time
Failure in Postman monitor A corresponding alert generated in Opsgenie in response to the failure in the Postman monitor shown in the previous image
Details of Opsgenie integration alerts
- To ease viewing, multiple alerts from the same monitor are grouped under a single Opsgenie alert. Details for each incoming alert can be seen under the Activity Logs on the Opsgenie alert.
- An Opsgenie alert is closed upon the first success of the monitor after failure(s). This helps you focus on alerts that need your immediate attention and come back to closed alerts later for further investigation.
- You can set up tags and priorities when you configure the integration. Setting up these properties properly will help in writing the correct workflows.
Incoming alerts can be routed based on tags configured while creating the integration Another example of how incoming alerts can be routed while creating the integration
Here is an example workflow to effectively create an Opsgenie incident from a Postman monitor alert:
- After configuring the integration, each monitor upon failure will create an alert in Opsgenie.
- Properties like tags and priority can be set while configuring the integration.
- Incidents are either created manually or automatically using Opsgenie’s incident-creation rules.
- Opsgenie recommends using automated incident creation rules to create incidents for high-priority failures.
- Tags and priority, sent along with the alert, can be used to filter and create incidents with appropriate priority, escalations, and schedules.
- Configurations can also be added while creating the “API Integration“ on Opsgenie.
Adding an incident-creation rule based on tags A corresponding incident created after a failure in a Postman monitor
This Opsgenie integration is another way we’re working to give Postman users greater real-time visibility into their APIs. Stay tuned as we continue to bring in more integrations across workflows to improve productivity, visibility, and collaboration.
Postman provides a wide range of functions and features to assist with API development, testing, and collaboration. Here are some commonly used functions in Postman:
Creating and Managing Requests: Postman allows you to create API requests by specifying the request method, URL, headers, parameters, and body. You can manage and organize requests within collections, including creating folders, adding descriptions, and reordering requests.
Request and Response Visualization: Postman provides a user-friendly interface to view and analyze request and response data. It supports syntax highlighting for various data formats such as JSON, XML, and HTML, making it easier to understand and validate the data.
Environment and Variables: Postman allows you to define variables and environments. Variables enable you to store and reuse dynamic values across requests, making them flexible and easy to maintain. Environments provide sets of variables specific to different environments (e.g., development, staging, production).
Pre-request Scripts: Postman enables you to execute scripts before sending API requests using pre-request scripts. These scripts can be used to dynamically generate values, manipulate data, or set variables based on specific conditions.
Collection Runner: The Collection Runner allows you to execute a series of requests in a collection. It enables you to perform data-driven testing by iterating over multiple sets of data or environments. You can configure iterations, delays, and data sources for more comprehensive testing.
Mock Servers: Postman allows you to create mock servers for simulating API responses without a live backend. Mock servers are useful during development, allowing frontend developers to work independently by providing simulated API responses.
Documentation Generation: Postman can automatically generate documentation for your APIs based on your requests and collections. It provides a simple way to share API specifications and details with stakeholders.
Collaboration and Teamwork: Postman offers collaboration features such as sharing collections, collaborating on requests, and commenting on specific requests or collections. It also supports version control integration to manage changes and updates effectively.
Integration and Automation: Postman integrates with various tools and services, including version control systems (e.g., Git), CI/CD platforms (e.g., Jenkins), and API management solutions. It provides options for integrating with these tools to automate API testing and deployment processes.