cube-js/cube

Need base Path for health-checks

Open

#4,808 opened on Jun 27, 2022

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

Repository metrics

Stars
 (19,563 stars)
PR merge metrics
 (Avg merge 5d 16h) (138 merged PRs in 30d)

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

Research direction
Investigate how Cube.js handles basePath for other endpoints and apply the same pattern to /livez and /readyz health check endpoints. Look at the server configuration and middleware to ensure the health check routes respect the basePath.
Tech stack
nodejstypescript
Domain
backendapidevops
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
GitNode.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70