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

fix(external docs): Fix sink compression options #9869

Merged
merged 1 commit into from
Nov 2, 2021

Conversation

wbew
Copy link
Contributor

@wbew wbew commented Nov 2, 2021

Closes #6975

This PR adds proper handling for sink compression options beyond none and gzip. As a user noted in discord, the kafka sink compression section is currently incorrect.

Sample output for the Kafka sink.

"compression": {
                        "common": true,
                        "description": "The compression strategy used to compress the encoded event data before transmission.\n\nSome cloud storage API clients and browsers will handle decompression transparently,\nso files may not always appear to be compressed depending how they are accessed.",
                        "name": "compression",
                        "required": false,
                        "warnings": [],
                        "type": {
                            "string": {
                                "default": "none",
                                "enum": {
                                    "none": "No compression.",
                                    "gzip": "[Gzip](https://www.gzip.org/) standard DEFLATE compression.",
                                    "lz4": "[lz4](https://lz4.github.io/lz4/) compression.",
                                    "snappy": "[Snappy](https://google.github.io/snappy/) compression.",
                                    "zstd": "[zstd](https://zstd.net) compression."
                                },
                                "syntax": "literal"
                            }
                        }
                    },

Signed-off-by: 001wwang <will.wang@datadoghq.com>
@netlify
Copy link

netlify bot commented Nov 2, 2021

✔️ Deploy Preview for vector-project ready!

🔨 Explore the source changes: 7c80e5a

🔍 Inspect the deploy log: https://app.netlify.com/sites/vector-project/deploys/61818e8c763f14000734a262

😎 Browse the preview: https://deploy-preview-9869--vector-project.netlify.app

@wbew wbew requested review from jszwedko and lucperkins November 2, 2021 19:16
Copy link
Member

@jszwedko jszwedko left a comment

Choose a reason for hiding this comment

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

Awesome, thanks for this fix!

@wbew wbew merged commit a67755a into master Nov 2, 2021
@wbew wbew deleted the fix-kafka-compression-docs branch November 2, 2021 20:59
jszwedko pushed a commit that referenced this pull request Nov 2, 2021
Signed-off-by: 001wwang <will.wang@datadoghq.com>
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.

Kafka compression docs are incorrect
2 participants