SAP APIM Custom Dashboard for Monitoring

Introduction

During development, testing, and support, we ask the following questions to understand what happened during an API call:

How many calls succeeded or failed?

What HTTP method was used (GET, POST, PUT, etc.)?

What is the resource path for the failed or successful calls?

However, it is often difficult to extract detailed information such as the HTTP method used and the response codes for each failed API call. When you open a proxy, you can see calls listed, but they are often not helpful, especially in error cases.

Standard monitoring tiles do not have any filters to see these information and you can only see upto 25 proxies and rest is flagged as others. Analytics Dashboard

For demonstration purpose I will make use of Northwind API https://services.odata.org/northwind/northwind.svc/

I will show you only masking and multiple resources with multiple methods type proxies for the sake of domonstration. 

Masking

Proxy with multiple resources and methods

Custom Dashboard

Let us build custom Dashboard. First create custom view

You can see your charts now.

Testing

Let us use postman to trigger some API calls for monitoring. 

You can select your proxy here if you see it, else make use of filter option to select the needed proxy

Filter option—> We can add one or more filters

Let us select Masking Proxy and find out the calls details

You can select Get and see the response codes

​ IntroductionDuring development, testing, and support, we ask the following questions to understand what happened during an API call:How many calls succeeded or failed?What HTTP method was used (GET, POST, PUT, etc.)?What is the resource path for the failed or successful calls?However, it is often difficult to extract detailed information such as the HTTP method used and the response codes for each failed API call. When you open a proxy, you can see calls listed, but they are often not helpful, especially in error cases. Standard monitoring tiles do not have any filters to see these information and you can only see upto 25 proxies and rest is flagged as others. Analytics DashboardProxy Creation TypesWe need to understand what are the ways to create proxies before jumpint into monitoring. There are variety of ways to create API proxies. Though it is easier to monitor proxies which fall under option 2, still custom dashboad can help to clearly see what was called. Without any resource (Masking)One resource but one methodMultiple resource and multiple methodsMultiple target endpointsFor demonstration purpose I will make use of Northwind API https://services.odata.org/northwind/northwind.svc/I will show you only masking and multiple resources with multiple methods type proxies for the sake of domonstration. MaskingHere you dont define any fixed resources, hence client can any resources with any methods.   Proxy with multiple resources and methodsI have created proxy with two Resources paths called Customers and Products with various methods Custom DashboardLet us build custom Dashboard. First create custom view Create a Chart  You can see your charts now.TestingLet us use postman to trigger some API calls for monitoring.  MonitoringLet us navigate to Analyze —>Custom Dashboard  You can select your proxy here if you see it, else make use of filter option to select the needed proxy Filter option—> We can add one or more filtersLet us select Masking Proxy and find out the calls details You can select Get and see the response codesYou can similarly monitor multiple resources with multiple methods proxyReferences1. https://community.sap.com/t5/technology-blog-posts-by-members/sap-api-logging-log-error-message-using-custom-charts/ba-p/13547402    Read More Technology Blog Posts by Members articles 

#SAP

#SAPTechnologyblog