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

Adding warning to exceptions that describes field conflicts and mapping issues #3025

Merged
merged 36 commits into from
Mar 28, 2023

Conversation

nastasha-solomon
Copy link
Contributor

@nastasha-solomon nastasha-solomon commented Feb 27, 2023

Fixes #2957.

Previews:

Note to self: elastic/kibana#152726 updated the copy in this warning so I'll need to update the three screenshots I added after once the next BC comes out.

@github-actions
Copy link

Documentation previews:

@nastasha-solomon nastasha-solomon requested a review from e40pud March 7, 2023 19:56
@nastasha-solomon nastasha-solomon marked this pull request as ready for review March 7, 2023 19:56
Copy link
Contributor

@joepeeples joepeeples left a comment

Choose a reason for hiding this comment

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

Good stuff! I did a pretty quick review, and will do a more thoroughly edit soon, but just wanted to pass along a few suggestions to start. Overall I think the organization works well.

The troubleshooting topic also explains the situation pretty well, but the call to action isn't super clear: what is the user supposed to do to resolve the situation, or do they need to do anything at all? The most explicit instruction is "Use this information to ensure you're entering correct values," but that's pretty general advice.

If fields are conflicting or unmapped across indices, does the user need to do anything with the indices themselves so they're no longer conflicting? Maybe we could point toward some ES/Kibana docs on how to map indices to types?

docs/detections/add-exceptions.asciidoc Outdated Show resolved Hide resolved
docs/troubleshooting/detections/detection-rules.asciidoc Outdated Show resolved Hide resolved
docs/troubleshooting/detections/detection-rules.asciidoc Outdated Show resolved Hide resolved
Copy link
Contributor

@e40pud e40pud 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, thanks you!

@nastasha-solomon nastasha-solomon mentioned this pull request Mar 23, 2023
25 tasks
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.

Great work, I really like the new troubleshooting section. Reviewing it definitely sharpened my understanding of how to fix field conflicts / unmapped fields. Left some wording suggestions for your consideration 🚀

docs/detections/add-exceptions.asciidoc Outdated Show resolved Hide resolved
docs/detections/add-exceptions.asciidoc Outdated Show resolved Hide resolved
docs/troubleshooting/detections/detection-rules.asciidoc Outdated Show resolved Hide resolved
docs/troubleshooting/detections/detection-rules.asciidoc Outdated Show resolved Hide resolved
docs/troubleshooting/detections/detection-rules.asciidoc Outdated Show resolved Hide resolved
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.

Good feedback thus far. Just have a few comments.

docs/detections/add-exceptions.asciidoc Outdated Show resolved Hide resolved
docs/detections/add-exceptions.asciidoc Outdated Show resolved Hide resolved
docs/troubleshooting/detections/detection-rules.asciidoc Outdated Show resolved Hide resolved
@nastasha-solomon nastasha-solomon merged commit b925ecc into main Mar 28, 2023
mergify bot pushed a commit that referenced this pull request Mar 28, 2023
…ng issues (#3025)

Co-authored-by: Joe Peeples <[email protected]>
Co-authored-by: Benjamin Ironside Goldstein <[email protected]>
(cherry picked from commit b925ecc)
nastasha-solomon added a commit that referenced this pull request Mar 28, 2023
… mapping issues (backport #3025) (#3076)

Co-authored-by: Joe Peeples <[email protected]>
Co-authored-by: Benjamin Ironside Goldstein <[email protected]>
Co-authored-by: nastasha-solomon <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Adding warning to exceptions that describes field conflicts and mapping issues
5 participants