How Metrics and Analytics are sent from Gateway Published APIs to Portal ?
search cancel

How Metrics and Analytics are sent from Gateway Published APIs to Portal ?

book

Article ID: 248472

calendar_today

Updated On:

Products

CA API Developer Portal

Issue/Introduction

We are trying to understand how metrics/analytics for gateways  published APIs are sent to the Portal. We observed that when we add the "Export Variables from Fragment" assertion to a gateway published policy we start seeing analytics for that service on the portal but we don't know which policy is pushing this info to the portal.

Can you you show us or explain this process on how the metrics are sent to the portal, which policy runs this process and also the sample of the  payload that's sent to the portal.

 

 

Environment

Release : 5.1

Component :

Resolution

The service that pushes metrics to ingress is the 'move metrics data off box' which is executed via a scheduled task.

1) metrics are collected based on the variables exported from a service which the 'standard policy templates' do automatically
2) if the proper variables are exported, the 'message-completed-policy' will execute the 'portal-message-completed' policy and put the analytics data in a buffer
3) when the scheduled task runs, it empties the buffer and pushes those to ingress

 

Additional Information

https://techdocs.broadcom.com/us/en/ca-enterprise-software/layer7-api-management/api-developer-portal/5-1-2/introduction-layer7-api-developer-portal/api-portal-architecture.html  

Enable Analytics for Gateway Published APIs
https://techdocs.broadcom.com/us/en/ca-enterprise-software/layer7-api-management/api-developer-portal/5-0-2/manage/manage-apis/publish-apis-with-the-api-proxy-and-policy-manager.html