refactor(server/v2/telemetry): swap redirects #22520
Conversation
julienrbrt
requested review from
hieuvubk,
kocubinski and
a team
as code owners
📝 WalkthroughWalkthroughThe changes in this pull request involve modifications to the Changes
Sequence Diagram(s)sequenceDiagram
participant Client
participant Server
Client->>Server: Request to /
Server->>Client: Redirect to /metrics
Client->>Server: Request to /metrics
Server->>Client: Return metrics data
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
github-actions
bot
added
C:server/v2
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
server/v2/api/telemetry/server.go (1)
70-73: Consider adding security middleware for the metrics endpoint.Since metrics endpoints can be sensitive and resource-intensive, consider implementing:
- Rate limiting to prevent DoS
- Basic authentication or API key validation
- CORS policies if needed
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
📒 Files selected for processing (1)
server/v2/api/telemetry/server.go(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
server/v2/api/telemetry/server.go (1)
Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.
🔇 Additional comments (1)
server/v2/api/telemetry/server.go (1)
70-73: LGTM! Clean implementation of the metrics endpoint redirection.
The changes correctly implement the canonical Prometheus metrics endpoint pattern by:
- Defining
/metricsas the primary endpoint - Implementing a permanent redirect from root to
/metrics - Adding clear documentation about the standard path
The implementation follows best practices and the Uber Golang style guide.
Description
Didn't know that /metrics was the canonical way to name the endpoint.
This redirects / to /metrics instead of the revert as discussed on Slack
Author Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
!in the type prefix if API or client breaking changeCHANGELOG.mdReviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.
I have...
Summary by CodeRabbit