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

cmd: don't bind debug endpoints by default #2808

Merged
merged 2 commits into from
Jan 22, 2024

Conversation

gsora
Copy link
Contributor

@gsora gsora commented Jan 22, 2024

Separate Prometheus from pprof/QBFT HTTP endpoint, and let user configure the listening address for them.

Added the --debug-address CLI argument, so that user can specify the IP/port combo that suite them better.

If no --debug-address is specified, don't bind debug endpoints.

category: refactor
ticket: none

gsora added 2 commits January 22, 2024 10:38
Separate Prometheus from pprof/QBFT HTTP endpoint, and let user
configure the listening address for them.

Added the `--debug-addr` CLI argument, so that user can specify the IP/port
combo that suite them better.

If no `--debug-addr` is specified, don't bind debug endpoints.
@gsora gsora added the v0.19.1 label Jan 22, 2024
@gsora gsora requested review from pinebit, dB2510 and xenowits January 22, 2024 09:44
Copy link

Quality Gate Passed Quality Gate passed

The SonarCloud Quality Gate passed, but some issues were introduced.

1 New issue
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@OisinKyne
Copy link
Contributor

Copy link
Contributor

@dB2510 dB2510 left a comment

Choose a reason for hiding this comment

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

We will need to update our core team cluster and CDVN in line with this change.

@@ -139,6 +139,7 @@ Usage:
Flags:
--beacon-node-endpoints strings Comma separated list of one or more beacon node endpoint URLs.
--builder-api Enables the builder api. Will only produce builder blocks. Builder API must also be enabled on the validator client. Beacon node must be connected to a builder-relay to access the builder network.
--debug-address string Listening address (ip and port) for the pprof and QBFT debug API.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Worth to mention it is disabled by default.

@gsora
Copy link
Contributor Author

gsora commented Jan 22, 2024

ObolNetwork/obol-docs#299 docs PR

Copy link

codecov bot commented Jan 22, 2024

Codecov Report

Attention: 24 lines in your changes are missing coverage. Please review.

Comparison is base (77050fc) 53.29% compared to head (aa5ca18) 53.25%.

Files Patch % Lines
app/monitoringapi.go 0.00% 23 Missing ⚠️
app/app.go 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2808      +/-   ##
==========================================
- Coverage   53.29%   53.25%   -0.05%     
==========================================
  Files         199      199              
  Lines       27680    27694      +14     
==========================================
- Hits        14753    14748       -5     
- Misses      11097    11118      +21     
+ Partials     1830     1828       -2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@xenowits xenowits left a comment

Choose a reason for hiding this comment

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

LGTM!

@gsora gsora added the merge when ready Indicates bulldozer bot may merge when all checks pass label Jan 22, 2024
@obol-bulldozer obol-bulldozer bot merged commit 1b2703a into main Jan 22, 2024
16 checks passed
@obol-bulldozer obol-bulldozer bot deleted the gsora/dont-bind-profile branch January 22, 2024 12:29
@gsora gsora added the qs-audit label Jan 22, 2024
gsora added a commit that referenced this pull request Jan 24, 2024
Same principle as #2808.

Refactor the binding functions to be usable across multiple commands.
obol-bulldozer bot pushed a commit that referenced this pull request Jan 24, 2024
Same principle as #2808.

Refactor the binding functions to be usable across multiple commands.

category: refactor
ticket: none
gsora added a commit that referenced this pull request Jan 24, 2024
Separate Prometheus from pprof/QBFT HTTP endpoint, and let user configure the listening address for them.

Added the `--debug-address` CLI argument, so that user can specify the IP/port combo that suite them better.

If no `--debug-address` is specified, don't bind debug endpoints.

category: refactor
ticket: none
gsora added a commit that referenced this pull request Jan 24, 2024
Same principle as #2808.

Refactor the binding functions to be usable across multiple commands.

category: refactor
ticket: none
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merge when ready Indicates bulldozer bot may merge when all checks pass qs-audit v0.19.1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants