cube-js/cube

Need base Path for health-checks

Open

#4808 opened on Jun 27, 2022

View on GitHub
 (2 comments) (1 reaction) (0 assignees)Rust (19,563 stars) (1,965 forks)batch import
help wantedloggedreviewed

Description

Is your feature request related to a problem? Please describe.

Hi I am currently deploying Cubejs behing Nginx Proxy so I should add prefix path to the Node. As the basePath configuration works very well for /v1/load, I could not hit health-checks related endpoint, since the Nginx controller will re-route the request incorrectly.

Describe the solution you'd like I was wondering, could we add /basePath prefix to livez and readyz ?. Is there any specific consideration why we did not set this up in the first place ?

Other Endpoint References

Requested Endpoints to change

Contributor guide

Tech stack
javascriptnodejsrest api
Domain
backendapi
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 JavaScript/Node.jsunderstanding of health checksfamiliarity with CubeJS basePath
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Examine the CubeJS repository for health check endpoint definitions (e.g., `livez` and `readyz`). Look at how `basePath` is applied to other routes like `/v1/load`. The change involves adding the `basePath` prefix to these health check routes. Reference the issue comments for any additional context. The implementation is likely in a route definition file; search for 'livez' or 'readyz' in the codebase.