-
Notifications
You must be signed in to change notification settings - Fork 41
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
add ECS support #85
add ECS support #85
Conversation
==== Event Metadata and the Elastic Common Schema (ECS) | ||
When ECS compatibility is disabled, the value is stored in the root level. | ||
When ECS is enabled, the value is stored in the `target` field. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I haven't added the table to compare the columns of ECS disabled and ECS v1 because the field name is depending on the value of target
which has no default value
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I understand the intention but from a plugin user perspective the docs seems confusing.
Maybe we should just include the same message as the one that gets logged to explain?
The plugin behaves the same regardless of ECS compatibility, except issuing a warning when `target` isn't set.
It is recommended to set the `target` option to avoid potential schema conflicts.
(just a draft - probably need rewording if we decide to use it)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
for generic plugins such as this one it would be nice to wait for logstash-plugins/logstash-mixin-ecs_compatibility_support#6 (just in case we need to change the message or do more target checks)
while at it we might also want to add field reference validation for the target
==== Event Metadata and the Elastic Common Schema (ECS) | ||
When ECS compatibility is disabled, the value is stored in the root level. | ||
When ECS is enabled, the value is stored in the `target` field. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I understand the intention but from a plugin user perspective the docs seems confusing.
Maybe we should just include the same message as the one that gets logged to explain?
The plugin behaves the same regardless of ECS compatibility, except issuing a warning when `target` isn't set.
It is recommended to set the `target` option to avoid potential schema conflicts.
(just a draft - probably need rewording if we decide to use it)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Comments in line for your consideration. I think it's important to add the "...regardless of ECS compatibility" wording to make the meaning more clear. You can decide if you like the tip formatting or not. :-)
docs/index.asciidoc
Outdated
The plugin behaves the same except giving a warning when ECS is enabled and `target` isn't set. | ||
It is recommended to set the `target` option to avoid potential schema conflicts. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The plugin behaves the same except giving a warning when ECS is enabled and `target` isn't set. | |
It is recommended to set the `target` option to avoid potential schema conflicts. | |
The plugin behaves the same regardless of ECS compatibility, except giving a warning when ECS is enabled and `target` isn't set. | |
TIP: Set the `target` option to avoid potential schema conflicts. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This PR add ECS support to the filter.
It adds a warning if
target
is not set in ECS modeFixed #80