product-microgateway
product-microgateway copied to clipboard
Management Dashboard for Microgateways
Describe your problem(s)
Currently up and running micro-gateways can not be monitored from a dashboard. When there are plenty of micro-gateways exposing several APIs/micro-services , there should be a dashboard available in API manager Admin portal in order to know the state and details of these micro-gateways. We can use either push or pull method in order to notify about the up and running micro-gateways.
Push Method
Pros :
No unnecessary traffic. The data is pushed only when the data becomes available.
In this scenario , both endpoints stay idle until some information is sent to the admin portal.
Cons :
Sometimes the data will arrive at an unwanted time when the admin portal is not ready for it. However this can be remedied by using a dependency constraint.
Option 1:
We can store the data that we receive from the micro-gateways in a database and then push those data to be displayed in the Management Dashboard.
Option 2:
Otherwise we can keep those data in memory and then push those to be displayed in the management dashboard.
Describe your solution
We can implement a User Interface(dashboard) in the APIM Admin portal to monitor the micro gateways and push or pull (REST API) mechanism support of notifying in Micro gateway side. When considering the push and pull method, it will be efficient to use the Push method for this. In the dashboard it will be useful to display some of the following features.
- Number of microgateways running
- Health status of each microgateway
- Up/downtime of each microgateway
- Exposed APIs by each MIcrogateway and the resources under the API
How will you implement it
Optional Fields
Related Issues:
Suggested Labels:
Suggested Assignee s:
@Rajith90 @VirajSalaka @hasuniea @AmaliMatharaarachchi
I believe we are going to introduce a new configuration to point the APIM deployment to push the messages?
I believe we are going to introduce a new configuration to point the APIM deployment to push the messages?
It's up to discussion
I believe we are going to introduce a new configuration to point the APIM deployment to push the messages?
Yes, there will be new set of configs