step6.md

Step 6 - Monitoring a service and exposing REST API

Wow your'e making a lot of progress! We're nearly done hang in there.

Up until now we mostly did the "boilerplate" of a regular john doe webapp. A user dashboard, some validations, domain objects CRUD etc. Now it's time for the actual business logic. In order to monitor a service it will need to call our servers every X minutes to report it's alive (depending on our desired SLA). Because our services can be written anywhere and in any language we'll expose a REST endpoint to report "isAlive".

To expose a REST endpoint we'll create a file named http-functions.js under the backend folder. Check out the docs here

• Expose a GET endpoint which will get the service name as a path or a query param and the api key as a header named x-api-key. For now this endpoint should verify the api key and save the latest ping timestamp per service.
• Clone this repo and go to the demo-app folder.
  • run sh npm install in the terminal
  • implement the monitor function in monitor.ts. This function should issue an ajax request to the endpoint that you just wrote. I recommend using axios npm package in order to send the request.
  • fill in your serviceName and apiKey in index.ts
  • run sh npm start in the terminal to start your server locally
  • test to see that everything works

All Done?

Let's continue to Step 7 - Implementing the core business logic using scheduled jobs + triggered emails

Having Troubles?

Take a look at:

• http-functions.js
• services-pings.dao.js
• monitor.ts