Receiver API

Receiver API is used to transmit various artifacts such as garbage collection logs, thread dumps, top , disk usage, network stats, … from the target device to yCrash server.

How to invoke receiver API?

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

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

Parameters

KeyValue
apiKeyYour API Key which we sent
deHost/Device name
tsTimestamp in “yyyy-mm-ddThh-mm-ss” this format 
dtThe type of data is uploaded. Below are the datatypes which need to be set as value:GC log: “gc”, Thread dump: “dt”, Top: “top”, VMstat: “vmstat”, Top-h: “toph”, DF: “df”, CPU: “cpu”, PS: “ps”, NETSTAT: “ns”.
appApplication name
  1. The body of the HTTP request should contain the log/dump file which needs to be uploaded.
  1. The HTTP response will be sent back.

Response

NameDescription
TrueHTTP response will be true, if data is successfully transmitted to yCrash server.
FalseHTTP response will be false, if data is failed to transmit to yCrash server. 

It’s very simple right.

Compression

Generally, log/dumps files are larger in size. For fast and efficient processing we recommend you compress and send the log\dump files. When you are compressing the files need to just pass a parameter fileName = { filename of dump/log file which you are uploading } in the HTTP request.

/yc-receiver?apiKey={ Your API Key }&de=172.31.22.190&ts=2020-07-01T08-19-09&dt=gc&app=soa&fileName=G1gc.zip.

We support the following compression formats :

zip, gz, xz, z, lzma, deflate, sz, lz4, zstd, bz2, tar

You may use one of your choices. Whatever filename you have named for log/dump files should be passed in the ‘fileName’ element with the extension.

Other Tools

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

Fig: Posting log/dump files through Postman Plugin

tier1appteam

One thought on “Receiver API

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