Jackett错误报告系统：用户反馈与自动提交

Jackett错误报告系统：用户反馈与自动提交

在使用Jackett的过程中，用户可能会遇到各种错误和问题。Jackett提供了完善的错误报告系统，帮助用户收集、分析和提交错误信息，以便开发团队及时解决问题。本文将详细介绍Jackett错误报告系统的工作原理、用户反馈流程以及自动提交机制。

错误类型与处理机制

Jackett定义了多种异常类型来处理不同的错误场景。例如，当用户请求过于频繁时，系统会抛出TooManyRequestsException异常，并提示用户稍后重试。

public class TooManyRequestsException : Exception { public TimeSpan RetryAfter { get; private set; } public TooManyRequestsException(string message, TimeSpan retryWait) : base(message) { RetryAfter = retryWait; } }

上述代码来自src/Jackett.Common/Exceptions/TooManyRequestsException.cs，该异常类会记录重试等待时间，帮助系统在适当的时候重新发起请求。

日志记录与缓存

Jackett使用NLog作为日志记录框架，并通过LoggingSetup类配置日志记录规则。日志文件默认保存在数据文件夹中，名为log.txt，并会自动轮转以防止文件过大。

var logFile = new CleanseFileTarget { Layout = "${longdate} ${level} ${message}${onexception:inner=${newline}${newline}[v${assembly-version}] ${exception:format=ToString}${newline}}", FileName = Path.Combine(settings.DataFolder, logFileName), ArchiveFileName = Path.Combine(settings.DataFolder, logFileName + ".{#####}.txt"), ArchiveAboveSize = 2097152, // 2 MB MaxArchiveFiles = 5, KeepFileOpen = false, ArchiveNumbering = ArchiveNumberingMode.DateAndSequence };

日志内容会经过清洗，确保敏感信息不会被记录。LogCacheService类负责缓存最近的日志记录，方便用户查看和提交错误报告。

private static void AddLog(LogEventInfo logEvent, string logMessage) { lock (_Logs) { _Logs.Insert(0, new CachedLog { Level = logEvent.Level.Name, Message = CleanseLogMessage.Cleanse(logMessage), When = logEvent.TimeStamp }); _Logs = _Logs.Take(200).ToList(); } }

上述代码来自src/Jackett.Common/Services/LogCacheService.cs，它会缓存最近200条日志记录，并对日志内容进行清洗。

用户反馈流程

当用户遇到错误时，可以通过Jackett的Web界面查看详细的日志信息。系统会将错误日志保存在本地文件中，用户可以手动收集这些日志并提交给开发团队。日志文件的路径通常为data/log.txt，用户可以通过文件管理器找到该文件。

此外，Jackett还提供了日志清洗功能，确保用户提交的日志中不包含敏感信息。CleanseFileTarget类负责在写入日志文件前对日志内容进行清洗。

protected override void RenderFormattedMessage(LogEventInfo logEvent, StringBuilder target) { var result = CleanseLogMessage.Cleanse(Layout.Render(logEvent)); target.Append(result); }

上述代码来自src/Jackett.Common/Utils/Logging/CleanseFileTarget.cs，它会调用CleanseLogMessage.Cleanse方法对日志内容进行清洗。

自动提交机制

Jackett的错误报告系统还支持自动提交功能。当发生严重错误时，系统会自动收集相关日志信息，并提示用户是否提交错误报告。用户可以选择提交或取消，提交后系统会将错误信息发送给开发团队。

自动提交机制依赖于日志缓存和异常处理机制。当异常发生时，系统会捕获异常信息，并结合缓存的日志内容生成完整的错误报告。开发团队可以根据这些报告快速定位和解决问题。

总结

Jackett的错误报告系统通过异常处理、日志记录、用户反馈和自动提交等机制，为用户和开发团队之间搭建了高效的沟通桥梁。用户可以方便地提交错误报告，开发团队可以及时获取详细的错误信息，从而不断改进Jackett的稳定性和可靠性。

如果您在使用Jackett时遇到任何问题，请查看日志文件并提交错误报告，帮助开发团队更好地改进产品。