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

[Docs] Discuss patterns for ECS vs vendor prefixed fields in the Integrations Developer Guide #11264

Open
chrisberkhout opened this issue Sep 27, 2024 · 1 comment
Assignees

Comments

@chrisberkhout
Copy link
Contributor

When mapping fields in integrations, we use ECS fields whenever possible, but there are several approaches to handling additional data:

  • Put values without an ECS field under a vendor prefix.
  • Put everything under a vendor prefix and copy values to ECS fields when possible.
  • Put everything under a vendor prefix and copy values to ECS fields when possible, and have a policy option to drop vendor fields that have ECS equivalents.

A question that sometimes comes up is: should the vendor-prefixed fields follow the upstream data model as closely as possible, or should it follow the patterns used in ECS?

The best approach may depend on:

  • How much of the available data matches ECS
  • How valuable the non-ECS data is to users
  • How many field there are
  • The total volume of data

The Integrations Developer Guide could include a section that discusses these options and makes recommendations.

@chrisberkhout chrisberkhout self-assigned this Sep 27, 2024
@chrisberkhout
Copy link
Contributor Author

Related discussion: #10811 (comment)

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

No branches or pull requests

1 participant