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

Elastic Endpoint Package #223

Merged
merged 11 commits into from
Mar 3, 2020

Conversation

jonathan-buttner
Copy link
Contributor

@jonathan-buttner jonathan-buttner commented Feb 21, 2020

This PR adds the elastic endpoint package that has datasets for events and metadata and the fields.yml for both.

I created the security category.

If we want a index pattern created for events-* we'll need to merge this PR as well: elastic/kibana#58908

@ruflin
Copy link
Member

ruflin commented Feb 24, 2020

For the categories: I guess we will only have security or endpoint? I would suggest to go for now with "Security". Are the events you are shipping now ending up under endpoint-* or event-*?

@jonathan-buttner
Copy link
Contributor Author

jonathan-buttner commented Feb 24, 2020

For the categories: I guess we will only have security or endpoint? I would suggest to go for now with "Security".

Sounds good! I'll switch it to Security

Are the events you are shipping now ending up under endpoint-* or event-*?

I think we're going to go with event-*

@jonathan-buttner jonathan-buttner changed the title [WIP] Elastic Endpoint Package Elastic Endpoint Package Feb 28, 2020
@@ -0,0 +1,200 @@
- name: "@timestamp"
Copy link
Member

Choose a reason for hiding this comment

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

Same comment as above for the path.

Copy link
Member

Choose a reason for hiding this comment

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

I remember also a discussion around endpoint only using one index? But having 2 datasets would mean 2 indices?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Gotcha I'll change the dataset name.

So there will be one index for events and alerts (events) and then another index for the metadata of an endpoint for now.

Copy link
Member

Choose a reason for hiding this comment

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

Got it, then this makes sense.

This raises the question how the metadata index will be called. events-endpoint.metadata-*? If yes, the name here is correct.

Copy link
Contributor Author

@jonathan-buttner jonathan-buttner Mar 2, 2020

Choose a reason for hiding this comment

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

So this one will actually be metrics-endpoint.metadata-* (the type is metrics, this is information about endpoints and their status etc) Do you think endpoint.metadata is reasonable name? I figured metrics-metadata wasn't super clear on what it was referring to, that's why I add the endpoint in there.

If we still with endpoint.metadata would it be better to be consistent in the dataset directory and leave the events one as endpoint.events?

Copy link
Member

Choose a reason for hiding this comment

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

Agree that we can't really use metrics-metadata as this is too generic and not clear it would belong to endpoint.

By default we will have that the dataset id = {package.name}.{directory.name}. So in the nginx case we have access, error and stubstatus directories. The problem above is that you only have events-endpoint which means the above does not work as the package is already endpoint. You will have to set id in any case. I would probably call the directory è
events, and the other one metadata.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah ok I see. I'll rename the directories and set the id field. Should I rebase off of #176 ?

Copy link
Member

Choose a reason for hiding this comment

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

I suggest lets get this in as is and then adjust it again as soon as #176 lands.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok sounds good, I moved the datasets to events and metadata. I'm good to merge. @james-elastic could I get a 👍

dev/package-examples/endpoint-0.0.1/manifest.yml Outdated Show resolved Hide resolved
util/package.go Show resolved Hide resolved
@ruflin
Copy link
Member

ruflin commented Mar 3, 2020

I created #228 to also have a base template in place for events-*. Should not affect this PR but thought worth to mention here.

Copy link
Member

@aleksmaus aleksmaus left a comment

Choose a reason for hiding this comment

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

LGTM

@jonathan-buttner jonathan-buttner merged commit 02f0953 into elastic:master Mar 3, 2020
@jonathan-buttner jonathan-buttner deleted the ep-package branch March 3, 2020 19:18
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

Successfully merging this pull request may close these issues.

4 participants