add configurable metrics listening cli option #3360
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
raychu86
requested changes
Jul 10, 2024
node/metrics/src/lib.rs
Outdated
| // Build the Prometheus exporter. | ||
| metrics_exporter_prometheus::PrometheusBuilder::new().install().expect("can't build the prometheus exporter"); | ||
| metrics_exporter_prometheus::PrometheusBuilder::new() | ||
| .with_http_listener(ip.unwrap_or(SocketAddr::from_str("0.0.0.0:9000").unwrap())) |
There was a problem hiding this comment.
I would prefer not to hard-code the default socketAddr like this - SocketAddr::from_str("0.0.0.0:9000).
Even if it's functionally the same as calling metrics_exporter_prometheus::PrometheusBuilder::new() now, if the defaults in PrometheusBuilder change in the future, we would need to manually perform the update.
Ideally, we keep the old syntax if ip is not specified here. Maybe with a match case.
There was a problem hiding this comment.
Makes perfect sense, will update after my work shift
raychu86
reviewed
Jul 10, 2024
raychu86
reviewed
Jul 10, 2024
HarukaMa
force-pushed
the
configurable-metrics
branch
from
a596ac0
to
069ce38
Compare
|
oops, forgot to clippy and there is an unused import |
HarukaMa
force-pushed
the
configurable-metrics
branch
from
069ce38
to
eecf2f1
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Add an snarkOS cli option to configure the listening host and port of the metrics exporter.
Although I think listening to 127.0.0.1 by default should be a better default value, I kept 0.0.0.0 to not break existing users (the previous default was hardcoded
0.0.0.0:9000). Same for the cli option name, although it's different from rest and cdn options. Lemme know if breaking backwards compatibility is acceptable there.Test Plan
Tested locally
Related PRs
(Link any related PRs here)