{"id":21814,"date":"2024-04-29T12:32:01","date_gmt":"2024-04-29T16:32:01","guid":{"rendered":"https:\/\/qxf2.com\/blog\/?p=21814"},"modified":"2024-06-10T02:16:04","modified_gmt":"2024-06-10T06:16:04","slug":"api-endpoint-monitoring-using-sematext","status":"publish","type":"post","link":"https:\/\/qxf2.com\/blog\/api-endpoint-monitoring-using-sematext\/","title":{"rendered":"API Endpoint monitoring using Sematext"},"content":{"rendered":"

Qxf2<\/a> had a request to help identify a tool for monitoring API endpoints in one of our client engagements recently. The client wanted a tool with a UI, intuitive configuration and easy maintenance to monitor their changing API endpoints. Additionally, we needed to be able to verify a response body as part of monitoring the endpoint. Our usual tool belt of Prometheus with Grafana was going to be too heavy for this task. So we had to look out for lightweight monitoring tools that suited this specific context.<\/p>\n

We found Sematext<\/a> – a platform that offers powerful synthetic monitoring<\/a> tool to monitor a HTTP endpoint every n interval and display the results on a dashboard. We decided to use this tool to monitor Cars API app<\/a> – an internal app we built to test our API Automation framework before suggesting it to the client.
\nIn this post, we are outlining the features of Sematext that impressed us, as well as the checks we simulated with our Cars API app to validate if the tool will be a right fit.<\/p>\n

\n

What impressed us? <\/h3>\n

In addition to Sematext we were exploring a few other tools too, our experience with setting up and working with those tools made us appreciate these few facets of Sematext. In short, Sematext presented a nice dashboard, worked with different auth types, exposed hooks to third party services like Twilio that made alerting easy and provided an intuitive UI to configure the endpoint monitors.<\/p>\n

To give you a taste of Sematext, we have included some screenshots for some of these features.<\/p>\n

1. Creating a HTTP monitor <\/h4>\n

Running an API request – HTTP method operation against an endpoint in an interval constitutes a HTTP monitor<\/a>. Creating a HTTP monitor on Sematext was very straightforward, we were able to configure one to run a GET<\/code> request against https:\/\/cars-app.qxf2.com\/cars\/find<\/code> endpoint for every 1 minute interval in minutes.<\/p>\n

\"HTTP<\/a><\/p>\n

2. Configuring the API request <\/h4>\n

Passing input data to the API request can be done through:
\n– Header
\n– Query
\n– Request Body
\n– Cookies
\nWhile these techniques for passing API inputs are common, all the other tools we explored did not support at least one of the above approaches.
\nWe configured Query parameters<\/code> for the HTTP monitor against the https:\/\/cars-app.qxf2.com\/cars\/find<\/code> Cars API app endpoint.<\/p>\n

3. Auth types supported <\/h4>\n

We configured our HTTP monitor to use the Basic<\/code> auth type. Sematext supports the following auth types:
\n– Basic
\n– Bearer\/Access-Token
\n– NTLM<\/p>\n

\"Auth<\/a><\/p>\n

4. Response validation <\/h4>\n

The response validation offered by Sematext outmatched other tools we explored. It allows creating multiple conditions to validate an API response, the API request was considered failed when any of the condition failed.
\nWe created 2 conditions to validate the API request made in our HTTP monitor:
\n1. Check if the response code is 200
\n2. Verify the response body contains a text<\/p>\n

\"HTTP<\/a><\/p>\n

5. Monitoring API app on local network <\/h4>\n

One of the requirements we had from the client was to help identify a solution to monitor their API app running on their local network. Sematext uses a Docker container running on a server in the local network to make the API calls and validate the response, it then pushes the data to the cloud to make the information available on the dashboard.
\nWe tested this aspect with our HTTP monitor too, we ran the Cars API Flask app locally, pulled the Sematext Docker container and validated that the monitor data was available on the dashboard in the cloud instantly.
\n\"HTTP<\/a><\/p>\n

Note:<\/strong> We had to modify the HTTP monitor endpoint URL to http:\/\/host.docker.internal:5000\/cars\/find<\/code> to monitor the app running on localhost through the Docker container since the container do not have access to localhost. This information was not available on the Private Locations<\/a> guide.<\/p>\n

\n

Features that did not meet our expectation <\/h3>\n

Note:<\/strong> This section is very subjective. While many of the Sematext features are remarkable, these were points we discussed when assessing the tool.<\/p>\n

It is very hard to find a tool that meets all expectations. Sematext with all its impressive features still lacked in these aspect:<\/p>\n

1. Email notification <\/h4>\n

The Email notification triggered when the status of the API endpoint changed – online\/offline<\/code> was sometimes ~10 mins late. But we were able to work around this by setting up notification hooks. Sematext supports creating hooks to receive notification on these apps<\/a>(you need a Sematext account to view this page). Our experience setting hooks to receive notifications on Telegram and SMS using Twilio was pleasant.<\/p>\n

2. Pricing <\/h4>\n

The client we were trying to help only had a handful of endpoints, Sematext charges a nominal $2\/month<\/code> for a Pay-As-You-Go<\/code> HTTP monitor but this plan does not allow monitoring the app on private network. Our requirement was somewhere between what was offered in the Pay-As-You-Go<\/code> and the Standard<\/code> plan, but Sematext does offer curating a custom plan, we advised the client to get in touch with Sematext for a flexible plan to suit their need.<\/p>\n

\n

We had a positive experience using Sematext overall which lead us to suggesting it to the client.
\nNote:<\/strong> Qxf2 Services was not paid to endorse Sematext. This post is based on our experience using the tool.<\/p>\n

Hire testers from Qxf2<\/h3>\n

Qxf2 is the home for technical testers. Our QA engineers have a wide range of technical abilities that build upon the solid foundation of testing well. As you can see from this post, our engineer knew of several solutions beforehand and was quickly able to reject them as unsuitable to the client. Instead, they understood the client’s specific context and went about looking for a solution that fit the client needs. If you want smart testers who take the time to tailor the testing solution to your needs, contact Qxf2<\/a>.<\/p>\n

\n","protected":false},"excerpt":{"rendered":"

Qxf2 had a request to help identify a tool for monitoring API endpoints in one of our client engagements recently. The client wanted a tool with a UI, intuitive configuration and easy maintenance to monitor their changing API endpoints. Additionally, we needed to be able to verify a response body as part of monitoring the endpoint. Our usual tool belt […]<\/p>\n","protected":false},"author":9,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[417,418,419],"tags":[],"class_list":["post-21814","post","type-post","status-publish","format-standard","hentry","category-api-monitoring","category-http-monitor","category-http-response-validation"],"_links":{"self":[{"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/posts\/21814","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/users\/9"}],"replies":[{"embeddable":true,"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/comments?post=21814"}],"version-history":[{"count":45,"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/posts\/21814\/revisions"}],"predecessor-version":[{"id":22218,"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/posts\/21814\/revisions\/22218"}],"wp:attachment":[{"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/media?parent=21814"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/categories?post=21814"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/tags?post=21814"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}