docs(adr): add A-12 — structured debug logging via log/slog#3424
Open
dimension-zero wants to merge 1 commit intogopasspw:masterfrom
Open
docs(adr): add A-12 — structured debug logging via log/slog#3424dimension-zero wants to merge 1 commit intogopasspw:masterfrom
dimension-zero wants to merge 1 commit intogopasspw:masterfrom
Conversation
Member
|
I am open to improvements of the log output, but currently it's primary focus are humans (or maybe Agents) debugging gopass. So structured logging is not a priority. I would like to keep the default format. But adding a separate - optional - output format would be fine with me. |
Records the options for replacing pkg/debug's printf-style output with log/slog: full migration (recommended), no change, or JSON-flag-only. Recommends Option A — internal migration of pkg/debug keeping the public API stable, with a --log-format json flag. No code change. Signed-off-by: dimension-zero <zero@ditech.ai>
dimension-zero
force-pushed
the
docs/adr-structured-logging
branch
from
65ae3ba to
bc6e46e
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
pkg/debug/uses printf-style debug output that is unstructured and hard to parse in CI or log aggregators.log/slogis available in the stdlib (since Go 1.21; the project already requires Go 1.25), so there is zero dependency cost to migrating.This PR adds
docs/adr/A-12-structured-logging.mdwhich:slogmigration, no change, or JSON-flag-onlypkg/debuginternally toslog, keeping the publicLog/V/LogNAPI unchanged) with a--log-format jsonflag in the same PRinternal/can follow incrementallyNo code change. This ADR is a proposed decision record pending maintainer input.
Related issue: #3416
Test plan
docs/adr/files