Azure/azure-sdk-for-net

Consider if troubleshooting link information in exception messages could be automated

Open

#31894 opened on Oct 19, 2022

View on GitHub
 (1 comment) (0 reactions) (0 assignees)C# (4,880 stars) (4,479 forks)batch import
ClientDocsMQhelp wanted

Description

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.

Contributor guide

Tech stack
csharp
Domain
backenddeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
needs investigation
Prerequisites
C#Azure SDK for .NET basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
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.