Augeo AI Docs
SDKsTroubleshooting

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

ItemRequirement
Host pageMounts the production loyalty concierge widget
BrowserSupports localStorage and the page console
Personaloyalty-concierge only
Bundle globalwindow.AugeoChatSdkLoyaltyConcierge

Load a production loyalty bundle and construct AugeoAssistant first. See Quick start for the embed pattern. See Events for the event model.

Version

ConstantValueMeaning
Event specaugeo.eventValue of spec on every upward envelope
Ack specaugeo.ackValue of spec on every host ack
Spec version1.0Value of specversion
DOM event nameaugeo.eventUpward CustomEvent name
Ack event nameaugeo.ackDownward CustomEvent name

The panel uses the same version-gated path a host uses. It shows schema-matched compact envelopes.

Constants

NameValueRole
Flag keyaugeoChatSdk:devtoolsPersist enablement across reloads
Console handlewindow.__augeoChatSdkDevtoolsImperative 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

FieldDescription
specSchema family id
specversionEnvelope version
idUnique emission id
typeDictionary event name
typeversionPayload version for this type
timeEmission time in epoch milliseconds
classobserved or measured
sourceSurface and instance id
subjectOptional subject
gestureKeyOptional gesture key
correlationOptional join keys
dataOccurrence and context

augeo.ack

FieldDescription
specSchema family id
specversionEnvelope version
eventIdMatching upward event.id
effectIdEffect id when present
timeAck time in epoch milliseconds
outcomeHost fulfilled or rejected
contextOptional 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

ControlAction
SearchFilters rows live across type, id, eventId, class, and payload JSON
Type filterNarrows to one event type from types already seen
DockAnchors the panel to corner, bottom, or right
ClearEmpties the captured log
Hide/ShowCollapses to a title-bar pill or expands again
CloseUnsubscribes, 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 itemCopies
Copy event JSONThe full envelope for that row, pretty-printed
Copy event idThe emission id string only
Copy all events JSONThe 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.

PreferenceStored effect
Dock modeRestores corner, bottom, or right
Collapsed stateRestores the title-bar pill when hidden
Floating boxRestores position and size for corner dock
Bottom heightRestores height when docked bottom
Right widthRestores 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 pointContract
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.

PageUse it for
Common issuesSilent listeners, mount failures, and teardown
EventsRecommend-only model and safe subscribe flow
AnalyticsDestination writers and gtag adapters
Event envelopeCompact field list
Event catalogNames this widget emits
AcknowledgementsHost ack contract
DevtoolsInspector capability flags
Events v1Machine-readable event schema
APIPublic helpers and types