In this post, I will show you, how to monitor your API in just 2 simple steps?
Step 1: Create a component.
Think of components like folders that contain other Fyipe resources and one of the resources it has is called “Monitors“.
They can help you to monitor security measures and manage logs of any of your resources.
They can also help you get SMS Alerts, Call Alerts, or Email Alerts during downtime.
So we click on “Create Component” and provide the name of our component, let’s say, “API” and click on “Add Component”.
That’s it…we have successfully created a new component.
Step 2: Add an API monitor to your component.
An API monitor will basically test your API to gain visibility into performance, availability, and functional correctness. It will also notify your team when they do not behave the way you want.
So we provide the name of our API, let’s say : “Test API Monitor” and click on “API“.
Now, we need to provide the HTTP Method & URL of our API.
HTTP Method will be ‘GET’, let’s assume.
And the URL endpoint will be “https://reqres.in/api/users?page=1“. It’s a sample HTTPS endpoint.
You can click on “Advance Options” to provide any configuration settings for your new monitor.
Here you can customise API request Header & Body.
By clicking on “Add Headers” and providing Key:Value pairs, you can set your API headers.
Here you can set Monitor Criteria for Online, Degraded and Down.
These criteria states when your monitor is UP, Degraded or Down. For example, monitor is up when Status Code is greater than 200 but less than 300 and the response time is less than 5000 milliseconds.
If it does not match this criterion, then the monitor will be considered down and you will be alerted.
You can set the same when the monitor should be considered degraded and down.
Let’s click on “Add Monitor“.
Your API Monitor is now successfully created and added to your component.
This is how it looks like when Fyipe is monitoring your API.
Let me simulate what happens when your API goes down.
I’m creating this incident manually, but Fyipe will automatically create one for you.
When an incident is created, you will be alerted.
You can acknowledge an incident when someone is actively working to resolve it.
And you can resolve it, when you finish working on it.
So that’s how easily you monitor your API on Fyipe in just 2 simple steps.
Check out Fyipe: A Complete SRE and DevOps Platform that saves you hundreds of dollars today!