Introduction
Datadog is an analytics platform that can aggregate data from servers, databases, applications, tools and services into a unified view for monitoring. Datadog helps organizations foster a culture of observability, collaboration, and data-sharing, all of which are key pillars of the DevOps movement.
This Integration uses Catchpoint Test Data Webhook to send data to the Datadog Platform, this is accomplished by using Datadog’s HTTP API to send Standard Metrics. With this integration, we are enabling the different teams to visualize Catchpoint's digital experience data with the Datadog monitoring platform.
Supported Metrics:
Below is the list of standard metrics in Datadog.
| Name | Units | Description |
| catchpoint.error.boolean.error | errors | Error count |
| catchpoint.frontend.bytes.root_request_response_content_bytes | bytes | Root Request Response Content Bytes |
| catchpoint.frontend.bytes.root_request_response_header_bytes | bytes | Root Request Response Header Bytes |
| catchpoint.frontend.bytes.total_downloaded_bytes | bytes | Total Downloaded Bytes. |
| catchpoint.frontend.bytes.total_response_content_bytes | bytes | Total Response Content Bytes |
| catchpoint.frontend.bytes.total_response_header_bytes | bytes | Total Response Header Bytes |
| catchpoint.frontend.bytes.total_self_zone_bytes | bytes | Total Self-Zone Bytes |
| catchpoint.frontend.counter.total_number_of_connections | Total Number of Connections | |
| catchpoint.frontend.counter.total_number_of_failed_requests | Total Number of Failed Requests | |
| catchpoint.frontend.counter.total_number_of_filmstrip_images | Total Number of Filmstrip Images | |
| catchpoint.frontend.counter.total_number_of_hosts | hosts | Total Number of Hosts |
| catchpoint.frontend.counter.total_number_of_js_errors | Total Number of JS Errors | |
| catchpoint.frontend.counter.total_number_of_redirect | Total Number of Redirects | |
| catchpoint.frontend.counter.total_number_of_requests | requests | Total Number of Requests |
| catchpoint.frontend.score.page_speed_score | Page Speed Score | |
| catchpoint.frontend.score.speed_index_score | Speed Index Score | |
| catchpoint.frontend.timing.above_the_fold_time | milliseconds | Above the Fold Time |
| catchpoint.frontend.timing.authentication_time | milliseconds | Authentication Time |
| catchpoint.frontend.timing.client_time | milliseconds | Client Time |
| catchpoint.frontend.timing.content_load_time | milliseconds | Content Load Time |
| catchpoint.frontend.timing.document_complete_time | milliseconds | Load Event / Document Complete Time |
| catchpoint.frontend.timing.dom_content_load_time | milliseconds | DOM Content Load Time |
| catchpoint.frontend.timing.dom_interactive_time | milliseconds | DOM Interactive Time |
| catchpoint.frontend.timing.dom_load_time | milliseconds | DOM Load Time |
| catchpoint.frontend.timing.first_party_zone_impact | milliseconds | First Party Zone Impact |
| catchpoint.frontend.timing.load_time | milliseconds | Load Time (AKA Recevie/Download) |
| catchpoint.frontend.timing.render_start_time | milliseconds | Render Start Time |
| catchpoint.frontend.timing.third_party_zone_impact | milliseconds | Third Party Zone Impact |
| catchpoint.frontend.timing.time_to_title | milliseconds | Time to Title |
| catchpoint.frontend.timing.total_root_request_redirect_time | milliseconds | Total Root Request Redirect Time |
| catchpoint.frontend.timing.total_root_request_time | milliseconds | Total Root Request Time |
| catchpoint.frontend.timing.total_test_time | milliseconds | Total Test Time |
| catchpoint.frontend.timing.webpage_response_time | milliseconds | Webpage Response Time |
| catchpoint.frontend.timing.wire_time | milliseconds | Wire Time |
| catchpoint.ftp.bytes.total_download_bytes | bytes | FTP Total Download Bytes |
| catchpoint.ftp.bytes.total_get_bytes | bytes | FTP Total GET Bytes |
| catchpoint.ftp.bytes.uploaded_bytes | bytes | FTP Uploaded Bytes |
| catchpoint.ftp.timing.delete_time | milliseconds | FTP Delete Time |
| catchpoint.ftp.timing.download_time | milliseconds | FTP Download Time |
| catchpoint.ftp.timing.get_time | milliseconds | FTP GET Time |
| catchpoint.ftp.timing.upload_time | milliseconds | FTP Upload Time |
| catchpoint.imap.timing.logout_time | milliseconds | IMAP Logout Time |
| catchpoint.imap.timing.message_fetch_time | milliseconds | IMAP Message Fetch Time |
| catchpoint.imap.timing.message_list_time | milliseconds | IMAP Message List Time |
| catchpoint.imap.timing.message_search_time | milliseconds | IMAP Message Search Time |
| catchpoint.network.timing.dns_resolution_time | milliseconds | DNS Resolution Time |
| catchpoint.network.timing.send_time | milliseconds | Send Time |
| catchpoint.network.timing.ssl_time | milliseconds | TLS/SSL Time |
| catchpoint.network.timing.tcp_connect_time | milliseconds | TCP Connect Time |
| catchpoint.network.timing.wait_time | milliseconds | Wait Time (AKA Time to First Byte) |
| catchpoint.ntp.timing.ntp | milliseconds | NTP |
| catchpoint.ntp.timing.root_delay_time | milliseconds | NTP Root Delay Time |
| catchpoint.ntp.timing.root_dispersion_time | milliseconds | NTP Root Dispersion Time |
| catchpoint.ntp.timing.round_trip_delay_time | milliseconds | NTP Round Trip Delay Time |
| catchpoint.ping.percentage.ping_packet_loss | percent | Ping Packet Loss |
| catchpoint.ping.timing.ping_round_trip_time | milliseconds | Ping Round Trip Time |
Note: Only the metrics from TEST DATA WEBHOOK MACROS are supported.
Installation and Configuration
Datadog Setup:
To get your API key’s, go to your Datadog API configuration page in the API Keys section as shown here:
Copy the API key and add to the below Datadog’s HTTP API endpoint. API key are unique to your organization. An API key is required to submit metrics to Datadog.
https://api.datadoghq.com/api/v1/series?api_key=<YOUR_DATADOG_API_KEY>
Catchpoint Setup: To get Catchpoint data into Datadog, login into the Catchpoint Portal and go to Integrations.
- In the Test Data Webhook add the Datadog API endpoint along with the API key.
- Select Template.
- Click Add New from drop-down.
- Enter a name.
- Select JSON under format.
- Paste template content from the attachment found at the bottom of this article.
- Click Save.
Note: Test Data Webhook feature should be enabled for each test to send metrics under test properties page.
Result
To consume the data, use the out of the dashboard with the integration.
