HeapHero API – Remote Location

In heap dump analysis API we have introduced a new feature called Remote Location. Using this feature now you can pass the http(s) URL location of your heap dump in the request.

Say suppose, you have stored your heap dump files in a remote location like AWS S3 bucket. In those cases, if you want to analyze your heap dumps then you will have to download files to your local machine and then invoke the API with heap dump file. To make it simple and automation easier we have introduced ‘location’ parameter in our API. You can pass http(s) URL location to the “location” parameter and invoke the API. When you do it the API will download file from the remote location, analyze the data and return back the response.

Here is a CURL command to invoke heap dump analysis API,

You can also invoke the API using other web service client tools such as: Postman, Soup UI, …

Here is an example of Postman tool,

Fig: Posting heap dump through Postman tool

Our API supports the following 13 file compress formats: zip, gz, xz, z, bz2, deflate, lz4, lzma, sz, zstd, tgz, tar, tar.gz. Compressing files is the process of making them smaller in terms of the number of bytes of data that they contain. We recommend you to compress and send heap dump files for fast and efficient processing. If you are passing a compressed heap dump file to the API then you need to pass “Content-Encoding” parameter in the request or add in request header.

Say suppose you are compressing heap dump file into ZIP format, then you can invoke the API with “Content-Encoding” request parameter:

Or you can pass “Content-Encoding” as HTTP header:

Note – Use the option “-data-binary” in the curl command instead of “-data” option. In “-data” option a new line break will be not preserved in the request. A new line break should be preserved for the legitimate parsing.

Here is an example of a Postman tool where passing “Content-Encoding” parameter in a API request.

Note: Remote Location feature is only available in the HeapHero Enterprise edition

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

Blog at WordPress.com.

Up ↑

%d bloggers like this: