Debugging with devtools
Debugging with devtools
Inspect the live augeo.event and augeo.ack streams on a host page.
The panel is opt-in and dependency-free.
It stays hidden by default.
The panel code loads only when you enable it.
Prerequisites
| Item | Requirement |
|---|---|
| Host page | Mounts the production loyalty concierge widget |
| Browser | Supports localStorage and the page console |
| Persona | loyalty-concierge only |
| Bundle global | window.AugeoChatSdkLoyaltyConcierge |
Load a production loyalty bundle and construct AugeoAssistant first.
See Quick start for the embed pattern.
See Events for the event model.
Version
| Constant | Value | Meaning |
|---|---|---|
| Event spec | augeo.event | Value of spec on every upward envelope |
| Ack spec | augeo.ack | Value of spec on every host ack |
| Spec version | 1.0 | Value of specversion |
| DOM event name | augeo.event | Upward CustomEvent name |
| Ack event name | augeo.ack | Downward CustomEvent name |
The panel uses the same version-gated path a host uses. It shows schema-matched compact envelopes.
Constants
| Name | Value | Role |
|---|---|---|
| Flag key | augeoChatSdk:devtools | Persist enablement across reloads |
| Console handle | window.__augeoChatSdkDevtools | Imperative open and close API |
| Flag enabled value | '1' | Value that turns the panel on |
These two entry points are the only stable public surface for the panel. Internal panel DOM and markup are not a contract.
Activation
Enable the panel with a persisted flag or with the console handle.
Persist the flag
Set the flag so the panel opens on every load until you remove it.
localStorage['augeoChatSdk:devtools'] = '1';Reload the page after you set the flag. The widget reads the flag when it mounts and opens the panel.
Clear the flag when you finish debugging.
localStorage.removeItem('augeoChatSdk:devtools');Open from the console
Call the console handle after the widget has mounted.
window.__augeoChatSdkDevtools.open();
window.__augeoChatSdkDevtools.close();Use open() for a one-session inspection without leaving the flag set.
Use close() to tear the panel down and restore host page padding.
Mount behavior
The panel mounts inside the widget shadow root.
It listens for augeo.event and augeo.ack.
You see the same compact envelopes a host receives.
Normal member sessions never fetch or run the panel module. The chunk loads only after you opt in.
Captured fields
Each row is one delivered envelope. Newest events appear first. The log keeps at most 200 rows.
Click a row to expand a collapsible JSON tree of the full envelope. The tree shows every field in contract order.
augeo.event
| Field | Description |
|---|---|
spec | Schema family id |
specversion | Envelope version |
id | Unique emission id |
type | Dictionary event name |
typeversion | Payload version for this type |
time | Emission time in epoch milliseconds |
class | observed or measured |
source | Surface and instance id |
subject | Optional subject |
gestureKey | Optional gesture key |
correlation | Optional join keys |
data | Occurrence and context |
augeo.ack
| Field | Description |
|---|---|
spec | Schema family id |
specversion | Envelope version |
eventId | Matching upward event.id |
effectId | Effect id when present |
time | Ack time in epoch milliseconds |
outcome | Host fulfilled or rejected |
context | Optional context bags |
The inspector mirrors the wire verbatim.
Nothing is hidden as a constant.
What you see matches subscribeAugeoEvents and subscribeAugeoAcks.
Each row summary shows type, class, a short id, and a timestamp.
Ack rows join on eventId.
Toolbar controls
| Control | Action |
|---|---|
| Search | Filters rows live across type, id, eventId, class, and payload JSON |
| Type filter | Narrows to one event type from types already seen |
| Dock | Anchors the panel to corner, bottom, or right |
| Clear | Empties the captured log |
| Hide/Show | Collapses to a title-bar pill or expands again |
| Close | Unsubscribes, removes the panel, and restores host padding |
The counter next to the title shows shown/total when a filter narrows the list.
Dock bottom or right reserves space on the host page. The page shifts so the panel never covers content. Corner dock floats without reserving page space.
Copy operations
Right-click any row to open the copy menu.
| Menu item | Copies |
|---|---|
| Copy event JSON | The full envelope for that row, pretty-printed |
| Copy event id | The emission id string only |
| Copy all events JSON | The entire captured array, pretty-printed |
Paste the JSON into a bug report or a local fixture. Copy is best-effort and never throws into the host page.
Persistence
These choices survive reloads while the flag stays set.
| Preference | Stored effect |
|---|---|
| Dock mode | Restores corner, bottom, or right |
| Collapsed state | Restores the title-bar pill when hidden |
| Floating box | Restores position and size for corner dock |
| Bottom height | Restores height when docked bottom |
| Right width | Restores width when docked right |
Size and position persist per dock mode. Clear site data if you need a clean panel layout.
Resize and move
Drag the title bar to move the panel in corner dock. Grab any edge or corner to resize in corner dock. Drag the top edge to change height when docked bottom. Drag the left edge to change width when docked right.
Stable entry points
Treat only these symbols as stable.
| Entry point | Contract |
|---|---|
localStorage['augeoChatSdk:devtools'] = '1' | Opt-in flag |
localStorage.removeItem('augeoChatSdk:devtools') | Opt-out |
window.__augeoChatSdkDevtools.open() | Open the panel |
window.__augeoChatSdkDevtools.close() | Close the panel |
Do not scrape panel class names or internal nodes. Those details can change without a version bump.
Related pages
| Page | Use it for |
|---|---|
| Common issues | Silent listeners, mount failures, and teardown |
| Events | Recommend-only model and safe subscribe flow |
| Analytics | Destination writers and gtag adapters |
| Event envelope | Compact field list |
| Event catalog | Names this widget emits |
| Acknowledgements | Host ack contract |
| Devtools | Inspector capability flags |
| Events v1 | Machine-readable event schema |
| API | Public helpers and types |