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

Logs app: Add index pattern content #725

Merged
merged 3 commits into from
Jun 2, 2021

Conversation

EamonnTP
Copy link
Contributor

@EamonnTP EamonnTP commented May 26, 2021

Summary

This PR adds content regarding Kibana index patterns that are available for selection in the Logs app settings.

Docs preview

https://observability-docs_725.docs-preview.app.elstc.co/guide/en/observability/master/configure-data-sources.html#edit-config-settings

@EamonnTP EamonnTP added docs Improvements or additions to documentation v7.13.0 labels May 26, 2021
@EamonnTP EamonnTP requested review from sorantis and a team May 26, 2021 14:43
@EamonnTP EamonnTP self-assigned this May 26, 2021
@apmmachine
Copy link
Contributor

apmmachine commented May 26, 2021

A documentation preview will be available soon:

| *Indices* | Index pattern or patterns in the {es} indices to read log data from.
| *Index pattern* | Index pattern or patterns in the {es} indices to read log data from.

Each log source now integrates with {kib} index patterns which support creating and
Copy link
Member

Choose a reason for hiding this comment

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

What are Kibana index patterns? This term was added to our "What's New" doc as well, but I can't find any mention of it in the runtime fields docs, or anywhere else in the Kibana guide.

@EamonnTP
Copy link
Contributor Author

@bmorelli25 I think the term Kibana Index Patterns relates to the standard index patterns described here. Previously, the Logs UI used Elasticsearch index name patterns. Now the user has a choice to configure a Kibana index pattern instead to incorporate runtime fields, which is not available with Elasticsearch index name patterns.

Hi @weltenwort Could you help clarify this is little more? Thanks!

@weltenwort
Copy link
Member

weltenwort commented May 28, 2021

@EamonnTP thanks for taking care of the docs ❤️ Your explanation is absolutely on point. We're using the prefix "Kibana" to "index patterns" to differentiate them from the index name patterns (strings such as filebeat-*) which the ES docs also call "index patterns" in some places. The Kibana team is aiming to avoid that ambiguity by renaming Kibana index patterns to "data views" in the next major version: elastic/kibana#94244.

As for the Logs UI, using Kibana index patterns (KIP) will become the preferred style of configuration soon. The user will be prompted to choose a KIP when they visit the Logs UI for the first time. And we'll incorporate a flyout that allows for creation of new KIPs right there without leaving the app.

@EamonnTP
Copy link
Contributor Author

Thanks @weltenwort! Is this doc update sufficient enough or do you feel we need to add more clarification?

Copy link
Member

@bmorelli25 bmorelli25 left a comment

Choose a reason for hiding this comment

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

Fantastic. Appreciate the explanation @EamonnTP and @weltenwort!

@weltenwort
Copy link
Member

@EamonnTP how about adding something like

You can continue to use log sources configured to use an index name pattern such as filebeat-* instead of a Kibana index pattern, but some features like those depending on runtime fields might not be available.

Would that be useful info for the user?

@EamonnTP
Copy link
Contributor Author

EamonnTP commented Jun 1, 2021

@EamonnTP how about adding something like

You can continue to use log sources configured to use an index name pattern such as filebeat-* instead of a Kibana index pattern, but some features like those depending on runtime fields might not be available.

Would that be useful info for the user?

Thanks @weltenwort I added the additional context.

@EamonnTP EamonnTP merged commit 316bcc2 into elastic:master Jun 2, 2021
@EamonnTP EamonnTP deleted the logs-index-pattern branch June 2, 2021 08:13
EamonnTP pushed a commit to EamonnTP/observability-docs that referenced this pull request Jun 2, 2021
* Add index pattern content

* Update doc link

* Review edit
EamonnTP pushed a commit to EamonnTP/observability-docs that referenced this pull request Jun 2, 2021
* Add index pattern content

* Update doc link

* Review edit
EamonnTP pushed a commit that referenced this pull request Jun 2, 2021
* Add index pattern content

* Update doc link

* Review edit
EamonnTP pushed a commit that referenced this pull request Jun 2, 2021
* Add index pattern content

* Update doc link

* Review edit
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation v7.13.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants