Skip to content

fix: Do not suggest Sentry.Extensions.Logging when ASP.NET Core is used #13891

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.

Sign up for GitHub

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
untitaker merged 1 commit into from
Jul 8, 2019
Merged

fix: Do not suggest Sentry.Extensions.Logging when ASP.NET Core is used #13891

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 18 additions & 9 deletions src/sentry/sdk_updates.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,9 +115,15 @@ def get_new_state(self, old_state):


class ChangeSDKSuggestion(Suggestion):
def __init__(self, new_sdk_name, new_module_name=None):
"""
:param module_names: A list of modules that, when any of them is loaded,
indicate that the SDK is already used. This list is used to weed out
invalid suggestions when using multiple SDKs in e.g. .NET.
"""

def __init__(self, new_sdk_name, module_names=None):
self.new_sdk_name = new_sdk_name
self.new_module_name = new_module_name
self.module_names = module_names

def to_json(self):
return {
Expand All @@ -130,7 +136,7 @@ def get_new_state(self, old_state):
if old_state.sdk_name == self.new_sdk_name:
return old_state

if self.new_module_name and self.new_module_name in old_state.modules:
if any(x in old_state.modules for x in self.module_names or ()):
return old_state

new_state = old_state.copy()
Expand Down Expand Up @@ -215,42 +221,45 @@ def get_new_state(self, old_state):
'sdk_version_added': '0.0.0',
'module_name': 'Microsoft.AspNetCore.Hosting',
'module_version_min': '2.1.0',
'suggestion': ChangeSDKSuggestion('sentry.dotnet.aspnetcore', 'Sentry.AspNetCore'),
'suggestion': ChangeSDKSuggestion('sentry.dotnet.aspnetcore', ['Sentry.AspNetCore']),
},
{
'sdk_name': 'sentry.dotnet',
'sdk_version_added': '0.0.0',
'module_name': 'EntityFramework',
'module_version_min': '6.0.0',
'suggestion': ChangeSDKSuggestion('sentry.dotnet.entityframework', 'Sentry.EntityFramework'),
'suggestion': ChangeSDKSuggestion('sentry.dotnet.entityframework', ['Sentry.EntityFramework']),
},
{
'sdk_name': 'sentry.dotnet',
'sdk_version_added': '0.0.0',
'module_name': 'log4net',
'module_version_min': '2.0.8',
'suggestion': ChangeSDKSuggestion('sentry.dotnet.log4net', 'Sentry.Log4Net'),
'suggestion': ChangeSDKSuggestion('sentry.dotnet.log4net', ['Sentry.Log4Net']),
},
{
'sdk_name': 'sentry.dotnet',
'sdk_version_added': '0.0.0',
'module_name': 'Microsoft.Extensions.Logging.Configuration',
'module_version_min': '2.1.0',
'suggestion': ChangeSDKSuggestion('sentry.dotnet.extensions.logging', 'Sentry.Extensions.Logging'),
# For some reason the SDK does not always report the
# `Sentry.Extensions.Logging` module (observed in ASP.NET apps that use
# the logging SDK implicitly).
'suggestion': ChangeSDKSuggestion('sentry.dotnet.extensions.logging', ['Sentry.Extensions.Logging', 'Sentry.AspNetCore']),
},
{
'sdk_name': 'sentry.dotnet',
'sdk_version_added': '0.0.0',
'module_name': 'Serilog',
'module_version_min': '2.7.1',
'suggestion': ChangeSDKSuggestion('sentry.dotnet.serilog', 'Sentry.Serilog'),
'suggestion': ChangeSDKSuggestion('sentry.dotnet.serilog', ['Sentry.Serilog']),
},
{
'sdk_name': 'sentry.dotnet',
'sdk_version_added': '0.0.0',
'module_name': 'NLog',
'module_version_min': '4.6.0',
'suggestion': ChangeSDKSuggestion('sentry.dotnet.nlog', 'Sentry.NLog'),
'suggestion': ChangeSDKSuggestion('sentry.dotnet.nlog', ['Sentry.NLog']),
},
]

Expand Down