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

ECS does not describe source.domain and destination.domain #1663

Closed
andrewthad opened this issue Nov 12, 2021 · 3 comments · Fixed by #1673
Closed

ECS does not describe source.domain and destination.domain #1663

andrewthad opened this issue Nov 12, 2021 · 3 comments · Fixed by #1673
Labels
bug Something isn't working

Comments

@andrewthad
Copy link
Contributor

In #84, there was a good conversation about what source.domain and destination.domain mean. However, today, the documentation for destination.domain reads:

Destination domain.

This field (and source.domain) is not documented sufficiently. If someone can explain to me what it is supposed to be (is it just FQDN?), I can add an example to the documentation.

@andrewthad andrewthad added the bug Something isn't working label Nov 12, 2021
@andrewthad
Copy link
Contributor Author

Relatedly, in #175, @webmat wrote:

domain is now the place to store the host address under source, destination and url.

But the accompanying PR only documented url.domain.

@ebeahan
Copy link
Member

ebeahan commented Nov 15, 2021

Thanks, @andrewthad, for this great feedback!

The [source|destination].domain should be populated with the domain name system address of the source/destination, if present in the event or known through some sort of event enrichment. As the docs describe, the .address field is populated first, and then the value duplicated to .ip or .domain.

I agree that the current descriptions for destination.domain and source.domain need improvement. These field descriptions were part of the original ECS 0.1.0 spec and never revisited when [destination|source].hostname was later removed (as you linked). There's also a section in the docs that describes mapping network events, which we could also include examples that populate the .domain fields.

@andrewthad
Copy link
Contributor Author

Thank you. The description you've added is much more clear than what was previously there, and the example is helpful.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants