docs: clarify availability/cost of metadata when a user opts in #52
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
karenzone approved these changes Feb 11, 2022
Comment on lines +274 to +285
| Enable metadata about the RabbitMQ topic to be added to the event's `@metadata` field, for availablity during pipeline processing. In general, most output plugins and codecs do not include `@metadata` fields. This may impact memory usage and performance. | ||
| | ||
| [id="plugins-{type}s-{plugin}-metadata_locations"] | ||
| ====== Metadata mapping | ||
| |===== | ||
| | category | location | type | ||
| | ||
| | headers |`[@metadata][rabbitmq_headers]` | key/value map | ||
| | properties |`[@metadata][rabbitmq_properties]` | key/value map | ||
| | raw payload |`[@metadata][rabbitmq_payload]` | byte sequence | ||
| |===== | ||
| |
There was a problem hiding this comment.
Builds cleanly and renders as expected. Looks like this:
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
3 participants
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.
Docs change to add clarity to the availability and cost of using
metadata_enabledoption.