8000 Add a note to refresh the index pattern before visualizing the data by monicasarbu · Pull Request #2726 · elastic/beats · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Add a note to refresh the index pattern before visualizing the data #2726

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

Merged
merged 1 commit into from
Oct 12, 2016

Conversation

monicasarbu
Copy link
Contributor
@monicasarbu monicasarbu commented Oct 7, 2016

Packetbeat uses a few fields in the event of type dict. The problem appears as the Beat doesn't always know the keys that a dictionary field might contain, so it's not able to define them in advance.

Let's consider as an example http.request.headers, that has the type dict. After importing the index-pattern in Kibana, the Discovery page in Kibana looks like:

screen shot 2016-10-06 at 10 08 32 pm

After you refresh the packetbeat-* index pattern, then all the keys are updated and the Discovery page looks like:

screen shot 2016-10-07 at 3 58 06 pm

where a field is created in the packetbeat-* index pattern for each key available in the dictionary.

cc-ed @dedemorton

@monicasarbu monicasarbu added docs review needs_backport PR is waiting to be backported to other branches. labels Oct 7, 2016
@@ -102,6 +102,10 @@ predefined +{beatname_lc}-*+ index pattern and set it as the default.

image:./images/kibana-created-indexes.png[Kibana configured indexes]

NOTE: After importing the index-pattern in Kibana, you need to refresh each index-pattern in Kibana in order to update
Copy link
Collaborator

Choose a reason for hiding this comment

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

In most cases probably directly after the import the refresh will not help as not much data is in the index yet. Only over time these fields will show up and as far as I understand every time a new dict with fields inside is added, the refresh is needed. Perhaps we should put this under the FAQ in something like "Fields show up a nested JSON in Kibana"?

Copy link
Contributor

Choose a reason for hiding this comment

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

@monicasarbu I think this note will be confusing to new users. It would be better, as @ruflin suggests, to describe how the problem affects the user (what they see when they try to visualize the data) and how to fix the problem. I'd suggest having a short note here and then pointing off to an FAQ topic for more detail (in the FAQ topic, you could have a more detailed example of the problem).

BTW, when you say that they need to refresh the index pattern, do you mean that they need to do this: https://www.elastic.co/guide/en/kibana/current/settings.html#reload-fields? If so, a pointer to the Kibana doc about this would be useful.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@ruflin The section about loading the dashboards comes after the user has data in Elasticsearch as the previous section is "Starting Packetbeat", if the user follows the Getting started guide step by step. This is tricky as anytime, new keys can appear after you refreshed already the index-pattern.
I think adding a question under FAQ is a good idea.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@dedemorton yes. I am referring to the indices refresh from Kibana. As suggested I also added to FAQ.

@monicasarbu monicasarbu added in progress Pull request is currently in progress. review and removed review in progress Pull request is currently in progress. labels Oct 7, 2016
@monicasarbu monicasarbu force-pushed the ask_for_refresh_index branch 3 times, most recently from b75fb04 to 43bf40b Compare October 7, 2016 18:37
@monicasarbu monicasarbu force-pushed the ask_for_refresh_index branch from 43bf40b to 8a456e9 Compare October 10, 2016 14:10
@monicasarbu
Copy link
Contributor Author

Based on the feedback from @ruflin @dedemorton, I am adding only a section under FAQ with the solution for nested objected under Discovery, and don't add anything in the importing dashboards section as the user might get confused at this early stage.

@ruflin ruflin merged commit 1370506 into elastic:master Oct 12, 2016
@monicasarbu monicasarbu deleted the ask_for_refresh_index branch October 12, 2016 12:24
urso pushed a commit that referenced this pull request Oct 25, 2016
* Clarify instructions for running configtest

* Add to FAQ the solution for having nested JSON objects under Discovery (#2726)

* docs: Fix broken Kibana doc link in faq (#2837)

The Kibana docs overhaul for 5.0+ changed the link to the index pattern
field refresh instructions.

* Use variable for filepath plus some light edits (#2838)
@dedemorton dedemorton removed the needs_backport PR is waiting to be backported to other branches. label Dec 20, 2016
leweafan pushed a commit to leweafan/beats that referenced this pull request Apr 28, 2023
* Clarify instructions for running configtest

* Add to FAQ the solution for having nested JSON objects under Discovery (elastic#2726)

* docs: Fix broken Kibana doc link in faq (elastic#2837)

The Kibana docs overhaul for 5.0+ changed the link to the index pattern
field refresh instructions.

* Use variable for filepath plus some light edits (elastic#2838)
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.

3 participants
0