Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(metrics): Add custom prometheus port support and log entry #61

Merged
merged 4 commits into from
Feb 11, 2025

Conversation

reversesigh
Copy link
Contributor

This allows an environment variable to specify a port for prometheus in case 8080 cannot be used. It's been tested without the variable and defaults to 8080, and tested with a custom port. The log will accurately post which port prometheus is using after the binary starts.

@reversesigh reversesigh requested a review from a team as a code owner February 11, 2025 14:56
Copy link
Contributor

coderabbitai bot commented Feb 11, 2025

📝 Walkthrough

Walkthrough

The changes modify the environment configuration and the server startup process. The .env.example file now includes a new environment variable METRICS_PORT with the value "8080" and reformats the existing VALIDATOR_ADDRESS for consistency. In cmd/root.go, the server's port setting is refactored to use the METRICS_PORT environment variable rather than a hardcoded port, defaulting to "8080" if unset. Additionally, a log message has been introduced to notify users of the port on which the metrics server is initiating.

Changes

File(s) Change Summary
.env.example Added METRICS_PORT="8080"; reformatted VALIDATOR_ADDRESS for consistency.
cmd/root.go Refactored metrics server port to use METRICS_PORT from the environment (defaulting to "8080"); added a log message for port information.

Sequence Diagram(s)

sequenceDiagram
    participant App as Application
    participant Env as Environment
    participant Log as Logger
    participant HTTP as HTTP Server

    App->>Env: Read METRICS_PORT
    Env-->>App: Return custom port or null
    App->>App: Set metricsPort (custom or "8080")
    App->>Log: Log chosen port
    App->>HTTP: Start server on metricsPort
Loading

Poem

I hopped through lines of code so neat,
Tweaking variables with a beat.
METRICS_PORT now leads the way,
Logging its tune at the break of day.
A cheerful hop, a joyful code,
Celebrations on this merry road! 🐰🎉


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 041b248 and 21b8059.

📒 Files selected for processing (1)
  • cmd/root.go (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • cmd/root.go

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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f2de02b and 041b248.

📒 Files selected for processing (2)
  • .env.example (1 hunks)
  • cmd/root.go (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • .env.example
🧰 Additional context used
🪛 golangci-lint (1.62.2)
cmd/root.go

77-77: Error return value of http.ListenAndServe is not checked

(errcheck)

🔇 Additional comments (1)
cmd/root.go (1)

71-75: LGTM!

The implementation of custom port support through the environment variable is clean and maintains backward compatibility with the default port 8080. The added log message provides clear visibility into which port is being used.

cmd/root.go Outdated Show resolved Hide resolved
@k-yang k-yang changed the title Add custom prometheus port support and log entry feat(metrics): Add custom prometheus port support and log entry Feb 11, 2025
@k-yang k-yang merged commit 3961eb5 into NibiruChain:main Feb 11, 2025
5 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants