"Create index pattern" wizard. by cjcenizal · Pull Request #12689 · elastic/kibana

cjcenizal · 2017-07-06T18:41:26Z

Replaces #12530.

Changes

Create a directive for each step in the wizard.
Reorganize files into conventional folder structure.
Rename files with more conventional and consistent naming patterns.
Remove all translations.
Display indices, partial matches, exact matches.
Add loading, empty, and success states.
Add option to include system indices.

Changes to the UX

Loading indices

Searching for matching indices

Submitting the new index pattern

To-do later

Implement polling for new data (and surface a spinner to show the UI is working for you).
Fix form validation when fields are untouched.
Convert directives into React components and add unit tests.
Improve the cross-cluster search UX.
Improve list of matching indices to be a table of "matching", "partially matching", and "non-matching" lists, between which the indices shuffle as the user enters the index pattern. Based on suggestions from @skearns64 and @spalger.

Feedback

From @skearns64

The layout doesn't strongly connect the index pattern input and the search results
Where are we inside of the app? We need to underline the “Index Patterns” tab
We should hide the sidebar when creating a new index pattern
The sidebar warning is visually distracting. Let’s make it clearer in location, appearance, and language. (My note: this could be replaced with an improved onboarding message).
Let’s remove template index patterns for now and treat it as a later optimization.

From @alexfrancoeur

I feel like we're missing some sort of graphic on the new index pattern flow. There's a lot of text that I'm worried people still skip over. What are your thoughts on providing some sort of graphic that explains an index pattern. It could be small even. ES is filled with documents, documents make up multiple indices, an index pattern is used to match against all those indices. It could almost look like a flow diagram. This might be unnecessary but I'd like to see how we can visually improve the page as well

cjcenizal · 2017-07-06T18:43:19Z

...na/public/management/sections/indices/create_index_pattern/__tests__/create_index_pattern.js

I removed this file because I think these types of assertions are better handled by a combination of functional tests and very narrowly-defined unit tests. I'll create unit tests for the new directives I've created.

epixa · 2017-07-06T19:35:48Z

@cjcenizal How about removing translations (from these templates) entirely? We need to do this anyway for all of the initial translations stuff when we re-approach phase 2 of the internationalization effort.

epixa · 2017-07-06T19:36:37Z

As an aside, that'll help with all of those literal html tags you're seeing those screenshots :)

snide · 2017-07-07T14:43:53Z

I'm seeing an empty advanced toggle when hitting step two.

spalger

Some early review feedback, since we're either going to need to remove the check for indices or find some other solution before this can move forward.

spalger · 2017-07-07T17:25:14Z

...management/sections/indices/create_index_pattern_wizard/step_time_field/step_time_field.html

It's safe to remove "likely" from this line, we're trying to figure out the soonest we can remove it right now elastic/elasticsearch#25577

spalger · 2017-07-07T17:31:40Z

...ment/sections/indices/create_index_pattern_wizard/step_index_pattern/step_index_pattern.html

I really think this needs at least a small debounce. The loading indicator flicker is quite distracting and it results in a ton of unnecessary network communication since each keystroke results in three requests. the ng-model-options strategy in master should do the trick without many changes necessary.

spalger · 2017-07-07T18:02:36Z

...ublic/management/sections/indices/create_index_pattern_wizard/create_index_pattern_wizard.js

This method doesn't return indices accessible via cross-cluster search, and I'm not certain we will be able to. Since the only APIs that are cross-cluster search enabled are the _search and _field_caps APIs we might be able to use a terms aggregation on _index to find all of the index names, but that probably has pretty bad performance characteristics for a request that might be executing pretty often, and anyway it's blocked on elastic/elasticsearch#25606.

- Create a directive for each step in the wizard. - Reorganize files into conventional folder structure. - Rename files with more conventional and consistent naming patterns. - Improve translation key names. - Display indices, partial matches, exact matches. - Add loading, empty, and success states. - Add option to include system indices.

cjcenizal · 2017-07-11T22:05:28Z

I'm going to put this on hold and try to get it into the next release.

CCS

Notes for testing cross-cluster search:

Run npm start elasticsearch to use ESVM to install ES in the esvm directory. Kill the server that gets automatically started up.
Edit esvm/dev/branch-master/config/elasticsearch.yml with these settings:

search:
    remote:
        local:
            seeds: 127.0.0.1:9300

Restart the server by running ./esvm/dev/branch-master/bin/elasticsearch.
Now you should be able to use a query like "local:logstash-*" to retrieve your indices via this remote.

Problems

If I used the index pattern local:k, I'd get a 500 error back from http://localhost:5601/agk/es_admin/local%3Ak/_search?allow_no_indices=true with the response:

“error”:{“root_cause”:[{“type”:“index_not_found_exception”,“reason”:“no such index”,“resource.type”:“index_or_alias”,“resource.id”:“k”,“index_uuid”:“_na_“,”index”:“k”}],“type”:“transport_exception”,“reason”:“unable to communicate with remote cluster [local]“,”caused_by”:{“type”:“index_not_found_exception”,“reason”:“no such index”,“resource.type”:“index_or_alias”,“resource.id”:“k”,“index_uuid”:“_na_“,”index”:“k”}},“status”:500}

spalger · 2017-07-12T00:14:33Z

src/ui/public/indices/get_indices.js

+    const searchResponse = await esAdmin.search({
+      index: indexPattern,
+      ignore: [404],
+      allow_no_indices: true,


Adding terminate_after: 1 here will make sure that es only reads a single document from each index, meaning that the search won't need to do more work than necessary and should make this as performant as possible.

alexfrancoeur · 2017-07-18T20:17:21Z

I agree with @skearns64's comment - "The layout doesn't strongly connect the index pattern input and the search results" I think we can resolve this (to an extent) with suggestions from #12310 (comment)

What are your thoughts around bolding (and possibly coloring) the indices where the index pattern matches? (in the current styling)

cjcenizal · 2017-07-21T05:05:50Z

Just wanted to put a screenshot of this UI circa 5.4... so we can appreciate how far we've brought this baby in only 2 minor releases:

cjcenizal · 2017-07-27T17:22:05Z

Closing in favor of #13154

cjcenizal added :Management release_note:enhancement review v6.0.0 v6.0.0-beta1 labels Jul 6, 2017

cjcenizal requested review from BigFunger, snide and spalger July 6, 2017 18:41

cjcenizal mentioned this pull request Jul 6, 2017

"Create index pattern" wizard. #12530

Closed

5 tasks

cjcenizal commented Jul 6, 2017

View reviewed changes

cjcenizal force-pushed the 10438/index-pattern-creation-wizard-squashed branch 2 times, most recently from 5df3c5a to cc10b00 Compare July 6, 2017 20:22

cjcenizal removed the request for review from BigFunger July 6, 2017 20:38

cjcenizal removed the review label Jul 6, 2017

cjcenizal force-pushed the 10438/index-pattern-creation-wizard-squashed branch from 36e4caa to febb4f2 Compare July 6, 2017 21:06

cjcenizal requested a review from epixa July 6, 2017 21:51

spalger suggested changes Jul 7, 2017

View reviewed changes

cjcenizal added 7 commits July 11, 2017 11:00

Remove all translations.

4a73c23

Fix typos in disallowed index pattern characters.

c00e7b1

Make 'Expand index pattern' deprecation notice more apparent.

7db6da3

Update UI when errors within array change.

ffc879f

Remove unused time field error.

caaf63d

Update getIndices to support cross-cluster search.

a86fddd

cjcenizal force-pushed the 10438/index-pattern-creation-wizard-squashed branch from 9c48ba4 to a86fddd Compare July 11, 2017 19:11

cjcenizal added 2 commits July 11, 2017 12:12

Increase number of matching indices.

0619c44

WIP

763dfe8

spalger reviewed Jul 12, 2017

View reviewed changes

cjcenizal added v6.1.0 and removed v6.0.0 v6.0.0-beta1 labels Jul 12, 2017

alexfrancoeur mentioned this pull request Jul 18, 2017

[Prototype] Design for in-page help / tutorial system #12310

Closed

chrisronline self-assigned this Jul 26, 2017

cjcenizal mentioned this pull request Jul 27, 2017

"Create index pattern" wizard. #13154

Closed

5 tasks

cjcenizal closed this Jul 27, 2017

cjcenizal deleted the 10438/index-pattern-creation-wizard-squashed branch July 27, 2017 17:22

aphelionz mentioned this pull request May 7, 2018

Accessibility: Kibana 6.3 Meta Issue #18866

Closed

48 tasks

Conversation

cjcenizal commented Jul 6, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Changes to the UX

Loading indices

Searching for matching indices

Submitting the new index pattern

To-do later

Feedback

From @skearns64

From @alexfrancoeur

Uh oh!

cjcenizal Jul 6, 2017

Choose a reason for hiding this comment

Uh oh!

epixa commented Jul 6, 2017

Uh oh!

epixa commented Jul 6, 2017

Uh oh!

snide commented Jul 7, 2017

Uh oh!

spalger left a comment

Choose a reason for hiding this comment

Uh oh!

spalger Jul 7, 2017

Choose a reason for hiding this comment

Uh oh!

spalger Jul 7, 2017

Choose a reason for hiding this comment

Uh oh!

spalger Jul 7, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cjcenizal commented Jul 11, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CCS

Problems

Uh oh!

spalger Jul 12, 2017

Choose a reason for hiding this comment

Uh oh!

alexfrancoeur commented Jul 18, 2017

Uh oh!

cjcenizal commented Jul 21, 2017

Uh oh!

cjcenizal commented Jul 27, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

cjcenizal commented Jul 6, 2017 •

edited

Loading

spalger Jul 7, 2017 •

edited

Loading

cjcenizal commented Jul 11, 2017 •

edited

Loading