Skip to content

Conversation

@joepeeples
Copy link
Contributor

@joepeeples joepeeples commented Sep 8, 2022

Resolves #2197.

Previews:

- Create new reference topic for advanced settings
- Create new troubleshooting section
- Xrefs and plumbing
@joepeeples joepeeples added Team: Docs Team: Endpoint Endpoint related issues Team: EDR Workflows Formerly Defend Workflows, Onboarding and Lifecycle Management troubleshooting Docs that belong in the Troubleshooting section v8.4.0 labels Sep 8, 2022
@joepeeples joepeeples self-assigned this Sep 8, 2022
@github-actions
Copy link

github-actions bot commented Sep 8, 2022

Documentation previews:

@joepeeples joepeeples marked this pull request as ready for review September 8, 2022 16:13
Copy link
Contributor

@nicholasberlin nicholasberlin left a comment

Choose a reason for hiding this comment

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

LGTM, nice work.

Copy link
Contributor

@nastasha-solomon nastasha-solomon left a comment

Choose a reason for hiding this comment

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

Left two minor comments. Looks great overall!


This section provides a few ways to determine the file system names needed for `linux.advanced.fanotify.monitored_filesystems` and `linux.advanced.fanotify.ignored_filesystems`.

Assuming a typical setup, {filebeat} will be installed alongside {elastic-endpoint} and will automatically ship {elastic-endpoint} logs to {es}. {elastic-endpoint} will generate a log message about the file that was scanned when an event occurred.
Copy link
Contributor

Choose a reason for hiding this comment

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

For my own edification, are you referring to the typical Elastic agent setup here? I'm reading this sentence as:
Assuming a typical setup, when you install Elastic Agent, Filebeat will be installed alongside Elastic Endpoint and will automatically ship Elastic Endpoint logs to Elasticsearch.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@nastasha-solomon That's correct. Do you think this should specify installing Elastic Agent for clarity? I don't want to juggle too many proper nouns here but can definitely revise if there's a better way to explain this.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, I think so. What you're describing sounds complex. It might be good to explicitly state that all of this activity is happening without additional user input/efforts (i.e., the Agent does it all). It could also reduce the likelihood that the sentence is misinterpreted. Someone who's unfamiliar with the Agent might interpret the sentence as "assuming you setup Filebeat in the typical way, the Beat will be installed alongside Elastic Endpoint...".

Copy link
Contributor

@benironside benironside left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@jmikell821 jmikell821 left a comment

Choose a reason for hiding this comment

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

Looks great! One general comment, I think we need to be extra careful we're using "Endpoint and Cloud Security" references correctly vs. Elastic Endpoint . AFAIK Elastic Endpoint is doing the monitoring and protecting, but with Endpoint and Cloud sec's new name Elastic Defend, maybe it is synonymous with what the Elastic Endpoint does? We may need to follow up w/ OLM and Dan Ferullo's team to ensure we have accurate definitions of both.

@nicholasberlin
Copy link
Contributor

We may need to follow up w/ OLM and Dan Ferullo's team to ensure we have accurate definitions of both.

I'm on Dan's team, I'll get the clarification.

@ferullo
Copy link
Collaborator

ferullo commented Sep 14, 2022

Looks great! One general comment, I think we need to be extra careful we're using "Endpoint and Cloud Security" references correctly vs. Elastic Endpoint . AFAIK Elastic Endpoint is doing the monitoring and protecting, but with Endpoint and Cloud sec's new name Elastic Defend, maybe it is synonymous with what the Elastic Endpoint does? We may need to follow up w/ OLM and Dan Ferullo's team to ensure we have accurate definitions of both.

As I understand it, Endpoint and Cloud Security and/or Elastic Defend is the integration name, Elastic Endpoint is the name of the thing that is running on the host. I think which name to use depends on the circumstance. A rule of thumb is to say the integration name in cases where you're talking about the Elasticsearch or Kibana experience and Elastic Endpoint when you're talking about what's going on on the host.

@joepeeples
Copy link
Contributor Author

Thanks for the clarification @ferullo, this is very helpful! Could you take a quick look at the content here and flag anything that needs adjusting? I tried to use "Elastic Endpoint" only when describing specific components that are installed when you install Elastic Agent.

@ferullo
Copy link
Collaborator

ferullo commented Sep 14, 2022

The places in this PR that Endpoint and/or the integration name are used seem correct to me.

@joepeeples joepeeples merged commit 4feeace into main Sep 14, 2022
@nastasha-solomon nastasha-solomon deleted the issue-2197-ts-linux-deadlock branch September 14, 2022 19:06
mergify bot pushed a commit that referenced this pull request Sep 14, 2022
* First draft

- Create new reference topic for advanced settings
- Create new troubleshooting section
- Xrefs and plumbing

* Fix typos

* Add lead-in before steps

* Revise explanation about Agent, Filebeat, Endpoint

* Add feedback from Janeen's review

(cherry picked from commit 4feeace)
joepeeples added a commit that referenced this pull request Sep 14, 2022
* First draft

- Create new reference topic for advanced settings
- Create new troubleshooting section
- Xrefs and plumbing

* Fix typos

* Add lead-in before steps

* Revise explanation about Agent, Filebeat, Endpoint

* Add feedback from Janeen's review

(cherry picked from commit 4feeace)

Co-authored-by: Joe Peeples <joe.peeples@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Team: Docs Team: EDR Workflows Formerly Defend Workflows, Onboarding and Lifecycle Management Team: Endpoint Endpoint related issues troubleshooting Docs that belong in the Troubleshooting section v8.4.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOCS] Add Endpoint troubleshooting document: Linux deadlock

7 participants