[flyteagent][CLI] Make agent prometheus port configurable #3064
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
Signed-off-by: Future-Outlier <[email protected]>
Future-Outlier
requested review from
wild-endeavor,
kumare3,
eapolinario,
pingsutw,
cosmicBboy,
samhita-alla and
thomasjpfan
as code owners
Code Review Agent Run #9cfb00Actionable Suggestions - 2
Review Details
AI Code Review powered by |
Signed-off-by: Future-Outlier <[email protected]>
Changelist by BitoThis pull request implements the following key changes.
|
flyte-bot
reviewed
Jan 16, 2025
| @@ -45,20 +52,20 @@ def serve(ctx: click.Context): | |||
| "for testing.", | |||
| ) | |||
| @click.pass_context | |||
| def agent(_: click.Context, port, worker, timeout): | |||
| def agent(_: click.Context, port, prometheus_port, worker, timeout): | |||
There was a problem hiding this comment.
Consider adding port validation checks
Consider validating the prometheus_port parameter to ensure it doesn't conflict with the main port parameter and is within valid port range (0-65535). A similar issue was also found in flytekit/clis/sdk_in_container/serve.py (line 83).
Code suggestion
Check the AI-generated fix before applying
@@ -55,2 +55,6 @@
def agent(_: click.Context, port, prometheus_port, worker, timeout):
+ if not 0 <= prometheus_port <= 65535:
+ raise ValueError(f'prometheus_port {prometheus_port} is not in valid range (0-65535)')
+ if prometheus_port == port:
+ raise ValueError(f'prometheus_port {prometheus_port} conflicts with main service port {port}')
"""
Code Review Run #9cfb00
Is this a valid issue, or was it incorrectly flagged by the Agent?
- it was incorrectly flagged
flyte-bot
reviewed
Jan 16, 2025
| from flytekit.extend.backend.agent_service import AgentMetadataService, AsyncAgentService, SyncAgentService | ||
|
|
||
| click.secho("🚀 Starting the agent service...") | ||
| _start_http_server() | ||
| _start_http_server(prometheus_port) |
There was a problem hiding this comment.
Consider adding error handling for port
Consider adding error handling around _start_http_server(prometheus_port) call to gracefully handle port binding failures.
Code suggestion
Check the AI-generated fix before applying
Suggested change
| _start_http_server(prometheus_port) | |
| try: | |
| _start_http_server(prometheus_port) | |
| except OSError as e: | |
| click.secho(f"Failed to start prometheus server on port {prometheus_port}: {e}", fg="red") | |
| raise |
Code Review Run #9cfb00
Is this a valid issue, or was it incorrectly flagged by the Agent?
- it was incorrectly flagged
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3064 +/- ##
===========================================
+ Coverage 51.36% 82.79% +31.43%
===========================================
Files 202 3 -199
Lines 21367 186 -21181
Branches 2746 0 -2746
===========================================
- Hits 10975 154 -10821
+ Misses 9792 32 -9760
+ Partials 600 0 -600 ☔ View full report in Codecov by Sentry. |
Code Review Agent Run Status
|
eapolinario
reviewed
Jan 16, 2025
| default="9090", | ||
| is_flag=False, | ||
| type=int, | ||
| help="Grpc port for the agent service", |
Signed-off-by: Future-Outlier <[email protected]> Co-authored-by: Eduardo Apolinario <[email protected]>
Code Review Agent Run Status
|
Signed-off-by: Future-Outlier <[email protected]>
Code Review Agent Run #6c3b01Actionable Suggestions - 0Review Details
AI Code Review powered by |
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.
Tracking issue
flyteorg/flyte#3936
Why are the changes needed?
we want to make Prometheus port configurable so that we can have more flexibility.
What changes were proposed in this pull request?
add a
How was this patch tested?
--prometheus_portoption to theserve agentcommand, enabling users to define a custom port for the Prometheus metrics server._start_grpc_serverfunction to utilize the configurable Prometheus port instead of the default value.Setup process
Screenshots
Check all the applicable boxes
Related PRs
Docs link
Summary by Bito
This PR implements configurable Prometheus metrics port functionality in the Flyte agent service, introducing a '--prometheus_port' CLI option (default: 9090) with validation checks. The changes include updated CLI help text to clearly distinguish between Prometheus metrics and GRPC ports, improving service configurability and user experience.Unit tests added: False
Estimated effort to review (1-5, lower is better): 1