Overlay Telemetry Diagnostic Insights

Modified on Tue, 30 Jun at 10:01 AM

Overlay telemetry diagnostic insights help identify likely configuration areas to review for Hints, Banners, and Bookmarks. They can help troubleshoot repeated target element lookup failures, Visibility Rule issues, Segment visibility mismatches, expensive rules, text matching, slow registration, or frequent rule evaluation.

When To Use Diagnostic Insights

Use diagnostic insights when Overlay content appears inconsistently, loads slowly, or when Newired Support needs runtime evidence about why content may not register or evaluate efficiently.

Enable Telemetry For Debugging

Telemetry must be enabled before useful diagnostic data is collected.

newired.telemetry.enable()

When enabled, telemetry remains active with a one-day expiration that is refreshed while telemetry is initialized. This allows debugging to continue across page reloads during that period.

After debugging is finished, disable telemetry again.

newired.telemetry.disable()

Get Diagnostic Insights

Run the following command in the browser developer console:

newired.telemetry.getTipInsights()

Each insight may include:

  • message: short explanation of the detected condition.
  • recommendation: configuration area to review.
  • severity: diagnostic severity, such as info or warning.
  • supportingData: factual values used to produce the insight.

Use Insight Profiles

Insight profiles adjust how sensitive diagnostics are. To view available profiles and their thresholds, run:

newired.telemetry.getTipInsightProfiles()

To request insights with a specific profile, run:

newired.telemetry.getTipInsights({ profile: "high" })

Supported profiles:

  • low: more sensitive diagnostics.
  • medium: default profile.
  • high: intended for highly mutating pages.
  • critical: strongest signals only.

Optional Live Logging

Diagnostic insights are not printed automatically. To print new insights to the browser console during debugging, enable live logging:

newired.telemetry.startLiveLogging()

Stop live logging after debugging is finished:

newired.telemetry.stopLiveLogging()

Background Telemetry Data

Diagnostic insights are generated from raw telemetry events and aggregated statistics collected in memory during the current page session. These APIs are intended mainly for advanced troubleshooting or when Newired Support asks for additional evidence.

newired.telemetry.getEvents()
newired.telemetry.getTipStats()
newired.telemetry.getTipRuleStats()

Clear Current Telemetry Data

To clear current in-memory telemetry data and reset generated diagnostics for the current page session, run:

newired.telemetry.clearEvents()

Limitations

  • Telemetry must be enabled before data is collected.
  • Telemetry events, statistics, and diagnostic insights are stored only in memory for the current page session.
  • Diagnostic insights are conservative recommendations. They do not change content automatically.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article