Generating Diagnostic Files in AnzoGraph 2.5

This topic provides instructions for using the system management CLI, azgctl, to retrieve diagnostic files for troubleshooting issues with an Graph Lakehouse 2.5 release. The CLI is in the <install_path>/bin directory. If you encounter an error and the database remains running, you take an x-ray to produce a tarball of the appropriate system diagnostic files. If you encounter an error that crashes the database, you generate a "crash dump" that retrieves the crash-related diagnostic files.

• Taking an X-Ray
• Generating a Crash Dump

Taking an X-Ray

Run the following command on the leader server to take an x-ray on a running database. The result is a tarball that includes the historical system records.

azgctl -xray /path/name.xray

Where /path/name is the path on the file system where you want to save the file and the name of the tarball. All x-ray tarballs must include the .xray extension.

For example, the following command generates an x-ray named query_error.xray that is written to the /tmp directory.

/opt/cambridgesemantics/anzograph/bin/azgctl -xray /tmp/query_error.xray

Generating a Crash Dump

If you encounter an issue that stops the database, Graph Lakehouse automatically generates diagnostic files. Follow the instructions below to retrieve the files after a crash.

The database does not need to be running to collect the crash dump.

1. Run the following command on the leader server to view a list of the available crash dumps.

   azgctl -crashlist

   For example:

   /opt/cambridgesemantics/anzograph/bin/azgctl -crashlist

   The results show a list of available crash dumps by timestamp. For example:

   Crash ID Time

   520460982 2023-06-28 20:30:35 520457655 2023-06-28 20:28:25

2. Run the following command to retrieve the appropriate crash files. This command creates a tarball that includes the diagnostic files:

   azgctl -crashfetch [ crash_id ] /path/name.xray

   Include the crash_id when you want to retrieve a specific crash dump that is listed in the crash list. Omit the crash ID to retrieve the latest files. All crash dump tarballs must include the .xray extension.

For example, the following command captures the most recent crash files. The tarball is named latest_crash.xray and it is saved to the /tmp directory.

/opt/cambridgesemantics/anzograph/bin/azgctl -crashfetch /tmp/latest_crash.xray

The example below captures the crash dump for ID 520457655:

/opt/cambridgesemantics/anzograph/bin/azgctl -crashfetch 520457655 /tmp/crash_520457655.xray

You can run azgctl -crashtoss to remove all crash dumps from the server.