Track TUI button telemetry#6346
Merged
Merged
Conversation
![corridor-security[bot]](https://avatars.githubusercontent.com/in/1177339?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary: This PR adds telemetry for fixed TUI button click events and does not introduce new authentication, authorization, data access, or externally controlled execution paths.
Risk: Low risk. No exploitable security vulnerabilities were identified because the added telemetry values are constant internal event names and failures are contained without exposing a security boundary.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThe PR adds telemetry spans for crew run TUI button clicks. It adds a core feature-usage span helper, wires the TUI to record trace and deploy clicks, and adds unit and smoke tests for the telemetry behavior. ChangesTUI telemetry click tracking
Sequence Diagram(s)sequenceDiagram
participant CrewRunApp
participant Telemetry
participant WebBrowser
CrewRunApp->>CrewRunApp: _record_tui_button_click(button_name)
CrewRunApp->>Telemetry: feature_usage_span("cli_usage:" + button_name)
Telemetry->>Telemetry: create "Feature Usage" span
Telemetry->>Telemetry: set_attribute("feature", feature)
Telemetry->>Telemetry: end()
alt btn-traces or btn-traces-done
CrewRunApp->>WebBrowser: open(trace_url)
else btn-deploy
CrewRunApp->>CrewRunApp: _want_deploy = True
CrewRunApp->>CrewRunApp: exit(_crew_result)
end
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
vinibrsl
approved these changes
Jun 26, 2026
lorenzejay
requested changes
Jun 26, 2026
lorenzejay
reviewed
Jun 26, 2026
Collaborator
Author
|
Addressed the review feedback in
Verification:
|
lorenzejay
approved these changes
Jun 26, 2026
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
lib/crewai-core/tests/test_smoke.py (1)
147-156: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winAssert the
crewai_versionattribute too.This test only locks down half of the new span shape. Since
feature_usage_span()now emits bothcrewai_versionandfeature, it’s worth asserting the version attribute here as well so that contract regressions fail in this smoke test.Suggested change
monkeypatch.setattr( "crewai_core.telemetry.trace.get_tracer", lambda _name: tracer, ) + monkeypatch.setattr( + "crewai_core.version.get_crewai_version", + lambda: "1.2.3", + ) telemetry = Telemetry() telemetry.feature_usage_span("cli_usage:view_traces") tracer.start_span.assert_called_once_with("Feature Usage") + span.set_attribute.assert_any_call("crewai_version", "1.2.3") span.set_attribute.assert_any_call("feature", "cli_usage:view_traces") span.end.assert_called_once()🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@lib/crewai-core/tests/test_smoke.py` around lines 147 - 156, The smoke test for Telemetry.feature_usage_span only verifies the feature attribute, but the span now also includes crewai_version. Update the assertions in test_smoke.py to check that the span created by Telemetry.feature_usage_span("cli_usage:view_traces") sets both feature and crewai_version, using the existing tracer/span mocks so this contract is covered by the test.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@lib/crewai-core/tests/test_smoke.py`:
- Around line 147-156: The smoke test for Telemetry.feature_usage_span only
verifies the feature attribute, but the span now also includes crewai_version.
Update the assertions in test_smoke.py to check that the span created by
Telemetry.feature_usage_span("cli_usage:view_traces") sets both feature and
crewai_version, using the existing tracer/span mocks so this contract is covered
by the test.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: c2f9171d-f917-4b64-8c34-421fb266afa1
📒 Files selected for processing (4)
lib/cli/src/crewai_cli/crew_run_tui.pylib/cli/tests/test_crew_run_tui.pylib/crewai-core/src/crewai_core/telemetry.pylib/crewai-core/tests/test_smoke.py
🚧 Files skipped from review as they are similar to previous changes (1)
- lib/cli/tests/test_crew_run_tui.py
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
3 participants
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.
Summary
TUI Button Clickedtelemetry span increwai-coreview_tracesanddeployclick events from the completed-run TUI buttonsVerification
uv run pytest lib/cli/tests/test_crew_run_tui.py lib/crewai-core/tests/test_smoke.pyuv run ruff check lib/cli/src/crewai_cli/crew_run_tui.py lib/cli/tests/test_crew_run_tui.py lib/crewai-core/src/crewai_core/telemetry.py lib/crewai-core/tests/test_smoke.pyuv run ruff format --check lib/cli/src/crewai_cli/crew_run_tui.py lib/cli/tests/test_crew_run_tui.py lib/crewai-core/src/crewai_core/telemetry.py lib/crewai-core/tests/test_smoke.pyNote
Low Risk
Opt-in style usage telemetry only; errors are caught and telemetry respects existing disable env vars, with no change to auth or deploy logic beyond recording clicks.
Overview
Adds anonymous feature-usage telemetry for post-run TUI sidebar actions.
crewai-core: NewTelemetry.feature_usage_span(feature)emits an OpenTelemetry Feature Usage span withcrewai_versionand afeatureattribute (e.g.cli_usage:view_traces), using the same safe/disabled-env behavior as other core spans.CLI TUI:
CrewRunApplazily initializesTelemetryand calls_record_tui_button_clickwhen View Traces (btn-traces/btn-traces-done) or Deploy is pressed, before the existing trace-open and deploy-exit behavior. Failures are swallowed so the UI keeps working.Tests: Unit tests assert the TUI passes the expected
cli_usage:*feature strings and that the core span name,featureattribute, andend()are correct.Reviewed by Cursor Bugbot for commit 5107624. Bugbot is set up for automated code reviews on this repo. Configure here.
Summary by CodeRabbit