dotnet/Open-XML-SDK

Instrument project with DiagnosticSource

Open

#762 opened on Jul 15, 2020

View on GitHub
 (2 comments) (1 reaction) (1 assignee)C# (3,704 stars) (543 forks)batch import
help wantedup for grabs

Description

In order to better identify and root cause issues, it would be helpful to get in depth logs as to what the system is doing. DiagnosticSource would be ideal for this. I haven't used it personally, but wanted to track a work item to add support for it within the project.

Contributor guide

Tech stack
csharp
Domain
observability
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
unclear
Prerequisites
C# programmingDiagnosticSource concepts.NET logging APIs
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
Investigate how DiagnosticSource is used in other .NET projects (e.g., ASP.NET Core). Look at the current logging in Open XML SDK to understand existing patterns. Consider opening a discussion to clarify scope and acceptance criteria. The issue has an assignee, so check with them first.
Instrument project with DiagnosticSource · dotnet/Open-XML-SDK#762 | Good First Issue