ChenSammi commented on code in PR #7313: URL: https://github.com/apache/ozone/pull/7313#discussion_r1806090666
########## hadoop-hdds/docs/content/tools/Debug.md: ########## @@ -0,0 +1,477 @@ +--- +title: "Ozone Debug" +date: 2024-10-14 +summary: Ozone Debug command can be used for all the debugging related tasks. +--- +<!--- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +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. + +```bash +$ ozone debug --help +Usage: ozone debug [-hV] [--verbose] [-conf=<configurationPath>] + [-D=<String=String>]... [COMMAND] +Developer tools for Ozone Debug operations + -conf=<configurationPath> + + -D, --set=<String=String> + + -h, --help Show this help message and exit. + -V, --version Print version information and exit. + --verbose More verbose output. Show the stack trace of the errors. +Commands: + chunkinfo returns chunk location information about an + existing key + print-log-dag, pld Create an image of the current compaction log DAG + in OM. + find-missing-padding, fmp List all keys with any missing padding, optionally + limited to a volume/bucket/key URI. + recover recover the lease of a specified file. Make sure + to specify file system scheme if ofs:// is not + the default. + prefix Parse prefix contents + ldb Parse rocksdb file content + read-replicas Reads every replica for all the blocks associated + with a given key. + container Container replica specific operations to be + executed on datanodes only + ratislogparser Shell of printing Ratis Log in understandable text +``` +For more detailed usage see the output of `--help` for each of the subcommands. + + +## ozone debug ldb + +Ozone heavily uses RocksDB for storing metadata. This tool helps parse the contents of RocksDB belonging to Ozone Roles. +Supported DB's : Ozone Manager (om.db) , StorageContainerManager (scm.db), Datanode/Container (container.db) +Below is the usage: + +```bash +$ ozone debug ldb --help +Missing required option: '--db=<dbPath>' Review Comment: We shall remove these two lines before the "Usage:". -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
