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-23.1: log: add buffer format options #104790

Merged
merged 1 commit into from Jun 13, 2023

Conversation

blathers-crl[bot]
Copy link

@blathers-crl blathers-crl bot commented Jun 13, 2023

Backport 1/1 commits from #103463 on behalf of @xinhaoz.

/cc @cockroachdb/release


This commit adds an option to format the logging sink
buffers on flush.

New option (under buffering in the config file):

  • format: string that is either 'json-array' or 'newline',
    defaulting to 'newline'.

Format options:

  • json-array: adds '[' at the start of the buffer output and ']'
    at the end. Separates entries in the buffer with ",".
  • newline (default): separates entries in the buffer with "\n".

This change was motivated by the desire to be able to send batched logs
to the Datadog API, which expects them to be in a JSON array when multiple
logs are present. Note that If buffering is off, it is still valid to
send a single JSON log to the Datadog logs API.

Part of: #103477

Release note (cli change): New log config option for the
buffering field to allow buffer output to formatted as
JSON arrays. This can be useful for APIs requring json array
format, such as the Datadog logs API.
New fields:

  • format: 'json-array' or 'newline'.
    Descriptions:
  • json-array: adds '[' at the start of the buffer output and ']'
    at the end. Separates entries in the buffer with ",".
  • newline (default): separates entries in the buffer with "\n".

Release justification: high priority need for feature

This commit adds an option to format the logging sink
buffers on flush.

New option (under `buffering` in the config file):
- format: string that is either 'json-array' or 'newline',
defaulting to 'newline'.

Format options:
- json-array: adds '[' at the start of the buffer output and ']'
at the end. Separates entries in the buffer with ",".
- newline (default): separates entries in the buffer with "\n".

This change was motivated by the desire to be able to send batched logs
to the Datadog API, which expects them to be in a JSON array when
multiple logs are present. Note that If buffering is off, it is still
valid to send a single JSON log to the Datadog logs API.

Part of: #103477

Release note (cli change): New log config option for the
`buffering` field to allow buffer output to formatted  as
JSON arrays. This can be useful for APIs requring json array
format, such as the Datadog logs API.
New fields:
- format: 'json-array' or 'newline'.
Descriptions:
- json-array: adds '[' at the start of the buffer output and ']'
at the end. Separates entries in the buffer with ",".
- newline (default): separates entries in the buffer with "\n".
@blathers-crl blathers-crl bot requested review from a team as code owners June 13, 2023 18:27
@blathers-crl blathers-crl bot added blathers-backport This is a backport that Blathers created automatically. O-robot Originated from a bot. labels Jun 13, 2023
@blathers-crl
Copy link
Author

blathers-crl bot commented Jun 13, 2023

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?

@blathers-crl blathers-crl bot force-pushed the blathers/backport-release-23.1-103463 branch 2 times, most recently from c5bf34b to bcfeaf6 Compare June 13, 2023 18:27
@cockroach-teamcity
Copy link
Member

This change is Reviewable

@xinhaoz xinhaoz requested review from a team and dhartunian June 13, 2023 18:38
Copy link
Collaborator

@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.

:lgtm:

Reviewed 1 of 10 files at r1, all commit messages.
Reviewable status: :shipit: complete! 1 of 0 LGTMs obtained (waiting on @xinhaoz)

@dhartunian dhartunian merged commit e0734eb into release-23.1 Jun 13, 2023
6 checks passed
@dhartunian dhartunian deleted the blathers/backport-release-23.1-103463 branch June 13, 2023 22:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blathers-backport This is a backport that Blathers created automatically. O-robot Originated from a bot.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants