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

[Ingest Manager] Required fields should be auto-expanded in Config UI #69750

Closed
mostlyjason opened this issue Jun 23, 2020 · 6 comments · Fixed by #71187
Closed

[Ingest Manager] Required fields should be auto-expanded in Config UI #69750

mostlyjason opened this issue Jun 23, 2020 · 6 comments · Fixed by #71187
Assignees
Labels
bug Fixes for quality problems that affect the customer experience Team:Fleet Team label for Observability Data Collection Fleet team

Comments

@mostlyjason
Copy link
Contributor

mostlyjason commented Jun 23, 2020

In the integration configuration editor UI, the streams with required fields are collapsed by default. This makes it difficult for users to know what is being collected, or if they need to edit any of the fields.

This is particularly true for custom logs, where the path of the log file is blank by default but it cannot operate without a valid path. The streams should be expanded so that the user can easily discover that they need to provide a path. This will also reduce the number of clicks that the user must perform. It also reduces the number of times the user must scroll down, because they need to scroll down to expand the streams and then scroll down again once its expanded.

image

@mostlyjason mostlyjason added Team:Fleet Team label for Observability Data Collection Fleet team Ingest Management:alpha1 Group issues for ingest management alpha1 labels Jun 23, 2020
@elasticmachine
Copy link
Contributor

Pinging @elastic/ingest-management (Team:Ingest Management)

@jen-huang jen-huang removed the Ingest Management:alpha1 Group issues for ingest management alpha1 label Jun 23, 2020
@jen-huang
Copy link
Contributor

If streams are all expanded by default, the page can get very long due to number of streams.

IIRC the decision was made to collapse streams by default so that the flow for user adding a data source is a simple as possible (most of the complexity is hidden). cc @hbharding for further input.

@paul-tavares
Copy link
Contributor

paul-tavares commented Jun 24, 2020 via email

@hbharding
Copy link
Contributor

I think what @paul-tavares and @mostlyjason described is a bug. We discussed this awhile ago and decided at the time to collapse all inputs which do not have any require fields. I.e. if an input has required fields, it should be expanded by default. The goal was to simplify the UX so users don't have to scroll through and see every possible field. We do this again at the stream level by hiding 1) fields which we can supply a good default for and 2) fields which are optional, under "advanced options"

I am a little wary that hiding input fields by default could mislead a user or cause them to forget to configure something. And as Jason points out, it's extra clicks for the users who want to dive in and configure more. I think it depends who we want to cater to. First time users who don't want to be exposed to everything, or seasoned users who have known use case in mind and know what to find.

We should definitely address this "collapsed required field" thing as a bug, but perhaps we could change the expand/collapse logic so that inputs are always expanded (revealing all streams), but advanced stream options remain collapsed.

@mostlyjason
Copy link
Contributor Author

I think it'd be a fine solution to expand streams with required fields. It looks like the logs integration does make this field required https://github.com/elastic/package-storage/blob/master/packages/log/0.1.0/dataset/log/manifest.yml#L13. The issue is that it didn't expand this required field.

I'll update the issue to mark this as a bug.

@mostlyjason mostlyjason changed the title [Ingest Manager] Stream should be auto-expanded in Config UI [Ingest Manager] Required fields should be auto-expanded in Config UI Jun 24, 2020
@mostlyjason mostlyjason added the bug Fixes for quality problems that affect the customer experience label Jun 24, 2020
@jen-huang
Copy link
Contributor

++ on treating this as a bug for required fields

@jen-huang jen-huang self-assigned this Jul 9, 2020
jen-huang added a commit that referenced this issue Jul 13, 2020
…71187)

* Match add integration page with designs

* Clean up package config layout code

* Match edit integration config page with designs

* Fix typing and i18n issues

* Add back data test subj

* Add loading UI for second step; code clean up

* Fix limited packages incorrect response

* Add ability to create agent config when selecting config to add integration to

* Add error count to input-level panel; memoize children components

* Add error count next to all advanced options toggles

* Move general form error to bottom bar

* #69750 Auto-expand inputs with required & empty (invalid) vars

* #68019 Enforce unique package config names, per agent config

* Fix typing

* Fix i18n

* Fix reloading when new agent config _wasn't_ created

* Memoize edit integration and fix fields not collapsing on edit

* Really fix types
jen-huang added a commit that referenced this issue Jul 13, 2020
…71187) (#71460)

* Match add integration page with designs

* Clean up package config layout code

* Match edit integration config page with designs

* Fix typing and i18n issues

* Add back data test subj

* Add loading UI for second step; code clean up

* Fix limited packages incorrect response

* Add ability to create agent config when selecting config to add integration to

* Add error count to input-level panel; memoize children components

* Add error count next to all advanced options toggles

* Move general form error to bottom bar

* #69750 Auto-expand inputs with required & empty (invalid) vars

* #68019 Enforce unique package config names, per agent config

* Fix typing

* Fix i18n

* Fix reloading when new agent config _wasn't_ created

* Memoize edit integration and fix fields not collapsing on edit

* Really fix types
# Conflicts:
#	x-pack/plugins/translations/translations/ja-JP.json
#	x-pack/plugins/translations/translations/zh-CN.json
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Fixes for quality problems that affect the customer experience Team:Fleet Team label for Observability Data Collection Fleet team
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants