Skip to content

Commit 7f71b4b

Browse files
authored
Merge pull request #296 from synhershko/patch-1
[DOCS] Add note about decorate_events
2 parents f4425fe + b4fa73b commit 7f71b4b

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

docs/index.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,8 @@ The following metadata from Kafka broker are added under the `[@metadata]` field
6161
* `[@metadata][kafka][key]`: Record key, if any.
6262
* `[@metadata][kafka][timestamp]`: Timestamp in the Record. Depending on your broker configuration, this can be either when the record was created (default) or when it was received by the broker. See more about property log.message.timestamp.type at https://kafka.apache.org/10/documentation.html#brokerconfigs
6363

64+
Metadata is only added to the event if the `decorate_events` option is set to true (it defaults to false).
65+
6466
Please note that `@metadata` fields are not part of any of your events at output time. If you need these information to be
6567
inserted into your original event, you'll have to use the `mutate` filter to manually copy the required fields into your `event`.
6668

0 commit comments

Comments
 (0)