Fin API

Fin API is the last API call one should invoke after all yc-receiver API calls and yc-receiver-heap calls. This API will return back the RCA report URL that corresponds to the data that has been uploaded. The response will also contain detailed GC log, thread dump, heap dump metrics analysis report URLs.

How to invoke fin API?

Invoking fin API is very simple and quite easy. Just need to follow the below steps:

  1. Post HTTP request to /yc-fin?apiKey={ Your API Key }&de=172.31.22.190&ts=2020-07-01T08-19-09&app=soa

Parameters

KeyValue
apiKeyYour API Key which we sent
deHost/Device name
tsTimestamp in “yyyy-mm-ddThh-mm-ss” this format 
appApplication name
  1. The HTTP response will be sent back.

Sample response

HTTP response will be in YAML format contain RCA report url that corresponds to the data that has been uploaded. Response will also contain detailed GC log, thread dump, heap dump metrics analysis report URLs.

dashboardReportURL: http://192.168.43.92:8080/tier1app/yc-report.jsp?ou=metlife&de=xcvxcvxc&app=yc&ts=2020-07-02T15-33-29

gcMetricsURL: http://192.168.43.92:8080/tier1app/yc-reader?ou=metlife&de=xcvxcvxc&app=yc&ts=2020-07-02T15-33-29&dt=gc&apiKey=XXXXXXX

threadMetricsURL: http://192.168.43.92:8080/tier1app/yc-reader?ou=metlife&de=xcvxcvxc&app=yc&ts=2020-07-02T15-33-29&dt=td&apiKey=XXXXXXX

heapMetricsURL: http://192.168.43.92:8080/tier1app/yc-reader?ou=metlife&de=xcvxcvxc&app=yc&ts=2020-07-02T15-33-29&dt=hd&apiKey=XXXXXXX

Response

NameDescription
dashboardReportURLThis is the RCA report page URLwhich will report all root causes for the problems.
gcMetricsURLThis is a GC metric URL. Reads the JSON content of the processed artifact and sends it back. 
threadMetricsURLThis is a thread dump metric URL. Reads the JSON content of the processed artifact and sends it back.
heapMetricsURLThis is the heap dump metric URL. Reads the JSON content of the processed artifact and sends it back.

Other Tools

You can also invoke the API using any web service client tools such as Postman Browser Plugin,…..

Fig: Posting through Postman Plugin

tier1appteam

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s