Skip to main content

DebugPanel

调试面板组件,用于开发阶段查看事件和状态。

基本用法

import {PilotKit, DebugPanel} from '@bdky/aaas-pilot-kit-react-widget';

function App() {
return (
<PilotKit {...props}>
<DebugPanel
show={process.env.NODE_ENV === 'development'}
position="bottom-right"
/>
</PilotKit>
);
}

功能

DebugPanel 可以显示以下信息:

  • 事件日志:SDK 触发的各种事件(ready、asrMessage、conversationChange 等)
  • 状态变化:isReady、isMuted、isRendering 等状态
  • 性能指标:TTFT(首字延迟)等性能数据

Props

属性类型默认值说明
showbooleanfalse是否显示面板
position'top-left' | 'top-right' | 'bottom-left' | 'bottom-right''bottom-right'面板位置
classNamestring-自定义类名
styleCSSProperties-自定义样式
featuresobject见下方启用的功能
maxLogsnumber100最大日志条数

features 配置

<DebugPanel
show
features={{
events: true, // 显示事件日志
performance: true, // 显示性能指标
state: true // 显示状态变化(每5秒)
}}
/>
属性类型默认值说明
eventsbooleantrue是否显示事件日志
performancebooleantrue是否显示性能指标
statebooleantrue是否显示状态变化

日志类型

面板中的日志按类型区分颜色:

类型颜色说明
event蓝色SDK 事件
state绿色状态变化
performance黄色性能指标

交互功能

  • Clear 按钮:清空所有日志
  • 折叠/展开:点击 ▼/▲ 按钮切换面板大小

样式定制

类名说明
.apk-debug-panel根容器
.apk-debug-panel--expanded展开状态
.apk-debug-panel--collapsed折叠状态
.apk-debug-panel--top-left左上位置
.apk-debug-panel--top-right右上位置
.apk-debug-panel--bottom-left左下位置
.apk-debug-panel--bottom-right右下位置
.apk-debug-panel__header头部区域
.apk-debug-panel__title标题
.apk-debug-panel__actions操作按钮区域
.apk-debug-panel__button按钮
.apk-debug-panel__content内容区域
.apk-debug-panel__log单条日志
.apk-debug-panel__log--event事件日志
.apk-debug-panel__log--state状态日志
.apk-debug-panel__log--performance性能日志
.apk-debug-panel__log-time时间戳
.apk-debug-panel__log-type类型标签
.apk-debug-panel__log-message消息内容
.apk-debug-panel__log-data数据详情
.apk-debug-panel__empty空状态

使用建议

仅在开发环境使用

DebugPanel 会持续监听事件和状态,可能影响性能。建议仅在开发环境启用:

<DebugPanel show={process.env.NODE_ENV === 'development'} />

监听的事件

DebugPanel 会自动监听以下事件:

事件说明
onReadySDK 就绪
onAsrStartASR 开始
onAsrMessageASR 识别结果
onRenderStart开始播报
onInactivity用户无操作
onBusy系统繁忙
onInterrupt播报打断
onConversationChange对话变化
onIsRenderingChange播报状态变化
onReplyStart回复开始
onTtft首字延迟指标

相关