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

Add a 'how to populate ECS fields' section to readme... #345

Merged
merged 2 commits into from
Mar 5, 2019

Conversation

webmat
Copy link
Contributor

@webmat webmat commented Feb 26, 2019

Trying to work Mike's points in, as mentioned here: #334 (comment)

Copy link
Contributor

@MikePaquette MikePaquette left a comment

Choose a reason for hiding this comment

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

I think the following text would help clarify the "How to populate ECS fields" section.

How to perform a logical mapping of your event fields to ECS fields

In order to maximize the level of interoperability of your data with future analysis content (e.g., saved searches, visualizations, dashboards, alerts, machine learning jobs, reports, apps, etc.), whether this content is provided by Elastic or shared by the community, please keep the following guidelines in mind.

  • Start by populating ECS Core fields. These fields are the most common across all use cases. Your implementation should attempt to populate as many of the ECS Core fields as practical.
    • …even if these fields or values are metadata that are not present in your original event. For example, a firewall event shipped to the Elastic Stack over syslog may not actually include a field with value ”syslog,” but the ECS agent.type field should still be set to “syslog."
    • …even if the data has already been mapped to one ECS field. For example, if you’ve mapped your event’s client IP address to ECS client.ip, you can also copy the same value to ECS source.ip and even ECS related.ip.
  • Populate as many ECS Extended fields as apply to the subject and use case of your event. ECS Extended fields generally apply to more narrow use cases, so feel free to skip ECS Extended fields that are not applicable to your use case.
  • You're free to choose whether to copy your event fields to ECS fields, leaving your original fields intact as custom fields, or to rename your existing event fields to ECS, essentially migrating them to the ECS field names. Future ECS content and applications will depend only upon the presence of the ECS fields, and will ignore any custom fields.

Trying to work Mike's points in, as mentioned [here](elastic#334 (comment)).
@webmat
Copy link
Contributor Author

webmat commented Mar 4, 2019

Love this preamble. What if we reordered it like this?

When shaping your events to match ECS, please keep the guidelines below in mind. This will ensure you maximize the level of interoperability of your data with future analysis content (e.g., saved searches, visualizations, dashboards, alerts, machine learning jobs, reports, apps, etc.), whether this content is provided by Elastic or shared by the community.

@webmat
Copy link
Contributor Author

webmat commented Mar 4, 2019

Incorporated your feedback with the tweak I mention above. Let me know what you think of this proposal.

@MikePaquette
Copy link
Contributor

@webmat LGTM 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants