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

Rename hostname to host.name fields to be consistent #74

Closed
wants to merge 1 commit into from

Conversation

ruflin
Copy link
Member

@ruflin ruflin commented Aug 10, 2018

destination.hostname, device.hostname and source.hostname were renamed to *.host.name to be consitent with the host object.

Related to #62

`destination.hostname`, `device.hostname` and `source.hostname` were renamed to `*.host.name` to be consitent with the host object.
@webmat
Copy link
Contributor

webmat commented Aug 10, 2018

LGTM

@ruflin
Copy link
Member Author

ruflin commented Aug 13, 2018

@webmat If ok for, best squash directly.

@MikePaquette
Copy link
Contributor

@ruflin I think "hostname" is a better ECS name for this field, as we are looking to populate this with the internet hostname which is commonly known as "hostname." See wikipedia hostname.

This too would preserve a consistent use of "hostname" in source.hostname, destination.hostname, and device.hostname. But for consistency, this also means that we would have host.hostname, which has been criticized previously as being redundant, and could seem to run afoul of our Avoid Repetition naming guideline . Nonetheless, since "hostname" is the actual name of the entity stored in the field, I think this justifies keeping it.

Also, in case we decide to keep host.* as a top-level namespace/object/prefix only, the use of "hostname" keeps us clear of conflicts.

Finally, this also allows us to continue to have only one dot in our commonly used "ECS-compatible" fields, an original ECS goal to assist with ease-of-recall and predictability.

I vote for no further changes from *.hostname to *.host.name and for reverting host.name to host.hostname for consistency.

@ruflin
Copy link
Member Author

ruflin commented Aug 15, 2018

Renaming host.name to host.hostname is an other way we could go. My current preference is still with host.name but it ties into the discussion here: #71 It would mean hostname is a reusable field.

@webmat
Copy link
Contributor

webmat commented Aug 17, 2018

Yeah I think I'm also in favor of sticking with the widely used naming, in cases like this.

@webmat
Copy link
Contributor

webmat commented Oct 3, 2018

As discussed, we're closing this and we'll be sticking with hostname instead.

@webmat webmat closed this Oct 3, 2018
@ruflin
Copy link
Member Author

ruflin commented Oct 4, 2018

Would be good to add here a comment with reasoning so if we get back to it we know why.

@ruflin ruflin mentioned this pull request Oct 31, 2018
39 tasks
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.

3 participants