Add option to expose git-sync metrics port#69703
Open
PreethamSanji wants to merge 1 commit into
Open
Conversation
|
Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contributors' Guide
|
ca7265a to
913655a
Compare
This file contains hidden or 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
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.
The git-sync sidecar can serve Prometheus metrics via its built-in HTTP server
(
GITSYNC_HTTP_METRICS), but the chart provides no way to declare that port onthe container, so the metrics endpoint cannot be discovered or scraped.
This PR adds a
dags.gitSync.metrics.enabledoption (defaultfalse). Whenenabled, the git-sync sidecar container gets:
GIT_SYNC_HTTP_METRICS/GITSYNC_HTTP_METRICSenv vars set to"true"gitsync-metricsbound to the existingdags.gitSync.httpPortvalue, so the declared port can never drift from thebind address
The init container is unaffected (it runs no HTTP server). With the option
disabled (default), rendered manifests are identical to
main.Rendered output with
dags.gitSync.metrics.enabled=true:With default values, no ports section or metrics env vars are rendered
(verified via
helm templatebefore/after comparison).Exposing the metrics via a dedicated Service or scrape annotations is
intentionally left out of scope, per the open design question on the issue —
happy to add it here or in a follow-up based on maintainer preference.
Unit tests added in
test_git_sync_scheduler.pycovering: port + env renderingwhen enabled, port following a custom
httpPort, and no rendering by default.closes: #62592
Was generative AI tooling used to co-author this PR?
Claude Fable 5
Generated-by: [Claude Fable 5] following the guidelines
{pr_number}.significant.rst, in airflow-core/newsfragments. You can add this file in a follow-up commit after the PR is created so you know the PR number.