Datadog is a monitoring service for cloud-scale applications. It combines data from servers, databases, tools, and services to present a unified view of an entire stack. This integration allows you to configure your Postman Monitors to send metrics to Datadog where you can visualize and compare them with other metrics.
Setting up a Datadog integration requires you to get an API key from Datadog and configure your Postman Monitors. After you set up the integration, you can view real-time alerts based on the results of your monitors.
Log in to Datadog and select Integrations in the header toolbar.
API Key is created for you automatically under the APIs tab. If you want, you can also create a key by specifying a name for it.
Save the API Key to use later.
Search and select Datadog.
You can select View All to see all integrations already created by your team.
Select Add Integration to start the configuration process.
To send your monitor metrics and events to Datadog:
- Name your new integration.
- Select the workspace and monitor whose data you would like to send to Datadog.
- Enter your Datadog API key.
- Select the Datadog region you would like to use.
- Optionally indicate if you want to send events for completed runs or send metrics for each run.
- Select the Add Integration button.
As soon as your monitor runs, the data will start flowing into Datadog.
Once the data is present in Datadog, you can filter it based on the monitor name/uid, collection name/uid, user name/id, and environment name/uid (if present). You can also combine different metrics to create a dashboard.
Postman is able to forward a wide array of metrics for the specified monitors. With the latest release, Postman has adopted a new nomenclature for the metrics that are sent to Datadog. This adheres to the standard naming convention that is followed across many Application Performance Monitoring (APM) tools. The current name and previous name are shown in the first column below.
|Metrics Name (previous name)||Type||Description||Level|
|postman.monitor.run.errors (PostmanMonitors_errors)||GAUGE||The total number of errors across all requests in a monitoring run||Run|
|postman.monitor.run.failed_tests (PostmanMonitors_failedTests)||GAUGE||The total number of failed tests across all requests in a monitoring run||Run|
|postman.monitor.run.passed_tests (PostmanMonitors_passedTests)||GAUGE||Total number of passed tests across all requests in a monitoring run||Run|
|postman.monitor.run.request_count (PostmanMonitors_requestCount)||GAUGE||Total number of requests in a monitoring run||Run|
|postman.monitor.run.total_latency (PostmanMonitors_totalLatencys)||GAUGE||The total latency time for all requests in a monitoring run||Run|
|postman.monitor.run.http_status_2xx (PostmanMonitor_run_httpStatus2XX)||GAUGE||Total number of requests in a monitoring run that return an HTTP status code in the 200 range||Run|
|postman.monitor.run.http_status_4xx (PostmanMonitor_run_httpStatus4XX)||GAUGE||Total number of requests in a monitoring run that return an HTTP status code in the 400 range||Run|
|postman.monitor.run.http_status_5xx (PostmanMonitor_run_httpStatus5XX)||GAUGE||Total number of requests in a monitoring run that return an HTTP status code in the 500 range||Run|
|postman.monitor.request.latency (PostmanMonitor_request_latency)||GAUGE||The latency for each request in a monitoring run||Request|
|postman.monitor.request.failed_tests (PostmanMonitor_request_failedTests)||GAUGE||Number of failed tests for each request in a monitoring run||Request|
|postman.monitor.request.passed_tests (PostmanMonitor_request_passedTests)||GAUGE||Number of passed tests for each request in a monitoring run||Request|
|postman.monitor.request.bytes (PostmanMonitor_request_bytes)||GAUGE||Total bytes sent and received for each request in a monitoring run||Request|
Postman sends tags to Datadog along with each metric and event. Tags enable you to filter the metric based on various parameters such as monitor name or collection name. The following tags are sent by Postman to Datadog:
|Region||The region from where the monitor is run|
|Triggers||What triggered the monitor run: Manual, Webhook, or Scheduled|
|Run results||Successful, Failure, Error, or Abort|
|Level||The level the metric is captured for: Run or Request|
|Status Code||HTTP response code for the request run|
|Job ID||Monitor's Job ID|
|Request ID||The request identifier|
Postman is now a Datadog Technology Partner. Postman’s Integration is listed on Datadog’s Integrations page. To enable the partnership, the metrics being emitted by Postman have been renamed as described above.
If you have previously created any integrations, you must update them to take the advantage of the integration listing on Datadog. To update the old integrations to the new format:
- Go to the Post monitoring results page.
- Click the integration you want to upgrade.
- Click Update Now, then click Update Integration on the confirmation box to upgrade the Integration.
- Click Confirm.
The updated Integration has the following benefits:
- The Postman metrics for the new Integration are no longer treated as Custom Metrics in Datadog and hence are free. (Custom metrics on Datadog are charged.)
- A default Dashboard is provided on Datadog that can be used to observe the Monitor. Change the
monitor_namevariable to the Monitor for which you want to observe the Dashboard.