Debug Tools

Ozone Debug command (ozone debug) is a collection of developer tools intended to help in debugging and get more information of various components of ozone.

It includes the following tools:

• ldb - Tools to debug RocksDB related issues.
• om - Debug commands related to OM.
• datanode - Debug commands related to Datanode.
• replicas - Debug commands for key replica related issues.
• ratis - Debug commands related to Ratis.
• auditparser - A tool to parse and query Ozone audit logs.
• log - A tool to parse and provide insights on logs, currently supports only the datanode’s container logs.
• checknative - Checks if native libraries are loaded
• version - Show internal version of Ozone components

For more information see the following subpages:

📄️ LDB Tool

Ozone heavily uses RocksDB for storing metadata.

📄️ Debug OM

Debug commands related to OM.

📄️ Debug Datanode

Debug commands related to Datanode. Currently, only container replica related commands are available.

📄️ Debug Replicas

Debug commands for retrieving information and performing various checks on the key replicas in Datanodes.

📄️ Ratis Log Parser

The Ratis log parser tool takes a segment file as input and gives a human-readable output.

📄️ Audit Parser

Audit Parser tool can be used for querying the Ozone audit logs.

📄️ Container Replica Debugger Tool

The tool processes container log files from Ozone Datanodes to track state transitions. It provides CLI commands for querying containers based on different attributes.