Azure/azure-sdk-for-net

Consider if troubleshooting link information in exception messages could be automated

Open

#31,894 建立於 2022年10月19日

在 GitHub 查看
 (1 留言) (0 反應) (0 負責人)C# (4,880 star) (4,479 fork)batch import
ClientDocsMQhelp wanted

描述

In combination with #31597 and #31598 perhaps there is an opportunity to implement some automation in how troubleshooting links are added to exception messages generated for a given library. For example, perhaps each client has a helper that centralizes a mapping between types and troubleshooting links such that any exception thrown from that type includes the appropriate link. This could be enhanced with analyzer support.

貢獻者指南

技術棧
csharp
領域
backenddeveloper experience
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
needs investigation
前置要求
C#Azure SDK for .NET basics
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
30
研究方向
Investigate how exception messages are currently generated in the Azure SDK for .NET. Review linked issues #31597 and #31598 for context on troubleshooting links. Consider designing a helper class that maps exception types to troubleshooting URLs. Analyze the feasibility of integrating with Roslyn analyzers to automate link injection. Start by examining the source code in the 'sdk' directory for examples of exception handling.