Research API monitoring options

[bajiat]

Check monitoring services and whether they could be integrated with APInf. One of the criteria is a REST API for starting monitoring and getting monitoring data back. Supports multi-level criteria for monitoring, such as thresholds set by API managers. The service must also be fully open source.

Definition of done

• Research more than one option.
• Present the results in a comparative document not settling on one of the options.
• Document must contain pros and cons.
• Document can contain a recommendation.
• Document is stored in docs repository.
• Check and document the license for each option.

[brylie]

@Nazarah what are some user scenarios we will be testing with the API Monitoring feature? I would like to include relevant information in my research. E.g. if we believe sending SMS messages will be useful, I want to check what Notifications the monitoring solutions support.

[philippeluickx]

Make sure to check #1183

I thought there was an open source component from a competitor, but couldn't find it. There are some github repo's though that deal with API monitoring:

• https://github.com/sanathp/statusok
• https://github.com/firehol/netdata (19K stars, but not sure if relevant)
• https://github.com/fzaninotto/uptime

[Nazarah]

1. the following things to consider:

• server load
• amount of data coming down (result shown as pagination)
• encryption level
• quality of controller code
• Data and transactions important to API owner / Manager
• Uptime
• Concurrent requests to handle
• API end points.
• Path of a specific method*
• Top 50 user connections
• CPU hours
• data objects returned per calls.

2. Should have an Hourband check for the most important things.

3. Acceptable threshold time.

(resounce: https://smartbear.com/learn/performance-monitoring/guide-to-api-monitoring/)

[brylie]

@Nazarah I have added a few rows to the table, based roughly on your comment.

[brylie]

Also reviewing the Smartbear article What is API Monitoring?