DAOS-18292 ddb: Debug level of the DDB GO code can not be defined by knard38 · Pull Request #17232 · daos-stack/daos

knard38 · 2025-12-05T09:52:00Z

Description

Properly configure C DAOS debug facilities from Golang DDB code.

Steps for the author:

Commit message follows the guidelines.
Appropriate Features or Test-tag pragmas were used.
Appropriate Functional Test Stages were run.
At least two positive code reviews including at least one code owner from each category referenced in the PR.
Testing is complete. If necessary, forced-landing label added and a reason added in a comment.

After all prior steps are complete:

Gatekeeper requested (daos-gatekeeper added as a reviewer).

github-actions · 2025-12-05T09:52:16Z

Ticket title is 'Debug level of the DDB GO code can not be defined'
Status is 'In Progress'
https://daosio.atlassian.net/browse/DAOS-18292

daosbuild3 · 2025-12-08T03:07:49Z

Test stage Functional Hardware Medium MD on SSD completed with status FAILURE. https://jenkins-3.daos.hpc.amslabs.hpecorp.net//job/daos-stack/job/daos/view/change-requests/job/PR-17232/1/execution/node/1276/log

daosbuild3 · 2025-12-15T19:27:14Z

Test stage Functional on EL 8.8 completed with status FAILURE. https://jenkins-3.daos.hpc.amslabs.hpecorp.net//job/daos-stack/job/daos/view/change-requests/job/PR-17232/2/execution/node/1073/log

daosbuild3 · 2026-01-05T11:07:35Z

Test stage Functional on EL 8.8 completed with status FAILURE. https://jenkins-3.daos.hpc.amslabs.hpecorp.net/job/daos-stack/job/daos/job/PR-17232/4/display/redirect

daosbuild3 · 2026-01-05T12:25:02Z

Test stage NLT on EL 8.8 completed with status UNSTABLE. https://jenkins-3.daos.hpc.amslabs.hpecorp.net/job/daos-stack/job/daos//view/change-requests/job/PR-17232/5/testReport/

daosbuild3 · 2026-01-06T07:07:12Z

Test stage Functional Hardware Medium Verbs Provider MD on SSD completed with status FAILURE. https://jenkins-3.daos.hpc.amslabs.hpecorp.net//job/daos-stack/job/daos/view/change-requests/job/PR-17232/5/execution/node/1358/log

daosbuild3 · 2026-01-06T08:21:31Z

Test stage Functional Hardware Medium MD on SSD completed with status FAILURE. https://jenkins-3.daos.hpc.amslabs.hpecorp.net//job/daos-stack/job/daos/view/change-requests/job/PR-17232/5/execution/node/1399/log

daosbuild3 · 2026-01-29T10:52:58Z

Test stage NLT on EL 8.8 completed with status UNSTABLE. https://jenkins-3.daos.hpc.amslabs.hpecorp.net/job/daos-stack/job/daos//view/change-requests/job/PR-17232/8/testReport/

daosbuild3 · 2026-01-30T03:51:43Z

Test stage Functional Hardware Medium Verbs Provider MD on SSD completed with status FAILURE. https://jenkins-3.daos.hpc.amslabs.hpecorp.net//job/daos-stack/job/daos/view/change-requests/job/PR-17232/8/execution/node/1398/log

Properly configure C DAOS debug facilities from Golang DDB code. Features: recovery Signed-off-by: Cedric Koch-Hofer <cedric.koch-hofer@hpe.com>

daosbuild3 · 2026-02-12T03:12:07Z

Test stage Functional Hardware Medium MD on SSD completed with status FAILURE. https://jenkins-3.daos.hpc.amslabs.hpecorp.net//job/daos-stack/job/daos/view/change-requests/job/PR-17232/13/execution/node/1189/log

daosbuild3 · 2026-02-12T04:02:40Z

Test stage Functional Hardware Medium MD on SSD completed with status UNSTABLE. https://jenkins-3.daos.hpc.amslabs.hpecorp.net/job/daos-stack/job/daos//view/change-requests/job/PR-17232/12/testReport/

daosbuild3 · 2026-02-12T05:51:30Z

Test stage Functional Hardware Medium Verbs Provider MD on SSD completed with status FAILURE. https://jenkins-3.daos.hpc.amslabs.hpecorp.net//job/daos-stack/job/daos/view/change-requests/job/PR-17232/12/execution/node/1392/log

…/daos-18292

Integrate reviewers comments: - Fix UX interface Features: recovery Allow-unstable-test: true Signed-off-by: Cedric Koch-Hofer <cedric.koch-hofer@hpe.com>

…/daos-18292

daosbuild3 · 2026-02-13T13:54:16Z

Test stage Functional Hardware Medium Verbs Provider MD on SSD completed with status FAILURE. https://jenkins-3.daos.hpc.amslabs.hpecorp.net//job/daos-stack/job/daos/view/change-requests/job/PR-17232/14/execution/node/1390/log

…/daos-18292

Integrate reviewers comments: - Update documentation. Features: recovery Allow-unstable-test: true Signed-off-by: Cedric Koch-Hofer <cedric.koch-hofer@hpe.com>

knard38 · 2026-02-13T15:58:08Z

To properly integrate the documentation on logging facilities, I have added a ddb man file as it is already done for the dmg and daos command.
I have also move into this man page the detailed documentation which was printed with the help message.
The pdf of the man page generated is attached to this document.
ddb.pdf

kjacque

Nice job adding documentation. I think this will be helpful to users. Thanks.

Remaining comments aren't blocking and could be addressed in a follow-on.

src/control/cmd/ddb/main.go

Nasf-Fan · 2026-02-14T14:37:24Z

src/control/cmd/ddb/main.go

 	SysdbPath string `long:"db_path" short:"p" description:"Path to the sys db."`
 	VosPath   string `long:"vos_path" short:"s" description:"Path to the VOS file to open."`
 	Version   bool   `short:"v" long:"version" description:"Show version"`
+	Debug     bool   `long:"debug" description:"Without this option, the console log level is set to ERROR. With this option, the console log level is set to INFO. For more detailed logs, provide the --log_dir path to log to a file."`


From user's perspective, he/she may not understand what is ERROR and what is INFO. So this option is mainly for DAOS developer. If that is true, then more convenient and flexible solution maybe something like that:
ddb --debug=mmm --logdir=nnn ...
mmm is different debug level, such as ERROR, WARN, INFO or DEBUG, and so on. nnn is the directory for log messages. These two options are independent from each other. Means that even if the debug level is set as ERROR, we should also allow the user to redirect related error message to the specified log directory.

Just suggestion, not sure how difficult to be implemented, depends on you.

Another question: how will these two options be used under interactive mode? They are per sub-command based or the whole mini-shell will share the same configuration when start the interaction?

From user's perspective, he/she may not understand what is ERROR and what is INFO. So this option is mainly for DAOS developer. If that is true, then more convenient and flexible solution maybe something like that: ddb --debug=mmm --logdir=nnn ... mmm is different debug level, such as ERROR, WARN, INFO or DEBUG, and so on. nnn is the directory for log messages. These two options are independent from each other. Means that even if the debug level is set as ERROR, we should also allow the user to redirect related error message to the specified log directory.

Just suggestion, not sure how difficult to be implemented, depends on you.

At this time, it is not really feasible as the INFO logging facilities is also used to print the result of ddb commands such as the version or help information. They maybe other commands using the logging facilities for such usage. The issue is fixed in a follow-up PR needed for properly testing the ddb go code. As soon as, this issue is fixed it should be not so difficult (at first glance) to implement to change the behaviour as you asked. However, I will change a little bit: ERROR messages and above should always printed on stderr: If lthe -log-dir= is defined then the messages will be printed on stderr and in the log file.

If this last proposal makes sense to you, I can back port the part of the PR fixing the invalid logging usage to this PR. Then, I will fix this one as you suggested. Doest it makes sense to you ?

Another question: how will these two options be used under interactive mode? They are per sub-command based or the whole mini-shell will share the same configuration when start the interaction?

Under interactive mode, the whole mini-shell and sub-commands share the same configuration.

Use consistent logging façilities

Use consistent logging façilities

Fixed with commit 021ee3b

…/daos-18292

Fix building issue: add missing LD_LIBRARY path. Features: recovery Allow-unstable-test: true Signed-off-by: Cedric Koch-Hofer <cedric.koch-hofer@hpe.com>

Fix reviewers remarks: - Add short description of VOS path in live help output. Features: recovery Allow-unstable-test: true Signed-off-by: Cedric Koch-Hofer <cedric.koch-hofer@hpe.com>

Fix reviewers remarks: - Use consistent logging facilities Features: recovery Allow-unstable-test: true Signed-off-by: Cedric Koch-Hofer <cedric.koch-hofer@hpe.com>

daosbuild3 · 2026-02-16T15:31:43Z

Test stage Functional Hardware Large MD on SSD completed with status FAILURE. https://jenkins-3.daos.hpc.amslabs.hpecorp.net/job/daos-stack/job/daos/job/PR-17232/17/display/redirect

daosbuild3 · 2026-02-17T03:30:07Z

Test stage Functional Hardware Medium Verbs Provider MD on SSD completed with status FAILURE. https://jenkins-3.daos.hpc.amslabs.hpecorp.net//job/daos-stack/job/daos/view/change-requests/job/PR-17232/18/execution/node/1347/log

kjacque

Comments are minor, not something I would block on. Nice improvements! I like the change to pass the log level--this really makes more sense from the perspective of a developer and/or a user collecting logs to troubleshoot.

kjacque · 2026-02-17T17:52:17Z

src/control/cmd/ddb/main.go

+	}
+}
+
+func strToLogLevels(level string) (logging.LogLevel, engine.LogLevel, error) {


This would be a good function to write a simple Go unit test for.

kjacque · 2026-02-17T17:53:17Z

src/control/cmd/ddb/main.go

 	SysdbPath string `long:"db_path" short:"p" description:"Path to the sys db."`
 	VosPath   string `long:"vos_path" short:"s" description:"Path to the VOS file to open."`
 	Version   bool   `short:"v" long:"version" description:"Show version"`
+	Debug     string `long:"debug" description:"Logging log level (default to ERROR)"`


Would be good to provide the list of options for log level here directly (or at least direct the user to the manpage).

knard38 self-assigned this Dec 5, 2025

knard38 force-pushed the ckochhof/fix/master/daos-18292 branch 2 times, most recently from 3df67cc to 85e6a34 Compare December 15, 2025 19:25

knard38 force-pushed the ckochhof/fix/master/daos-18292 branch from 85e6a34 to caf8936 Compare January 5, 2026 08:16

knard38 force-pushed the ckochhof/fix/master/daos-18291 branch 2 times, most recently from 9891709 to 9cbf6fe Compare January 5, 2026 10:58

knard38 force-pushed the ckochhof/fix/master/daos-18292 branch from caf8936 to 72a9f0c Compare January 5, 2026 11:06

knard38 force-pushed the ckochhof/fix/master/daos-18292 branch 2 times, most recently from 795df75 to 0187ab0 Compare January 8, 2026 08:43

knard38 added the CR Catastrophic Recovery Feature label Jan 8, 2026

knard38 force-pushed the ckochhof/fix/master/daos-18292 branch from 0187ab0 to 0f34795 Compare January 29, 2026 08:46

DAOS-18292 ddb: Debug level of the DDB GO code can not be defined

981d4b8

Properly configure C DAOS debug facilities from Golang DDB code. Features: recovery Signed-off-by: Cedric Koch-Hofer <cedric.koch-hofer@hpe.com>

knard38 force-pushed the ckochhof/fix/master/daos-18292 branch from 0f34795 to 981d4b8 Compare February 6, 2026 14:09

knard38 changed the base branch from ckochhof/fix/master/daos-18291 to master February 6, 2026 14:10

knard38 marked this pull request as ready for review February 6, 2026 14:10

knard38 requested review from a team as code owners February 6, 2026 14:10

knard38 requested review from Nasf-Fan, janekmi, kjacque and tanabarr February 6, 2026 14:11

kanard38 added 2 commits February 12, 2026 09:01

Merge remote-tracking branch 'origin/master' into ckochhof/fix/master…

f3c30cf

…/daos-18292

DAOS-18292 ddb: Debug level of the DDB GO code can not be defined

2e0f464

Integrate reviewers comments: - Fix UX interface Features: recovery Allow-unstable-test: true Signed-off-by: Cedric Koch-Hofer <cedric.koch-hofer@hpe.com>

knard38 dismissed tanabarr’s stale review via 2e0f464 February 12, 2026 09:56

knard38 requested review from kjacque and tanabarr February 12, 2026 09:58

tanabarr previously approved these changes Feb 12, 2026

View reviewed changes

Merge remote-tracking branch 'origin/master' into ckochhof/fix/master…

97645d8

…/daos-18292

kanard38 added 2 commits February 13, 2026 15:50

Merge remote-tracking branch 'origin/master' into ckochhof/fix/master…

97ab10d

…/daos-18292

DAOS-18292 ddb: Debug level of the DDB GO code can not be defined

2785ca9

Integrate reviewers comments: - Update documentation. Features: recovery Allow-unstable-test: true Signed-off-by: Cedric Koch-Hofer <cedric.koch-hofer@hpe.com>

knard38 dismissed tanabarr’s stale review via 2785ca9 February 13, 2026 15:54

knard38 requested review from a team as code owners February 13, 2026 15:54

knard38 requested a review from tanabarr February 13, 2026 15:59

kjacque previously approved these changes Feb 13, 2026

View reviewed changes

src/control/cmd/ddb/main.go Show resolved Hide resolved

src/control/cmd/ddb/main.go Show resolved Hide resolved

Nasf-Fan reviewed Feb 14, 2026

View reviewed changes

kanard38 added 2 commits February 16, 2026 09:20

Merge remote-tracking branch 'origin/master' into ckochhof/fix/master…

e28348f

…/daos-18292

DAOS-18292 ddb: Debug level of the DDB GO code can not be defined

cf9ee10

Fix building issue: add missing LD_LIBRARY path. Features: recovery Allow-unstable-test: true Signed-off-by: Cedric Koch-Hofer <cedric.koch-hofer@hpe.com>

knard38 dismissed kjacque’s stale review via cf9ee10 February 16, 2026 09:22

kanard38 added 2 commits February 16, 2026 09:55

DAOS-18292 ddb: Debug level of the DDB GO code can not be defined

adf4a2d

Fix reviewers remarks: - Add short description of VOS path in live help output. Features: recovery Allow-unstable-test: true Signed-off-by: Cedric Koch-Hofer <cedric.koch-hofer@hpe.com>

DAOS-18292 ddb: Debug level of the DDB GO code can not be defined

021ee3b

Fix reviewers remarks: - Use consistent logging facilities Features: recovery Allow-unstable-test: true Signed-off-by: Cedric Koch-Hofer <cedric.koch-hofer@hpe.com>

knard38 requested review from Nasf-Fan and kjacque February 16, 2026 15:34

kjacque approved these changes Feb 17, 2026

View reviewed changes

Conversation

knard38 commented Dec 5, 2025

Description

Steps for the author:

After all prior steps are complete:

Uh oh!

github-actions bot commented Dec 5, 2025

Uh oh!

daosbuild3 commented Dec 8, 2025

Uh oh!

daosbuild3 commented Dec 15, 2025

Uh oh!

daosbuild3 commented Jan 5, 2026

Uh oh!

daosbuild3 commented Jan 5, 2026

Uh oh!

daosbuild3 commented Jan 6, 2026

Uh oh!

daosbuild3 commented Jan 6, 2026

Uh oh!

daosbuild3 commented Jan 29, 2026

Uh oh!

daosbuild3 commented Jan 30, 2026

Uh oh!

daosbuild3 commented Feb 12, 2026

Uh oh!

daosbuild3 commented Feb 12, 2026

Uh oh!

daosbuild3 commented Feb 12, 2026

Uh oh!

daosbuild3 commented Feb 13, 2026

Uh oh!

knard38 commented Feb 13, 2026

Uh oh!

kjacque left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Nasf-Fan Feb 14, 2026

Choose a reason for hiding this comment

Uh oh!

knard38 Feb 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

knard38 Feb 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

knard38 Feb 16, 2026

Choose a reason for hiding this comment

Uh oh!

daosbuild3 commented Feb 16, 2026

Uh oh!

daosbuild3 commented Feb 17, 2026

Uh oh!

kjacque left a comment

Choose a reason for hiding this comment

Uh oh!

kjacque Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

kjacque Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

6 participants

knard38 Feb 16, 2026 •

edited

Loading

knard38 Feb 16, 2026 •

edited

Loading