grafana/pyroscope

UI should show better error when connecting to UI at wrong components

Open

#2748 opened on Nov 22, 2023

View on GitHub
 (0 comments) (1 reaction) (0 assignees)C (9,041 stars) (528 forks)batch import
frontendgood first issuehelp wanted

Description

Currently when opening the UI in micro-services mode and you pick a component that is not a querier or query-frontend, we show 405 errors (as the local query APIs are unavailable). Instead we should direct the user to connect to the query-frontend instead.

The only useful UI functions are probably the admin ones in this case

Contributor guide

Tech stack
javascripttypescriptreact
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.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic understanding of React componentsFamiliarity with error handling patterns
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Investigate the current error handling in the UI, particularly the API call that returns 405 errors. Look at the UI components responsible for displaying query errors, likely in the frontend directory. The improvement should detect when a user connects to a non query component and instead show a message directing them to the query frontend. Examine existing error handling logic in files like 'src/components/QueryError.jsx' or similar to understand the pattern.