Skip to content

Web console: Better manual capabilities detection indication#16191

Merged
vogievetsky merged 17 commits intoapache:masterfrom
vogievetsky:indicate_forced_mode
Apr 8, 2024
Merged

Web console: Better manual capabilities detection indication#16191
vogievetsky merged 17 commits intoapache:masterfrom
vogievetsky:indicate_forced_mode

Conversation

@vogievetsky
Copy link
Copy Markdown
Contributor

@vogievetsky vogievetsky commented Mar 22, 2024

Upgrade the manual capabilities mode UX so that it is clearer that the console is in a manual capabilities mode.

The console has many degraded modes in can operate in this is to account for different (degraded) configurations of the underlying cluster. Here are a few examples:

  • The coordinator serves the console but does not let you query SQL
  • The router might be running with the management proxy turned off so the console can not reach the coordinator
  • The indexer might be dead and unreachable

When the console loads it does a few probing queries to detect what capabilities are available to it. This is called capability detection.

A manual capabilities mode is when the user tells the console to skip the capability detection and just put itself into some specific mode. This is useful for testing (the console) and for getting around flaws in the capability detection. Overall this is a fairly power user feature and should only be used by users that know what (and why) they are doing it.

It has come to my attention that there were some users that has their console in a manual capabilities mode and they did not know it, as a result their console was degraded. I want to update the UI so it would be more clear.

Current behavior

Setting the manual capabilities mode:

image

Clearing the manual capabilities mode:

image

New behavior

Setting the manual capabilities mode:

image

Clearing the manual capabilities mode:

image

image

Feedback and suggestions welcome.

Comment thread web-console/src/components/header-bar/header-bar.tsx Outdated
Copy link
Copy Markdown
Contributor

@techdocsmith techdocsmith left a comment

Choose a reason for hiding this comment

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

Added style suggestions

Comment thread web-console/src/components/header-bar/header-bar.tsx Outdated
Comment thread web-console/src/components/header-bar/restricted-mode/restricted-mode.tsx Outdated
Comment thread web-console/src/components/header-bar/restricted-mode/restricted-mode.tsx Outdated
label = 'Coordinator mode';
message = (
<p>
It appears that you are accessing the console on the Coordinator service. Due to the lack
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

see line 81

label = 'Overlord mode';
message = (
<p>
It appears that you are accessing the console on the Overlord service. Due to the lack of
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

see line 81

Comment thread web-console/src/components/header-bar/restricted-mode/restricted-mode.tsx Outdated
Comment thread web-console/src/components/header-bar/restricted-mode/restricted-mode.tsx Outdated
Comment thread web-console/src/components/header-bar/restricted-mode/restricted-mode.tsx Outdated
vogievetsky and others added 13 commits March 22, 2024 16:54
Co-authored-by: Charles Smith <techdocsmith@gmail.com>
Co-authored-by: Charles Smith <techdocsmith@gmail.com>
…ots__/restricted-mode.spec.tsx.snap

Co-authored-by: Charles Smith <techdocsmith@gmail.com>
…ots__/restricted-mode.spec.tsx.snap

Co-authored-by: Charles Smith <techdocsmith@gmail.com>
…ed-mode.tsx

Co-authored-by: Charles Smith <techdocsmith@gmail.com>
…ed-mode.tsx

Co-authored-by: Charles Smith <techdocsmith@gmail.com>
…ed-mode.tsx

Co-authored-by: Charles Smith <techdocsmith@gmail.com>
…ed-mode.tsx

Co-authored-by: Charles Smith <techdocsmith@gmail.com>
…ed-mode.tsx

Co-authored-by: Charles Smith <techdocsmith@gmail.com>
…ed-mode.tsx

Co-authored-by: Charles Smith <techdocsmith@gmail.com>
…ed-mode.tsx

Co-authored-by: Charles Smith <techdocsmith@gmail.com>
@vogievetsky vogievetsky changed the title Web console: Better forced mode indication Web console: Better manual capabilities detection indication Mar 25, 2024
working around issues with the automatic capability detecting logic.
</p>
<p>
If you are unsure why the console is in ths mode mode, revert to using automatic
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

"ths mode mode" should be "this mode"

@vogievetsky vogievetsky merged commit 4ff7e2c into apache:master Apr 8, 2024
@vogievetsky vogievetsky deleted the indicate_forced_mode branch April 8, 2024 17:07
@adarshsanjeev adarshsanjeev added this to the 30.0.0 milestone May 6, 2024
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.

4 participants