- 
          
- 
                Notifications
    You must be signed in to change notification settings 
- Fork 225
fix(logs): remove Dispose from the public API surface area #4424
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
          
     Merged
      
      
    Conversation
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
    | @sentry review | 
              
                    jamescrosswell
  
              
              approved these changes
              
                  
                    Aug 13, 2025 
                  
              
              
            
            
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
  This was referenced Sep 11, 2025 
      
  This was referenced Sep 12, 2025 
      
  This was referenced Sep 22, 2025 
      
  This was referenced Oct 1, 2025 
      
  This was referenced Oct 20, 2025 
      
  
    Sign up for free
    to join this conversation on GitHub.
    Already have an account?
    Sign in to comment
  
      
  Add this suggestion to a batch that can be applied as a single commit.
  This suggestion is invalid because no changes were made to the code.
  Suggestions cannot be applied while the pull request is closed.
  Suggestions cannot be applied while viewing a subset of changes.
  Only one suggestion per line can be applied in a batch.
  Add this suggestion to a batch that can be applied as a single commit.
  Applying suggestions on deleted lines is not supported.
  You must change the existing code in this line in order to create a valid suggestion.
  Outdated suggestions cannot be applied.
  This suggestion has been applied or marked resolved.
  Suggestions cannot be applied from pending reviews.
  Suggestions cannot be applied on multi-line comments.
  Suggestions cannot be applied while the pull request is queued to merge.
  Suggestion cannot be applied right now. Please check back later.
  
    
  
    
Summary
Remove
Dispose()fromSentryStructuredLoggerpublic API surface area.Remarks
In #4310, we added
SentryStructuredLogger.Dispose(),where only one out of three derived types actually has
IDisposablefields.This was necessary to enable cascading disposal (when
Hub.IsEnabledandSentryOptions.(Experimental).EnableLogs) out ofHub.Dispose(), whose compile-time type is only theabstract SentryStructuredLogger, but not the concreteDefaultSentryStructuredLogger(because through theDisabledHub, or whenEnableLogs is not true, aDisabledSentryStructuredLoggeris created).However, this allows user code to call
Dispose()on theabstract SentryStructuredLogger, and thereforeDisposethe concreteDefaultSentryStructuredLogger(when enabled) and itsIDisposablemembers, without disposing any of the otherSentryinstances, leaving the SDK in an inconsistent half-disposed and no longer fully usable state.Use code can invoke:
The only path, where the concrete
DefaultSentryStructuredLoggershould be disposed, is when the CurrentHub, which creates and owns the instance ofSentryStructuredLogger, is disposed.Therefore, I'd like to remove
Dispose()from the public API surface area ofSentryStructuredLogger.In order to still
DisposetheDefaultSentryStructuredLogger(when enabled) when the owningHubinstance is disposed, the concreteDefaultSentryStructuredLoggerstill implementsIDisposableand the owningHubdoes a type-check on theLoggerinstance.No (breaking) major release required, because
SentryStructuredLoggeris still[Experimental].Changes
IDisposablefromabstract SentryStructuredLoggerIDisposableexplicitly toDefaultSentryStructuredLogger, which owns disposable membersHubperforms a type-check before callingDispose()on theLoggerinstance that it owns