opensearch-project/alerting-dashboards-plugin

[FEATURE] Use OUI Prepend component on Cluster health parameters

Open

#745 opened on Sep 28, 2023

View on GitHub
 (2 comments) (0 reactions) (0 assignees)JavaScript (118 forks)auto 404
enhancementgood first issue

Repository metrics

Stars
 (31 stars)
PR merge metrics
 (PR metrics pending)

Description

Is your feature request related to a problem? When users are configuring "Per cluster health metrics" monitor, under "Query", if users select Cluster health, Cluster stats, List snapshots or Recovery, users will have to fill in the Query parameter fields. It is not clear that the parameter form field contain read-only text such as GET _cat/snapshots/ image

What solution would you like? We should use the OUI form fields with Prepend to display the read-only text, so users can have clarity on what they need to type in. Here's a mockup of how it would look like using the form field with the Prepend option: image

Contributor guide

Research direction
Locate the query parameter fields for cluster health in the alerting dashboards plugin source code. Replace the static read only text with an OUI form row using the Prepend component. For example, use EuiFormRow with EuiFieldText and a prepend prop set to 'GET cat/snapshots/'. Ensure the prepend is non editable and the input field accepts the remainder of the path.
Tech stack
javascript
Domain
frontend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75