Loading

What Information to Collect for API Analytics Cases

게시 일자: Mar 2, 2024
과업

GOAL

When reporting an API Analytics case, please follow the procedure to collect the information before raising the case.
Note: Below information is the minimum necessary to start investigating the issues.

This will expedite the troubleshooting process. 

For more information on API Analytics refer to https://docs.mulesoft.com/api-manager/2.x/analytics-landing-page
 

단계
Please collect "Required Information" per each "Issue Category"
 
S.NoIssue CategoryRequired information
1Event Report UI IssueEvent Report UI 
2Manage Event Report API issueManage Event Report
3Analytics Events not showing for an APIEvents not showing
4Metrics IssuesMetrics Issues

Event Report UI 
 

1) Capture a few screenshots of the API Analytics Event Report UI pages showcasing the behavior seen.

2) Capture the full Request URL from the "Edit Report" in Analytics -> Manage Reports in text format.

3) Provide the browser URL from the "Edit Report" Instance in a text format. For example, see below

https://anypoint.mulesoft.com/analytics/#/analytics/organizations/<ORG_ID>/environment/<ENV_ID>/reports/<REPORT_ID>
4) Capture HAR file when running the Report until the issue is reproduced. Refer - How to retrieve HTTP archive files (HAR)


Manage Event Report

1) Capture a few screenshots of the API Analytics Event Report UI pages showcasing the behavior seen.

2) Capture the full Request URL from the "Edit Report" in Analytics -> Manage Reports in text format.

3) Provide the browser URL from the "Create Report/Edit Report" Instance in a text format. For example, see below

https://anypoint.mulesoft.com/analytics/#/analytics/organizations/<ORG_ID>/environment/<ENV_ID>/reports/<REPORT_ID>

4) Provide the current outcome of the execution Event Report in a text file

5) Provide the expected outcome of the execution Event Report 

For limitations on Event Reports, Refer to https://docs.mulesoft.com/api-manager/2.x/analytics-event-api#requirements-and-restrictions

Events not showing for an API

1) Capture a few screenshots of the API Instance from API Manager to show the full details of the API Instance that is not showing the Events

2) Capture the properties of the application that is paired with this API Instance.

  a) If the application is running on-prem capture the $MULE_HOME/conf and $MULE_HOME/logs folder
  b) If the application is running on CloudHub then provide the full application name
  c) If the application is running on RTF then capture the Lite Report as per What Information to Collect for an RTF Case
 
3) Execute the Events API using the curl command and provide the output. 

4) Attach application logs

Metrics Issues

1) Capture a few screenshots of the API Instance that is not showing the Metrics as expected

2) Capture HAR file when running the Report until the issue is reproduced. Refer - How to retrieve HTTP archive files (HAR)

3) Attach application

  a) If the application is running on-prem capture the $MULE_HOME/conf and $MULE_HOME/logs folder
  b) If the application is running on CloudHub then provide the full application name
  c) If the application is running on RTF then capture the Lite Report as per What Information to Collect for an RTF Case

 

Knowledge 기사 번호

001115735

 
로드 중
Salesforce Help | Article