diagnostics-and-logging

Manage diagnostics, logging, and error reporting through ReportHub.

23|17|Updated Apr 16, 2023
One-click install
npx skills add https://github.com/decentraland/unity-explorer --skill diagnostics-and-logging
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: diagnostics-and-logging
Source: https://github.com/decentraland/unity-explorer/tree/main/.claude/skills/diagnostics-and-logging
Command: npx skills add https://github.com/decentraland/unity-explorer --skill diagnostics-and-logging

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill streamlines the process of diagnosing issues, managing logs, and reporting errors within the application, ensuring a more robust and maintainable system.

Core Features & Use Cases

  • Centralized Logging: Replaces Debug.Log with ReportHub for consistent log routing.
  • Categorization & Severity: Organizes logs by ReportCategory and controls visibility via CategorySeverityMatrix.
  • Runtime Overrides: Allows dynamic adjustment of log levels without rebuilding.
  • Use Case: When a specific feature is causing unexpected behavior, you can use a chat command to temporarily increase the log verbosity for that feature's category to pinpoint the root cause.

Quick Start

Use the diagnostics-and-logging skill to enable error logs for the VOICE_CHAT category.

Frequently Asked Questions about diagnostics-and-logging

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I centralize Unity debugging and replace Debug.Log statements?

Centralize Unity debugging by replacing Debug.Log statements with the ReportHub system, which routes logs consistently across the application. You categorize logs using ReportCategory tags and control their visibility via a CategorySeverityMatrix.

Can I adjust Unity log levels at runtime without rebuilding the application?

You can adjust log levels at runtime without rebuilding by applying runtime overrides to specific ReportCategory tags. This dynamic severity matrix adjustment allows you to temporarily increase log verbosity for targeted features causing unexpected behavior.

How does Sentry integration work for remote error tracking in Unity?

Sentry integration for remote error tracking works by routing logged exceptions and errors from the ReportHub system directly to Sentry. This captures application issues remotely while an exception tolerance mechanism prevents scene errors from crashing the application.

What is the best way to organize Unity logs by feature and control their visibility?

Organize Unity logs by tagging systems with LogCategory entries and manage their visibility through a CategorySeverityMatrix. This categorization and severity configuration ensures only relevant diagnostic information is surfaced based on your configured log levels.

Why does my Unity application crash when a scene error occurs, and how can I prevent it?

Scene errors can crash Unity applications, but you can prevent this by utilizing an exception tolerance mechanism. This diagnostics and logging feature catches scene errors and reports them through the ReportHub system instead of terminating the application.

Does the diagnostics and logging Skill support dynamic log routing for specific Unity features like voice chat?

The diagnostics and logging Skill supports dynamic log routing for specific Unity features by assigning them a LogCategory, such as VOICE_CHAT. You can then use chat commands to temporarily override log verbosity for that category to pinpoint root causes.