Core dump API

• Startup
• Business
• Enterprise
• On-Premise
• Add-on

Overview

The Core Dump API provides a way to capture the current state of the Java Virtual Machine (JVM) by generating a core dump file. This can be useful for diagnosing low-level system issues, crashes, or identifying performance bottlenecks within the application.

When invoked, this API creates a Java core dump file in the {app.data}/errors directory and returns the path to the file. The generated core dump can then be analyzed using tools like jmap, jstack or Jprofiler to inspect heap memory, thread dumps, or system errors.

Authentication

Only super-admin user can use this API.

Before making a call to the built-in API, the user must receive a JWT token from the authentication API.

Step 1. Use any user with the super-admin role to call an Etlworks authentication endpoint and receive an access token.

Step 2. Use the access token received in Step 1 to call the Etlworks API endpoints. The access token must be submitted as a header parameter, as in: Authorization:Bearer access-token.

Access tokens in Etlworks are short-lived and self-expiring. An access token gives you access to the APIs for approximately 10 minutes. It is recommended that you refresh the access token before each call to the API.

The API endpoint parameters

• PATH: /rest/v1/system/metrics/core-dump

EXAMPLE: https://etlworks/rest/v1/system/metrics/core-dump

• METHOD: GET
• HEADER: Authorization:Bearer access-token
• REQUEST BODY: none
• REQUEST CONTENT TYPE: none

Usage Example

To trigger the creation of a core dump and receive the file path:

GET /rest/v1/system/metrics/core-dump

Example response

/opt/integrator/data/errors/dumpfile_20241023172740732.hprof

Note the naming convention: dumpfile_yyyyMMddhhmmssSSS.hprof

Response codes

• 200 for success
• 401 and 403 for not authorized
• 500 for an internal error
• 504 for not responding (timeout)