Rum-12060: Move RUM Debug Widget code from rum module to a new separate module by kikoveiga · Pull Request #2960 · DataDog/dd-sdk-android

kikoveiga · 2025-10-21T16:25:43Z

What does this PR do?

Moves the RUM Debug Widget code from dd-sdk-android-rum to a new module dd-sdk-android-rum-debug-widget.
Decouples the widget UI (LocalInsightsOverlay) and the InsightsCollector interface implementation (DefaultInsightsCollector) from the core RUM SDK.
Introduces a clean integration point so the widget can observe the active RUM insights without tight coupling.

Motivation

Reduce coupling between the RUM core and debug tools.
Optional inclusion of the new module into release builds.
Customers can build their own UI overlay and provide their own InsightsCollector implementation.

Review checklist (to be filled by reviewers)

Feature or bugfix MUST have appropriate tests (unit, integration, e2e)
Make sure you discussed the feature or bugfix with the maintaining team in an Issue
Make sure each commit and the PR mention the Issue number (cf the CONTRIBUTING doc)

datadog-official · 2025-10-21T17:43:35Z

🎯 Code Coverage
• Patch Coverage: 100.00%
• Total Coverage: 69.98% (-0.16%)

View detailed report

_{This comment will be updated automatically if new data arrives.

🔗 Commit SHA: 429cca6 | Docs | Datadog PR Page | Was this helpful? Give us feedback!}

codecov-commenter · 2025-10-21T17:53:26Z

Codecov Report

❌ Patch coverage is 33.33333% with 6 lines in your changes missing coverage. Please review.
✅ Project coverage is 70.14%. Comparing base (44ff748) to head (429cca6).

Files with missing lines	Patch %	Lines
...rnal/instrumentation/insights/InsightsCollector.kt	0.00%	4 Missing ⚠️
...om/datadog/android/insights/LocalInsightOverlay.kt	0.00%	1 Missing ⚠️
...kotlin/com/datadog/android/rum/RumConfiguration.kt	0.00%	1 Missing ⚠️

Additional details and impacted files

@@                             Coverage Diff                              @@
##           tvaleev/feature/innovation-week-07-04-25    #2960      +/-   ##
============================================================================
+ Coverage                                     70.09%   70.14%   +0.05%     
============================================================================
  Files                                           838      839       +1     
  Lines                                         30767    30770       +3     
  Branches                                       5231     5232       +1     
============================================================================
+ Hits                                          21564    21581      +17     
- Misses                                         7724     7731       +7     
+ Partials                                       1479     1458      -21

Files with missing lines	Coverage Δ
...tadog/android/insights/DefaultInsightsCollector.kt	`0.00% <ø> (ø)`
...g/android/insights/internal/InsightStateStorage.kt	`0.00% <ø> (ø)`
.../android/insights/internal/domain/TimelineEvent.kt	`0.00% <ø> (ø)`
...droid/insights/internal/extensions/AnimationExt.kt	`0.00% <ø> (ø)`
...og/android/insights/internal/extensions/LangExt.kt	`0.00% <ø> (ø)`
...dog/android/insights/internal/widgets/ChartView.kt	`0.00% <ø> (ø)`
...oid/insights/internal/widgets/DragTouchListener.kt	`0.00% <ø> (ø)`
.../android/insights/internal/widgets/TimelineView.kt	`0.00% <ø> (ø)`
...lin/com/datadog/android/rum/internal/RumFeature.kt	`90.29% <100.00%> (+0.68%)`	⬆️
...om/datadog/android/insights/LocalInsightOverlay.kt	`0.00% <0.00%> (ø)`
... and 2 more

... and 35 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

…a/RUM-12060/move-widget-code

jonathanmos · 2025-10-30T09:00:21Z

+It is intended for debugging and development purposes only and **should not** be included in production builds.
+As shown in the screenshot below, the widget provides a floating overlay that displays key metrics such as **memory usage**, **CPU load** and **RUM events**.
+
+<img src="../../docs/images/screenshot_rumdebugwidget.png" width="400" alt="Datadog RUM Debug Widget"/>


minor: we should probably include details about the api call needed for integration
(.setInsightsCollector(DefaultInsightsCollector()))

Good idea, yes. I think it's best to add it on RUM-12062 as the configuration will change there.

jonathanmos · 2025-10-30T09:15:13Z

+    /**
+     * The nullable singleton [InsightsCollector] instance.
+     */
+    val insightsCollector: InsightsCollector? = (Datadog.getInstance() as? InternalSdkCore)


Question: This is a val in a singleton. If when first accessed the insightsCollector is null, will it recompute the instance when accessed again?

It won't recompute. For that, we'd need to use a custom get(), should we do that?

0xnm · 2025-10-30T16:30:42Z

 @InternalApi
 @ExperimentalRumApi


If it is exposed as a part of public API, it shouldn't have @InternalApi annotation. Should it be a part of public API?

Yes, as it's used in SampleApplication and intended to be used in the customers' applications in the future. Removed the @InternalApi notation.

0xnm · 2025-10-30T16:31:37Z

-
    private var isPaused: Boolean = false

+    private val insightsCollector: DefaultInsightsCollector?


do we need a singleton if we are in the same module?

This was the solution found for now, but it will be refactored and improved in RUM-12062.

0xnm · 2025-10-30T16:32:30Z

should this class be a part of public API?

Yes for now, as it's being used in the Sample app's NavActivity and JetpackComposeActivity. After RUM-12062 this will be no longer needed so I intend to make it internal.

0xnm · 2025-10-30T16:33:03Z

If we are adding a new public module, it should be added to the publish jobs in CI.

Added configuration for this module in default-pipeline.yml and local_ci.sh.

0xnm · 2025-10-30T16:34:22Z

+ * Provides the [InsightsCollector] instance inside the SDK, making it accessible to other modules.
+ */
+@InternalApi
+object InsightsCollectorProvider {


Do we need this singleton? If yes, I guess it shouldn't be public?

This was the solution found for now, but it will be refactored and improved in RUM-12062.

RUM-12060: Move the widget code to a new separate module

f88bc2f

kikoveiga changed the title ~~Kikoveiga/rum 12060/move widget code~~ Rum-12060: Move RUM Debug Widget code from rum module to a new separate module Oct 21, 2025

kikoveiga changed the base branch from develop to kikoveiga/RUM-12060/fix-widget-code October 21, 2025 16:29

RUM-12060: Fix unit tests

c2b823a

RUM-12060: Remove unused dependencies in the rum-debug-widget module

10b2afd

Base automatically changed from kikoveiga/RUM-12060/fix-widget-code to tvaleev/feature/innovation-week-07-04-25 October 23, 2025 12:57

kikoveiga and others added 3 commits October 23, 2025 14:04

RUM-12060: Update transitiveDependencies

15d7163

Merge branch 'tvaleev/feature/innovation-week-07-04-25' into kikoveig…

6ce6a20

…a/RUM-12060/move-widget-code

RUM-12060: Remove repeated line

2135cc5

satween reviewed Oct 28, 2025

View reviewed changes

kikoveiga added 5 commits October 28, 2025 17:53

RUM-12060: Update README.md

a202d2b

RUM-12060: Cut screenshot

4368fb0

RUM-12060: Update screenshot

49b1d18

RUM-12060: Update screenshot

17d4487

RUM-12060: Format README.md

e3994e4

kikoveiga marked this pull request as ready for review October 28, 2025 19:02

kikoveiga requested review from a team as code owners October 28, 2025 19:03

RUM-12060: Push requested changes

c7be4f6

hestonhoffman approved these changes Oct 28, 2025

View reviewed changes

RUM-12060: Update apiSurface

f741c7d

kikoveiga requested a review from satween October 29, 2025 09:25

kikoveiga self-assigned this Oct 29, 2025

jonathanmos reviewed Oct 30, 2025

View reviewed changes

kikoveiga requested a review from jonathanmos October 30, 2025 14:55

0xnm reviewed Oct 30, 2025

View reviewed changes

RUM-12062: Push suggested changes

391473c

kikoveiga added 5 commits October 31, 2025 10:25

RUM-12060: Move EvictingQueue.kt back to the internal module

0561093

RUM-12060: Add pipeline to new module

1b8e542

RUM-12060: Rollback

ab72128

RUM-12060: Rollback changes

7245287

RUM-12060: Add new line

eedb23e

kikoveiga requested a review from 0xnm October 31, 2025 12:02

0xnm approved these changes Oct 31, 2025

View reviewed changes

Comment thread features/dd-sdk-android-rum-debug-widget/build.gradle.kts Outdated

RUM-12060: Remove suggested block

429cca6

0xnm approved these changes Oct 31, 2025

View reviewed changes

kikoveiga merged commit bcbb712 into tvaleev/feature/innovation-week-07-04-25 Nov 3, 2025
25 checks passed

kikoveiga deleted the kikoveiga/RUM-12060/move-widget-code branch November 3, 2025 09:36

ncreated restored the kikoveiga/RUM-12060/move-widget-code branch April 9, 2026 10:20

0xnm deleted the kikoveiga/RUM-12060/move-widget-code branch April 24, 2026 09:43


		private var isPaused: Boolean = false

		private val insightsCollector: DefaultInsightsCollector?

Uh oh!

Conversation

kikoveiga commented Oct 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Motivation

Review checklist (to be filled by reviewers)

Uh oh!

datadog-official Bot commented Oct 21, 2025 • edited by datadog-datadog-prod-us1 Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov-commenter commented Oct 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

kikoveiga commented Oct 21, 2025 •

edited

Loading

datadog-official Bot commented Oct 21, 2025 •

edited by datadog-datadog-prod-us1 Bot

Loading

codecov-commenter commented Oct 21, 2025 •

edited

Loading