Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

release-21.2: log: add support for decoding JSON logs #83147

Merged
merged 1 commit into from
Jul 7, 2022

Conversation

dhartunian
Copy link
Collaborator

@dhartunian dhartunian commented Jun 21, 2022

Backport 1/1 commits from #79356.

/cc @cockroachdb/release


Previously, our logging code did not have the ability to recognize and
decode JSON formatted log files. This led to problems when retrieving
logs via API endpoints and when running commands such as merge-logs to
process logs from debug.zip files.

This commit adds support for the json, json-compact, json-fluent, and
json-fluent-compact formats via one generalized JSON decoder.

Resolves #66684

Release note (ops change, cli change): debug zip and merge-logs commands
will now work with JSON formatted logs.

Jira issue: CRDB-14742

Release justification: high-need log management change that's additive to existing log parsing

@dhartunian dhartunian requested a review from a team June 21, 2022 19:33
@dhartunian dhartunian requested a review from a team as a code owner June 21, 2022 19:33
@blathers-crl
Copy link

blathers-crl bot commented Jun 21, 2022

Thanks for opening a backport.

Please check the backport criteria before merging:

  • Patches should only be created for serious issues or test-only changes.
  • Patches should not break backwards-compatibility.
  • Patches should change as little code as possible.
  • Patches should not change on-disk formats or node communication protocols.
  • Patches should not add new functionality.
  • Patches must not add, edit, or otherwise modify cluster versions; or add version gates.
If some of the basic criteria cannot be satisfied, ensure that the exceptional criteria are satisfied within.
  • There is a high priority need for the functionality that cannot wait until the next release and is difficult to address in another way.
  • The new functionality is additive-only and only runs for clusters which have specifically “opted in” to it (e.g. by a cluster setting).
  • New code is protected by a conditional check that is trivial to verify and ensures that it only runs for opt-in clusters.
  • The PM and TL on the team that owns the changed code have signed off that the change obeys the above rules.

Add a brief release justification to the body of your PR to justify this backport.

Some other things to consider:

  • What did we do to ensure that a user that doesn’t know & care about this backport, has no idea that it happened?
  • Will this work in a cluster of mixed patch versions? Did we test that?
  • If a user upgrades a patch version, uses this feature, and then downgrades, what happens?

@cockroach-teamcity
Copy link
Member

This change is Reviewable

Copy link
Contributor

@abarganier abarganier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, aside from one detail that I wasn't sure about.

Reviewable status: :shipit: complete! 0 of 0 LGTMs obtained (waiting on @abarganier and @dhartunian)


pkg/util/log/log_decoder.go line 140 at r1 (raw file):

		return "crdb-v2", nil
	}

Do we want a match against v1IndicatorRE here as well? I noticed that it's done in the original PR.

@dhartunian dhartunian force-pushed the backport21.2-79356 branch from 491b94c to ce4f99a Compare June 29, 2022 15:15
Copy link
Collaborator Author

@dhartunian dhartunian left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewable status: :shipit: complete! 0 of 0 LGTMs obtained (waiting on @abarganier)


pkg/util/log/log_decoder.go line 140 at r1 (raw file):

Previously, abarganier (Alex Barganier) wrote…

Do we want a match against v1IndicatorRE here as well? I noticed that it's done in the original PR.

fixed. good catch. must have gotten lost in the merge conflict resolution.

Copy link
Contributor

@abarganier abarganier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:lgtm_strong:

Reviewable status: :shipit: complete! 1 of 0 LGTMs obtained (waiting on @abarganier)

@dhartunian
Copy link
Collaborator Author

Realized the test failures and merge confusion was because there's a prior backport missing: #83748

will wait for that to merge.

Previously, our logging code did not have the ability to recognize and
decode JSON formatted log files. This led to problems when retrieving
logs via API endpoints and when running commands such as `merge-logs` to
process logs from debug.zip files.

This commit adds support for the json, json-compact, json-fluent, and
json-fluent-compact formats via one generalized JSON decoder.

Resolves cockroachdb#66684

Release note (ops change, cli change): debug zip and merge-logs commands
will now work with JSON formatted logs.
@dhartunian dhartunian force-pushed the backport21.2-79356 branch from ce4f99a to 29d22b7 Compare July 6, 2022 20:48
@dhartunian dhartunian requested a review from a team as a code owner July 6, 2022 20:48
@dhartunian dhartunian merged commit 3758f95 into cockroachdb:release-21.2 Jul 7, 2022
@dhartunian dhartunian deleted the backport21.2-79356 branch July 7, 2022 15:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants