Skip storing telemetry metadata when emission is disabled#2278
Merged
Conversation
Avoid unnecessary computation and storage of telemetry metadata when telemetry is disabled via should_emit() check.
Verify that __cosmos_telemetry_metadata__ is not stored in DAG params when telemetry is disabled (should_emit returns False).
✅ Deploy Preview for astronomer-cosmos canceled.
|
pankajkoti
force-pushed
the
fix/skip-telemetry-metadata-when-disabled
branch
from
addfbe7 to
0e0de78
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2278 +/- ##
=======================================
Coverage 98.01% 98.01%
=======================================
Files 100 100
Lines 6414 6414
=======================================
Hits 6287 6287
Misses 127 127 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR optimizes the telemetry metadata storage logic by adding an early return when telemetry is disabled, preventing unnecessary processing overhead from metadata compression and storage operations.
Changes:
- Added early return check in
_store_cosmos_telemetry_metadata_on_dagto skip processing whenshould_emit()returns False - Added test coverage to verify metadata is not stored when telemetry is disabled
- Updated existing tests with
should_emitmocks to ensure proper telemetry state during test execution
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| cosmos/converter.py | Added early return check using should_emit() to skip telemetry metadata processing when disabled |
| tests/test_converter.py | Added new test for telemetry disabled case and updated existing test with telemetry enabled mock |
| tests/listeners/test_dag_run_listener.py | Added should_emit mocks to ensure tests run with telemetry explicitly enabled |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
tatiana
approved these changes
Jan 23, 2026
Collaborator
tatiana
left a comment
tatiana
left a comment
There was a problem hiding this comment.
Looks great, thanks a lot, @pankajkoti !
Merged
tatiana
added a commit
that referenced
this pull request
Jan 30, 2026
Features * Support cross-referencing models across dbt projects using dbt-loom by @pankajkoti in #2271 * Support use of YAML selectors when using ``LoadMode.DBT_MANIFEST`` by @YourRoyalLinus in #2261 * Introduce ``ExecutionMode.WATCHER_KUBERNETES`` to use the watcher with ``KubernetesPodOperator`` by @tatiana in #2207 * Add support for StarRocks profile mapping by @kurkim0661 in #2256 * Allow pushing URIs as XComs for Cosmos tasks by @corsettigyg in #2275 * Support defining custom callbacks alongside the ``WATCHER_KUBERNETES`` callback by @johnhoran in #2307 Enhancements * Refactor: remove duplicate ``_construct_dest_file_path`` by @jx2lee in #2077 * Leverage Airflow ``::group::`` to group logs associated with DAG parsing by @tatiana in #2235 * Refactor ``DbtConsumerWatcherSensor`` for reusability by @tatiana in #2245 * Restore plain text output when using ``ExecutionMode.WATCHER`` by @tiovader in #2241 Bug Fixes * Fix running empty models or ephemeral nodes in ``ExecutionMode.WATCHER`` by @tatiana in #2279 * Improve watcher producer task priority in scheduling and the UI by @tatiana in #2237 * Fix typos and formatting issues in documentation by @pankajkoti in #2259 * Allow watcher producer retries without erroring by @tatiana in #2283 * Fix ``TestBehavior.AFTER_ALL`` is missing project_name information when loading project using manifest file by @tuantran0910 in #2242 * Fix duplicate log lines in watcher subprocess execution and format timestamps by @pankajkoti in #2301 Docs * Add Watcher Kubernetes documentation by @tatiana in #2303 * Document newly added telemetry metrics in the privacy notice by @pankajkoti in #2249 * Add compatibility policy document by @pankajastro in #2251 * Improve watcher documentation related to dbt threads by @tatiana in #2273 * Fix link in watcher execution mode documentation by @jedcunningham in #2277 * Update Apache Airflow minimum compatibility policy by @tatiana in #2285 * Clarify Cosmos runtime support until "End of Basic Support" by @jedcunningham in #2286 * Update watcher docs by @tatiana in #2298 * Update watcher kubernetes documentation by @tatiana in #2306 Others * Add Airflow 3 DAG versioning tests for Cosmos by @michal-mrazek in #2177 * Add dbt Core 1.11 to the test matrix by @tatiana in #2230 * Add integration tests using InvocationMode.SUBPROCESS and validate output by @tatiana in #2287 * Fix main branch failing tests by @tatiana in #2296 * Update pre-commit hooks to the latest versions by @jedcunningham in #2289 * Pre-commit autoupdates by @pre-commit in #2222, #2264, #2274 and #2290 * Dependabot updates by @dependabot in #2218, #2219, #2220, #2280 and #2284 * Add Scarf metrics to understand Cosmos feature usage patterns - Add telemetry tracking for dbt docs plugin usage by @pankajkoti in #2240 - Add DAG run telemetry metrics for load mode, invocation, and render_config parameters by @pankajkoti in #2223 - Collect profile metrics for DAG runs by @pankajastro in #2228 - Compress telemetry metadata to reduce serialized DAG size by @pankajkoti in #2252 - Skip storing telemetry metadata when emission is disabled by @pankajkoti in #2278 - Hide telemetry metadata parameters from the Airflow trigger UI by @pankajkoti in #2247 closes: astronomer/oss-integrations-private#317 --------- Co-authored-by: Tatiana Al-Chueyr <tatiana.alchueyr@gmail.com>
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 _store_dag_telemetry_metadata method in DbtToAirflowConverter was performing unnecessary processing even when telemetry was disabled. This included compressing metadata and storing it in DAG params, which adds overhead without benefit when telemetry collection is turned off.
The PR adds an early return check in
_store_dag_telemetry_metadatato skip all processing whenshould_emit()returns False. This ensures telemetry-related operations only occur when telemetry is actually enabled.related: #2223
related: #2109