Automated API Monitoring & Status Page

Have you ever thought about setting automated API monitoring? If yes, then it is good idea to setup an open source status page as well for your APIs. This way, you can establish trust and provide a view to your clients to check how your APIs are behaving over past few days.

There could be several other ways to implement this, but this is what I am going to propose. Basically, we can interconnect few systems together and automated API monitoring and status page.

The workflow will be something like this:

  1. Build API monitoring script using Postman tool
  2. Export Postman collection
  3. Install following softwares on AWS EC2 instance:
    • Jenkins (Installation steps in separate article)
    • Cachet (Installation steps in separate article)
    • MariaDB (Installation steps in separate article)
    • Newman (Command Line Postman Utility) (Installation steps in separate article)
  4. Setup Jenkins job and configure postman collection using Newman
  5. Configure Jenkins job to run periodically
  6. Next, when Jenkins Job runs, it runs the postman collection
  7. Postman script will invoke various API endpoints
    • Check the response time
    • Check the HTTP status code
  8. Record results by invoking Cachet APIs
  9. Configure AWS SES in Cachet so that email notifications can be triggered

Leave a Reply

Your email address will not be published. Required fields are marked *