Make JSON flattening more explicit #31
Merged
Conversation
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
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.
Following my previous PR #30, I thought it'd be useful to make JSON flattening behavior more explicit.
As it stands, unless you know where to look in the docs, flattening behavior is implicit. Most users will experience it when testing OpenObserve for the first time. This isn't ideal since it causes users to make assumptions about how flattening works, assumptions which might be wrong.
This PR proposes to add a new section in the API Reference > Ingestion > Logs > JSON page, to explain the behavior with a quick example, and make the
ZO_INGEST_FLATTEN_LEVELvariable more discoverable.I'm not sure if this behavior differs between cloud and open-source.
Anyway, if you want to change the wording, or you'd rather put this info somewhere else, no issues 😄