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

docs: clarify limitations of header decoration #173

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

yaauie
Copy link
Contributor

@yaauie yaauie commented Jul 10, 2024

Two known limitations with headers:

  1. Only headers whose values are utf-8 byte sequences will be added to the event (impl).
    While in theory this could change in the future, receiving anything other than a known-constant encoding is problematic for a variety of reasons and likely the reason for the current implementation (e.g., not being embeddable in JSON without loss, which precludes sending the raw bytes to Elasticsearch or other outputs).
  2. Kafka allows multiple headers to share a key, but as-implemented we will overwrite a key if we observe and set it twice.

Copy link
Member

@jsvd jsvd left a comment

Choose a reason for hiding this comment

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

Content-wise LGTM, not sure if the second note will show up correctly cc @karenzone

Copy link
Contributor

@karenzone karenzone left a comment

Choose a reason for hiding this comment

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

NOTE format is legit, but the first sentence is not grammatically correct. Please consider suggestion.

docs/input-kafka.asciidoc Outdated Show resolved Hide resolved
Copy link
Contributor

@karenzone karenzone left a comment

Choose a reason for hiding this comment

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

LGTM 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants