GFDiagnosticsUtility

API Reference / Standard / 类索引

• 路径：addons/gf/standard/utilities/debug/gf_diagnostics_utility.gd
• 模块：Standard
• 继承：GFUtility
• API：public
• 类别：运行时服务 (runtime_service)
• 首次版本：3.17.0

运行时诊断聚合工具。 提供架构生命周期、事件系统、性能、日志和外部贡献诊断的统一快照。 外部监控和快照贡献采用 owner-bound 发布模型；采集路径只读取已验证缓存，不执行项目回调。

成员概览

类型	名称	签名
信号	snapshot_collected	signal snapshot_collected(snapshot: Dictionary)
信号	diagnostic_command_executed	signal diagnostic_command_executed(command_name: StringName, result: Dictionary)
信号	monitor_sampled	signal monitor_sampled(monitor_id: StringName, sample: Dictionary)
枚举	CommandTier	enum CommandTier
常量	DEBUGGER_CAPTURE_NAME	const DEBUGGER_CAPTURE_NAME: StringName = &"gf_diagnostics"
常量	DEBUGGER_MESSAGE_REQUEST_SNAPSHOT	const DEBUGGER_MESSAGE_REQUEST_SNAPSHOT: String = "gf_diagnostics:request_snapshot"
常量	DEBUGGER_MESSAGE_REQUEST_CATALOG	const DEBUGGER_MESSAGE_REQUEST_CATALOG: String = "gf_diagnostics:request_catalog"
常量	DEBUGGER_MESSAGE_EXECUTE_COMMAND	const DEBUGGER_MESSAGE_EXECUTE_COMMAND: String = "gf_diagnostics:execute_command"
常量	DEBUGGER_MESSAGE_SNAPSHOT	const DEBUGGER_MESSAGE_SNAPSHOT: String = "gf_diagnostics:snapshot"
常量	DEBUGGER_MESSAGE_CATALOG	const DEBUGGER_MESSAGE_CATALOG: String = "gf_diagnostics:catalog"
常量	DEBUGGER_MESSAGE_COMMAND_RESULT	const DEBUGGER_MESSAGE_COMMAND_RESULT: String = "gf_diagnostics:command_result"
属性	include_performance_monitors	var include_performance_monitors: bool = true
属性	default_recent_log_count	var default_recent_log_count: int = 20
属性	max_command_tier	var max_command_tier: CommandTier = CommandTier.OBSERVE
属性	require_auth_token	var require_auth_token: bool = false
属性	auth_token	var auth_token: String = ""
属性	allow_debugger_command_execution	var allow_debugger_command_execution: bool = false
属性	allow_danger_commands	var allow_danger_commands: bool = false
属性	encode_command_results_for_json	var encode_command_results_for_json: bool = false
属性	default_scene_tree_max_depth	var default_scene_tree_max_depth: int = 4
属性	default_scene_tree_max_nodes	var default_scene_tree_max_nodes: int = 128
属性	max_contribution_collection_items	var max_contribution_collection_items: int = 64:
属性	max_contribution_nodes	var max_contribution_nodes: int = 2048:
属性	max_contribution_depth	var max_contribution_depth: int = 16:
属性	max_contribution_bytes	var max_contribution_bytes: int = 262_144:
方法	init	func init() -> void:
方法	ready	func ready() -> void:
方法	dispose	func dispose() -> void:
方法	register_command	func register_command( owner: Object, command_name: StringName, callback: Callable, description: String = "", tier: CommandTier = CommandTier.OBSERVE, options: Dictionary = {} ) -> bool:
方法	unregister_command	func unregister_command(owner: Object, command_name: StringName) -> bool:
方法	has_command	func has_command(command_name: StringName) -> bool:
方法	set_command_parameter_schema	func set_command_parameter_schema(command_name: StringName, parameters: Variant) -> bool:
方法	set_command_enabled	func set_command_enabled(command_name: StringName, enabled: bool) -> bool:
方法	set_all_commands_enabled	func set_all_commands_enabled( enabled: bool, command_names: PackedStringArray = PackedStringArray() ) -> int:
方法	is_command_enabled	func is_command_enabled(command_name: StringName) -> bool:
方法	get_command_descriptions	func get_command_descriptions() -> Dictionary:
方法	get_command_catalog	func get_command_catalog() -> Dictionary:
方法	register_monitor	func register_monitor(owner: Object, monitor_id: StringName, options: Dictionary = {}) -> bool:
方法	publish_monitor_sample	func publish_monitor_sample( owner: Object, monitor_id: StringName, value: Variant, sample_metadata: Dictionary = {} ) -> bool:
方法	unregister_monitor	func unregister_monitor(owner: Object, monitor_id: StringName) -> bool:
方法	has_monitor	func has_monitor(monitor_id: StringName) -> bool:
方法	get_monitor_catalog	func get_monitor_catalog() -> Dictionary:
方法	register_monitor_preset	func register_monitor_preset( preset_id: StringName, monitor_ids: PackedStringArray, options: Dictionary = {} ) -> bool:
方法	add_monitor_to_preset	func add_monitor_to_preset(preset_id: StringName, monitor_id: StringName) -> bool:
方法	unregister_monitor_preset	func unregister_monitor_preset(preset_id: StringName) -> void:
方法	has_monitor_preset	func has_monitor_preset(preset_id: StringName) -> bool:
方法	get_monitor_preset_ids	func get_monitor_preset_ids() -> PackedStringArray:
方法	publish_snapshot_section	func publish_snapshot_section(owner: Object, section_id: StringName, section: Dictionary) -> bool:
方法	remove_snapshot_section	func remove_snapshot_section(owner: Object, section_id: StringName) -> bool:
方法	has_snapshot_section	func has_snapshot_section(section_id: StringName) -> bool:
方法	publish_tool_snapshot	func publish_tool_snapshot(owner: Object, tool_id: StringName, snapshot: Dictionary) -> bool:
方法	remove_tool_snapshot	func remove_tool_snapshot(owner: Object, tool_id: StringName) -> bool:
方法	has_tool_snapshot	func has_tool_snapshot(tool_id: StringName) -> bool:
方法	collect_monitor_snapshot	func collect_monitor_snapshot( monitor_ids: PackedStringArray = PackedStringArray(), include_hidden: bool = false ) -> Dictionary:
方法	collect_monitor_preset	func collect_monitor_preset(preset_id: StringName, include_hidden: bool = false) -> Dictionary:
方法	export_monitor_snapshot	func export_monitor_snapshot(snapshot: Dictionary, format: StringName = &"json") -> String:
方法	set_auth_token	func set_auth_token(token: String, required: bool = true) -> void:
方法	execute_command	func execute_command(command_name: StringName, args: Dictionary = {}) -> Dictionary:
方法	execute_command_json_safe	func execute_command_json_safe(command_name: StringName, args: Dictionary = {}) -> Dictionary:
方法	command_result_to_json_compatible	func command_result_to_json_compatible(result: Dictionary, options: Dictionary = {}) -> Dictionary:
方法	collect_snapshot	func collect_snapshot(options: Dictionary = {}) -> Dictionary:
方法	get_debugger_bridge_state	func get_debugger_bridge_state() -> Dictionary:
方法	collect_performance_snapshot	func collect_performance_snapshot() -> Dictionary:
方法	collect_log_snapshot	func collect_log_snapshot(recent_log_count: int = 20, include_recent_logs: bool = true) -> Dictionary:
方法	collect_scene_tree_snapshot	func collect_scene_tree_snapshot(root: Node = null, options: Dictionary = {}) -> Dictionary:
方法	collect_signal_graph_snapshot	func collect_signal_graph_snapshot(root: Node = null, options: Dictionary = {}) -> Dictionary:

信号

snapshot_collected

• API：public

signal snapshot_collected(snapshot: Dictionary)

采集快照后发出。

参数：

名称	说明
snapshot	刚采集到的诊断快照。

结构：

• snapshot: Dictionary，包含 collect_snapshot() 返回的顶层诊断分区。

diagnostic_command_executed

• API：public

signal diagnostic_command_executed(command_name: StringName, result: Dictionary)

执行诊断命令后发出。

参数：

名称	说明
command_name	已执行的诊断命令名。
result	命令执行结果。

结构：

• result: Dictionary，包含 ok、value、error、metadata 等字段。

monitor_sampled

• API：public

signal monitor_sampled(monitor_id: StringName, sample: Dictionary)

采样诊断监控项后发出。

参数：

名称	说明
monitor_id	监控项标识。
sample	采样结果。

结构：

• sample: Dictionary，包含 id、label、group、value、valid、error、metadata 和 sampled_at_unix。

枚举

CommandTier

• API：public

enum CommandTier {
    ## 只读取状态。
    OBSERVE,
    ## 修改调试输入或临时过滤条件。
    INPUT,
    ## 控制运行时行为。
    CONTROL,
    ## 可能破坏状态、存档或远端连接。
    DANGER,
}

诊断命令风险等级。

常量

DEBUGGER_CAPTURE_NAME

• API：public
• 首次版本：6.0.0

const DEBUGGER_CAPTURE_NAME: StringName = &"gf_diagnostics"

EditorDebugger 与运行时诊断桥使用的 capture 名称。

DEBUGGER_MESSAGE_REQUEST_SNAPSHOT

• API：public
• 首次版本：6.0.0

const DEBUGGER_MESSAGE_REQUEST_SNAPSHOT: String = "gf_diagnostics:request_snapshot"

EditorDebugger 请求快照消息。

DEBUGGER_MESSAGE_REQUEST_CATALOG

• API：public
• 首次版本：6.0.0

const DEBUGGER_MESSAGE_REQUEST_CATALOG: String = "gf_diagnostics:request_catalog"

EditorDebugger 请求目录消息。

DEBUGGER_MESSAGE_EXECUTE_COMMAND

• API：public
• 首次版本：6.0.0

const DEBUGGER_MESSAGE_EXECUTE_COMMAND: String = "gf_diagnostics:execute_command"

EditorDebugger 执行诊断命令消息。

DEBUGGER_MESSAGE_SNAPSHOT

• API：public
• 首次版本：6.0.0

const DEBUGGER_MESSAGE_SNAPSHOT: String = "gf_diagnostics:snapshot"

运行时返回快照消息。

DEBUGGER_MESSAGE_CATALOG

• API：public
• 首次版本：6.0.0

const DEBUGGER_MESSAGE_CATALOG: String = "gf_diagnostics:catalog"

运行时返回目录消息。

DEBUGGER_MESSAGE_COMMAND_RESULT

• API：public
• 首次版本：6.0.0

const DEBUGGER_MESSAGE_COMMAND_RESULT: String = "gf_diagnostics:command_result"

运行时返回命令结果消息。

属性

include_performance_monitors

• API：public

var include_performance_monitors: bool = true

是否采集 Godot Performance 监视器。

default_recent_log_count

• API：public

var default_recent_log_count: int = 20

快照中默认包含的最近日志数量。

max_command_tier

• API：public

var max_command_tier: CommandTier = CommandTier.OBSERVE

当前允许执行的最高命令等级。

require_auth_token

• API：public

var require_auth_token: bool = false

是否要求命令参数提供 auth_token 或 _auth_token。

auth_token

• API：public

var auth_token: String = ""

诊断命令认证 token。为空时无法通过认证。

allow_debugger_command_execution

• API：public
• 首次版本：6.0.0

var allow_debugger_command_execution: bool = false

是否允许 EditorDebugger 桥执行诊断命令。

allow_danger_commands

• API：public

var allow_danger_commands: bool = false

是否允许执行 DANGER 等级命令。即使 max_command_tier 足够，也需要显式开启。

encode_command_results_for_json

• API：public

var encode_command_results_for_json: bool = false

是否把诊断命令结果转换为 JSON 兼容 Variant。

default_scene_tree_max_depth

• API：public

var default_scene_tree_max_depth: int = 4

场景树快照默认递归深度。

default_scene_tree_max_nodes

• API：public

var default_scene_tree_max_nodes: int = 128

场景树快照默认最多采集节点数。

max_contribution_collection_items

• API：public
• 首次版本：8.0.0

var max_contribution_collection_items: int = 64:

外部诊断贡献的单个容器最多包含的元素数量。

max_contribution_nodes

• API：public
• 首次版本：8.0.0

var max_contribution_nodes: int = 2048:

外部诊断贡献最多包含的 Variant 节点数量。

max_contribution_depth

• API：public
• 首次版本：8.0.0

var max_contribution_depth: int = 16:

外部诊断贡献允许的最大集合嵌套深度。

max_contribution_bytes

• API：public
• 首次版本：8.0.0

var max_contribution_bytes: int = 262_144:

外部诊断贡献允许保留的估算字节数。 该预算用于阻止诊断系统长期保留异常大的字符串、PackedArray 或集合，不代表精确内存占用。

方法

init

• API：public

func init() -> void:

初始化内置诊断命令和监控项。

ready

• API：public

func ready() -> void:

绑定控制台诊断命令。

dispose

• API：public

func dispose() -> void:

释放诊断注册表并解绑控制台命令。

register_command

• API：public
• 首次版本：3.0.0

func register_command( owner: Object, command_name: StringName, callback: Callable, description: String = "", tier: CommandTier = CommandTier.OBSERVE, options: Dictionary = {} ) -> bool:

注册诊断命令。

参数：

名称	说明
owner	命令注册所有者；同名命令只允许同一 owner 更新。
command_name	命令名。
callback	回调，签名建议为 func(args: Dictionary) -> Variant。
description	描述文本。
tier	命令风险等级。
options	可选元数据，支持 parameters、metadata、enabled。

返回：注册成功返回 true；同名命令属于其他 owner 时返回 false。

结构：

• options: Dictionary，支持 parameters、metadata 和 enabled。

unregister_command

• API：public
• 首次版本：3.0.0

func unregister_command(owner: Object, command_name: StringName) -> bool:

注销诊断命令。

参数：

名称	说明
owner	当前命令注册所有者。
command_name	命令名。

返回：owner 匹配且成功注销时返回 true。

has_command

• API：public

func has_command(command_name: StringName) -> bool:

检查诊断命令是否存在。

参数：

名称	说明
command_name	命令名。

返回：存在返回 true。

set_command_parameter_schema

• API：public

func set_command_parameter_schema(command_name: StringName, parameters: Variant) -> bool:

设置诊断命令参数 schema。

参数：

名称	说明
command_name	命令名。
parameters	参数 schema，可为数组或按参数名索引的字典。

返回：设置成功返回 true。

结构：

• parameters: Variant，支持 Array[Dictionary] 或 Dictionary 形式的参数 schema。

set_command_enabled

• API：public

func set_command_enabled(command_name: StringName, enabled: bool) -> bool:

设置诊断命令是否启用。

参数：

名称	说明
command_name	命令名。
enabled	是否启用。

返回：命令存在时返回 true。

set_all_commands_enabled

• API：public

func set_all_commands_enabled( enabled: bool, command_names: PackedStringArray = PackedStringArray() ) -> int:

批量设置命令是否启用。

参数：

名称	说明
enabled	是否启用。
command_names	指定命令；为空时作用于全部已注册命令。

返回：实际处理的命令数量。

is_command_enabled

• API：public

func is_command_enabled(command_name: StringName) -> bool:

检查命令是否启用。

参数：

名称	说明
command_name	命令名。

返回：命令存在且启用时返回 true。

get_command_descriptions

• API：public

func get_command_descriptions() -> Dictionary:

获取诊断命令描述。

返回：命令名到描述的字典。

结构：

• return: Dictionary[StringName, String]，以命令名为键。

get_command_catalog

• API：public

func get_command_catalog() -> Dictionary:

获取诊断命令目录。

返回：命令名到命令元数据的字典。

结构：

• return: Dictionary[StringName, Dictionary]，每个值包含 description、tier、tier_name、enabled、parameters 和 metadata。

register_monitor

• API：public
• 首次版本：3.0.0

func register_monitor(owner: Object, monitor_id: StringName, options: Dictionary = {}) -> bool:

注册一个由 owner 主动发布采样值的诊断监控项。

参数：

名称	说明
owner	监控项注册所有者；同名监控项只允许同一 owner 更新。
monitor_id	监控项唯一标识。
options	可选元数据，支持 label、group、visible 和 metadata。

返回：注册成功返回 true。

结构：

• options: Dictionary，支持 label、group、visible 和 metadata。

publish_monitor_sample

• API：public
• 首次版本：8.0.0

func publish_monitor_sample( owner: Object, monitor_id: StringName, value: Variant, sample_metadata: Dictionary = {} ) -> bool:

发布一个监控采样值。

参数：

名称	说明
owner	当前监控项注册所有者。
monitor_id	监控项唯一标识。
value	要缓存的采样值；采集阶段不会执行该值中的 Callable。
sample_metadata	本次采样元数据。

返回：owner 匹配且值通过贡献预算时返回 true；失败时保留上一份有效采样。

结构：

• value: 任意 Variant 报告值；写入前由 GFReportValueCodec 编码，循环引用或超出诊断贡献预算时拒绝。
• sample_metadata: JSON 兼容 Dictionary。

unregister_monitor

• API：public
• 首次版本：3.0.0

func unregister_monitor(owner: Object, monitor_id: StringName) -> bool:

注销诊断监控项。

参数：

名称	说明
owner	当前监控项注册所有者。
monitor_id	监控项唯一标识。

返回：owner 匹配且成功注销时返回 true。

has_monitor

• API：public

func has_monitor(monitor_id: StringName) -> bool:

检查诊断监控项是否存在。

参数：

名称	说明
monitor_id	监控项唯一标识。

返回：存在返回 true。

get_monitor_catalog

• API：public
• 首次版本：3.0.0

func get_monitor_catalog() -> Dictionary:

获取诊断监控项目录。

返回：监控项元数据字典。

结构：

• return: Dictionary[StringName, Dictionary]，每个值包含 label、group、visible、metadata 和 has_published_value。

register_monitor_preset

• API：public

func register_monitor_preset( preset_id: StringName, monitor_ids: PackedStringArray, options: Dictionary = {} ) -> bool:

注册诊断监控预设。

参数：

名称	说明
preset_id	预设唯一标识。
monitor_ids	预设包含的监控项标识。
options	可选元数据，支持 label、metadata。

返回：注册成功返回 true。

结构：

• options: Dictionary，支持 label 和 metadata。

add_monitor_to_preset

• API：public

func add_monitor_to_preset(preset_id: StringName, monitor_id: StringName) -> bool:

将一个监控项追加到已有预设；预设不存在时会创建。

参数：

名称	说明
preset_id	预设唯一标识。
monitor_id	监控项唯一标识。

返回：追加成功返回 true。

unregister_monitor_preset

• API：public

func unregister_monitor_preset(preset_id: StringName) -> void:

注销诊断监控预设。

参数：

名称	说明
preset_id	预设唯一标识。

has_monitor_preset

• API：public

func has_monitor_preset(preset_id: StringName) -> bool:

检查诊断监控预设是否存在。

参数：

名称	说明
preset_id	预设唯一标识。

返回：存在返回 true。

get_monitor_preset_ids

• API：public

func get_monitor_preset_ids() -> PackedStringArray:

获取诊断监控预设列表。

返回：预设标识列表。

publish_snapshot_section

• API：public
• 首次版本：8.0.0

func publish_snapshot_section(owner: Object, section_id: StringName, section: Dictionary) -> bool:

发布快照分区。用于扩展或项目把自己的诊断数据贡献到 collect_snapshot() 顶层字段。

参数：

名称	说明
owner	分区所有者；同名分区只允许同一 owner 更新。
section_id	快照顶层字段名。
section	要缓存的分区快照，必须满足诊断贡献预算。

返回：注册成功返回 true。

结构：

• section: Dictionary 报告快照；写入前由 GFReportValueCodec 编码，循环引用或超出诊断贡献预算时拒绝。

remove_snapshot_section

• API：public
• 首次版本：8.0.0

func remove_snapshot_section(owner: Object, section_id: StringName) -> bool:

移除快照分区。

参数：

名称	说明
owner	当前分区所有者。
section_id	快照顶层字段名。

返回：owner 匹配且成功注销时返回 true。

has_snapshot_section

• API：public
• 首次版本：8.0.0

func has_snapshot_section(section_id: StringName) -> bool:

检查快照分区是否存在。

参数：

名称	说明
section_id	快照顶层字段名。

返回：存在返回 true。

publish_tool_snapshot

• API：public
• 首次版本：8.0.0

func publish_tool_snapshot(owner: Object, tool_id: StringName, snapshot: Dictionary) -> bool:

发布工具快照。用于扩展或项目把 get_debug_snapshot() 风格数据贡献到 tools 字段。

参数：

名称	说明
owner	快照所有者；同名工具只允许同一 owner 更新。
tool_id	tools 内部字段名。
snapshot	要缓存的工具快照，必须满足诊断贡献预算。

返回：注册成功返回 true。

结构：

• snapshot: Dictionary 报告快照；写入前由 GFReportValueCodec 编码，循环引用或超出诊断贡献预算时拒绝。

remove_tool_snapshot

• API：public
• 首次版本：8.0.0

func remove_tool_snapshot(owner: Object, tool_id: StringName) -> bool:

移除工具快照。

参数：

名称	说明
owner	当前快照所有者。
tool_id	tools 内部字段名。

返回：owner 匹配且成功注销时返回 true。

has_tool_snapshot

• API：public
• 首次版本：8.0.0

func has_tool_snapshot(tool_id: StringName) -> bool:

检查工具快照是否存在。

参数：

名称	说明
tool_id	tools 内部字段名。

返回：存在返回 true。

collect_monitor_snapshot

• API：public

func collect_monitor_snapshot( monitor_ids: PackedStringArray = PackedStringArray(), include_hidden: bool = false ) -> Dictionary:

采集诊断监控快照。

参数：

名称	说明
monitor_ids	指定监控项；为空时采集全部可见监控项。
include_hidden	为 true 时包含 visible=false 的监控项。

返回：监控快照字典。

结构：

• return: Dictionary，包含 timestamp_unix、monitor_count 和 monitors。

collect_monitor_preset

• API：public

func collect_monitor_preset(preset_id: StringName, include_hidden: bool = false) -> Dictionary:

按预设采集诊断监控快照。

参数：

名称	说明
preset_id	预设唯一标识。
include_hidden	为 true 时包含 visible=false 的监控项。

返回：监控快照字典。

结构：

• return: Dictionary，包含 collect_monitor_snapshot() 字段以及 preset_id、preset_label、preset_metadata。

export_monitor_snapshot

• API：public

func export_monitor_snapshot(snapshot: Dictionary, format: StringName = &"json") -> String:

导出诊断监控快照。

参数：

名称	说明
snapshot	collect_monitor_snapshot() 或 collect_monitor_preset() 返回值。
format	导出格式，支持 json、text、csv。

返回：导出文本。

结构：

• snapshot: Dictionary，collect_monitor_snapshot() 或 collect_monitor_preset() 返回结构。

set_auth_token

• API：public

func set_auth_token(token: String, required: bool = true) -> void:

设置诊断认证 token。

参数：

名称	说明
token	token 文本。
required	是否立即启用 token 校验。

execute_command

• API：public

func execute_command(command_name: StringName, args: Dictionary = {}) -> Dictionary:

执行诊断命令。

参数：

名称	说明
command_name	命令名。
args	命令参数。

返回：统一结果字典。

结构：

• args: Dictionary，命令参数；可包含 auth_token 以及该命令 parameter_schema 定义的字段。
• return: Dictionary，包含 ok、value、error、metadata。

execute_command_json_safe

• API：public

func execute_command_json_safe(command_name: StringName, args: Dictionary = {}) -> Dictionary:

执行诊断命令并返回 JSON 兼容结果。

参数：

名称	说明
command_name	命令名。
args	命令参数。

返回：JSON 兼容结果字典。

结构：

• args: Dictionary，命令参数；可包含 auth_token 以及该命令 parameter_schema 定义的字段。
• return: Dictionary，包含 JSON 兼容的 ok、value、error、metadata。

command_result_to_json_compatible

• API：public

func command_result_to_json_compatible(result: Dictionary, options: Dictionary = {}) -> Dictionary:

将命令结果转换为 JSON 兼容字典。

参数：

名称	说明
result	execute_command() 返回的结果。
options	传给 GFVariantJsonCodec.variant_to_json_compatible() 的选项。

返回：JSON 兼容结果字典。

结构：

• result: Dictionary，execute_command() 返回结构。
• options: Dictionary，传给 GFVariantJsonCodec.variant_to_json_compatible() 的编码选项。
• return: Dictionary，JSON 兼容命令结果。

collect_snapshot

• API：public
• 首次版本：3.17.0

func collect_snapshot(options: Dictionary = {}) -> Dictionary:

采集运行时诊断快照。

参数：

名称	说明
options	可选参数，支持 recent_log_count、include_recent_logs、include_scene_tree、scene_tree_options、include_signal_graph、signal_graph_options。

返回：快照字典。

结构：

• options: Dictionary，支持 recent_log_count、include_recent_logs、include_scene_tree、scene_tree_options、include_signal_graph、signal_graph_options、include_monitors、monitor_preset、monitor_ids、include_hidden_monitors。
• return: Dictionary，包含 timestamp_unix、engine、build、architecture、event_system、performance、logs、tools，可选 scene_tree、signal_graph、monitors 和已发布分区。

get_debugger_bridge_state

• API：public
• 首次版本：6.0.0

func get_debugger_bridge_state() -> Dictionary:

获取 EditorDebugger 桥接状态。

返回：桥接状态字典。

结构：

• return: Dictionary with capture_name, registered, debugger_active, editor_feature, editor_hint, and allow_command_execution.

collect_performance_snapshot

• API：public

func collect_performance_snapshot() -> Dictionary:

采集性能监视器快照。

返回：性能数据字典。

结构：

• return: Dictionary，包含 fps、process_time、physics_process_time、static_memory、object_count、node_count、resource_count。

collect_log_snapshot

• API：public

func collect_log_snapshot(recent_log_count: int = 20, include_recent_logs: bool = true) -> Dictionary:

采集日志缓存快照。

参数：

名称	说明
recent_log_count	最近日志数量。
include_recent_logs	是否包含日志条目。

返回：日志数据字典。

结构：

• return: Dictionary，包含 available、memory_count、dropped_count、recent。

collect_scene_tree_snapshot

• API：public
• 首次版本：3.17.0

func collect_scene_tree_snapshot(root: Node = null, options: Dictionary = {}) -> Dictionary:

采集只读场景树快照。

参数：

名称	说明
root	可选根节点；为空时优先使用当前场景，再回退到 Viewport root。
options	可选参数，支持 max_depth、max_nodes、include_groups、include_owner_path、include_script_path、include_internal、redact_paths。

返回：场景树快照字典。

结构：

• options: Dictionary，支持 max_depth、max_nodes、include_groups、include_owner_path、include_script_path、include_internal、redact_paths、root_path、prefer_current_scene。
• return: Dictionary，包含 available、node_count、truncated、root_path、root。

collect_signal_graph_snapshot

• API：public
• 首次版本：3.17.0

func collect_signal_graph_snapshot(root: Node = null, options: Dictionary = {}) -> Dictionary:

采集只读信号连接图快照。

参数：

名称	说明
root	可选根节点；为空时优先使用当前场景，再回退到 Viewport root。
options	可选参数，支持 include_internal、persistent_only、include_empty_signals、include_external_targets、include_index、redact_paths。

返回：信号图快照字典。

结构：

• options: Dictionary，支持 include_internal、persistent_only、include_empty_signals、include_external_targets、include_index、redact_paths、root_path、prefer_current_scene。
• return: Dictionary，包含 ok、root_path、node_count、signal_count、connection_count、nodes、signals、connections，可选 index。