README

t3n.Neos.Debug

t3n.Neos.Debug 包是一个小的辅助包，用于将调试面板添加到您的 Neos CMS 网站。目前，您能够调试内容缓存配置以及 SQL 查询。此外，可以启用 Server-Timing HTTP 头，这将在响应中添加请求时间。这些时间可以在浏览器网络标签中查看。

注意：这仍然是一个非常早期的粗糙版本。任何错误都欢迎贡献。尽管如此，它已经为您增加了调试体验的价值

安装与配置

通过 composer 安装此包

composer require t3n/neos-debug --dev

默认情况下，调试模式是禁用的。要启用它，请将以下内容添加到您的 Settings.yaml

t3n:
  Neos:
    Debug:
      enabled: true

要在 js 控制台中显示调试面板，请运行此命令

__enable_neos_debug__()

免责声明：一旦启用调试模式，您可能会暴露敏感数据。请确保不要在生产环境中使用。至少要警告

在此包的早期版本中，当前用户需要特定的角色。我们现在已经取消了这一要求，因为如果您没有网站的前端登录，就无法使用此包。一旦该包激活，它将在您的 HTML 输出中渲染一些元数据。

要运行调试器，您现在需要包含一些 JavaScript 和 CSS 来实际渲染调试控制台。此包提供了两个融合原型来包含所有资源。如果您的文档扩展了 Neos.Neos:Page，则不需要包含任何内容。我们已经将资源添加到了 Neos.Neos:Page 原型中。

HTTP Server-Timing 头

默认情况下，此头是禁用的。要启用它，请将以下内容添加到您的 Settings.yaml

t3n:
  Neos:
    Debug:
      serverTimingHeader:
        enabled: true

如果您只想添加带有所有时间头的头，但不启用调试模式，请这样做

t3n:
  Neos:
    Debug:                                                  
      enabled: true
      htmlOutput:
        enabled: false
      serverTimingHeader:
        enabled: true

使用

要启用缓存可视化，请打开您的浏览器开发者控制台并执行 __enable_neos_debug__()。这将打开屏幕底部的调试控制台。

🔦 检查

一旦您启用了检查模式，就会弹出可视化，并在缓存的各个部分添加覆盖层。缓存的各个部分标记为绿色，未缓存的标记为红色，动态缓存标记为黄色。如果将放大镜悬停在上方，您还可以看到一些有关缓存的元数据。

⚡️ 缓存

此模块将添加一个新的模态窗口，包括有关缓存命中和未命中的一些统计信息以及所有渲染的缓存条目的表格。

🗄 SQL

除了内容缓存之外，我们还公开了一些调试 SQL 信息和统计信息。它还会检测慢查询。您可以从何时开始将查询标记为慢查询进行配置

t3n:
  Neos:
    Debug:
      sql:
        # Set when a query should be considered as slow query. In ms
        slowQueryAfter: 10

🚫 关闭

要关闭调试控制台，只需关闭它。如果您想保留活动的调试状态，可以在方法中添加一个 true

__enable_neos_debug__(true)

这将设置一个cookie，并且即使页面刷新后，调试模式仍然处于活动状态。