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

Add ECS known issue for ecs@mappings and fieldless searches #1330

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

zmoog
Copy link
Contributor

@zmoog zmoog commented Sep 17, 2024

Update the 8.13 release notes to add a known issue.

Due to changes introduced to support the ecs@mappings component template (see https://github.com/elastic/kibana/pull/174855[elastic/kibana/pull/174855), Fleet no longer includes ECS fields to the integrations' index.query.default_field.

This may affect integrations that rely on fieldless queries (when no field is specified for a query).

This PR updates the 8.13 release notes to

  • acknowledge the problem
  • inform users that 8.14 is not affected
  • suggest a workaround to 8.13 users

Relates elastic/integrations#10848

@zmoog zmoog self-assigned this Sep 17, 2024
Copy link

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

Copy link

mergify bot commented Sep 17, 2024

This pull request does not have a backport label. Could you fix it @zmoog? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-/d./d is the label to automatically backport to the /d./d branch. /d is the digit
    NOTE: backport-skip has been added to this pull request.

@zmoog zmoog marked this pull request as ready for review September 17, 2024 00:33
@zmoog zmoog requested a review from a team as a code owner September 17, 2024 00:33
@zmoog zmoog changed the title 8.13 release notes: add known issues about fieldless searches 8.13 release notes: add ECS known issues about fieldless searches Sep 17, 2024
All 8.13.x releases are affected.
@zmoog
Copy link
Contributor Author

zmoog commented Sep 17, 2024

run docs-build

@zmoog zmoog changed the title 8.13 release notes: add ECS known issues about fieldless searches Add ECS known issue for ecs@mappings and fieldless searches Sep 17, 2024
@zmoog
Copy link
Contributor Author

zmoog commented Sep 17, 2024

@kilfoyle, do you think it's okay to link to the public URL of a KB article? The article's author thoroughly summarized the issue and described workaround and solutions. I would love to leverage this work and use it as the source of truth if there are updates.

@kilfoyle
Copy link
Contributor

kilfoyle commented Sep 17, 2024

do you think it's okay to link to the public URL of a KB article?

@zmoog If the KB article is truly public then yes, for sure you can just link to it. That would be ideal.

However, if I'm not mistaken, either some or all KB articles require a Cloud account to view. If that's the case, we'd need the information to be available in the known issue to support users who don't have a Cloud account, and then we can still link to the KB article for reference.

kilfoyle
kilfoyle previously approved these changes Sep 17, 2024
Copy link
Contributor

@kilfoyle kilfoyle left a comment

Choose a reason for hiding this comment

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

LGTM! 🚀
Thanks for adding this @zmoog. It looks perfect. I added just one super small suggestion.

@zmoog
Copy link
Contributor Author

zmoog commented Sep 18, 2024

@zmoog If the KB article is truly public then yes, for sure you can just link to it. That would be ideal.

You don't need to be a paying customer to read the content, but you will need to log in to Elastic Cloud.

If you think this scenario does not qualify for this document, I can summarize it for the release notes and keep it up to date until we're out of the ecs@mappings issues.

…iidoc

Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>
@zmoog
Copy link
Contributor Author

zmoog commented Sep 18, 2024

However, if I'm not mistaken, either some or all KB articles require a Cloud account to view. If that's the case, we'd need the information to be available in the known issue to support users who don't have a Cloud account, and then we can still link to the KB article for reference.

Sorry, I read the first sentence and started responding! 🤦 Continuing here.

The KB articles can be internal only or available to customers. When they're available to customers, they still need an EC account.

I'll summarize the KB article for the release notes and link to the original KB article, mentioning that it requires a free EC account.

@kilfoyle
Copy link
Contributor

I'll summarize the KB article for the release notes and link to the original KB article, mentioning that it requires a free EC account.

Sounds perfect! And everything looks good. Thanks for looking after this @zmoog!

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.

2 participants