Fix nullref in Elastic.Apm.Extensions.Logging #1311
Merged
Conversation
This file contains 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
gregkalapos
commented
May 26, 2021
| @@ -42,7 +42,7 @@ public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Except | |||
|
|
|||
| if (_agent is ApmAgent apmAgent && exception != null) | |||
| { | |||
| errorLog.StackTrace = StacktraceHelper.GenerateApmStackTrace(exception, null, "CaptureErrorLogsAsApmError", | |||
There was a problem hiding this comment.
This was the problem 🤦
💔 Tests Failed
Expand to view the summary
Build stats
Test stats 🧪
Trends 🧪Test errors
Expand to view the tests failures
|
russcam
approved these changes
May 27, 2021
| @@ -48,7 +48,7 @@ internal static class StacktraceHelper | |||
| var len = stackTraceLimit == -1 ? frames.Length : Math.Min(frames.Length, stackTraceLimit); | |||
| var retVal = new List<CapturedStackFrame>(len); | |||
|
|
|||
| logger.Trace()?.Log("transform stack frames"); | |||
| logger?.Trace()?.Log("transform stack frames"); | |||
There was a problem hiding this comment.
The null conditional operator on logger looks unneccessary. StacktraceHelper is internal and GenerateApmStackTrace is called only by agent code where the logger should never be null (if it is null, it's a bug).
There was a problem hiding this comment.
Ok, there were some calls on logger with .? and some without it - I removed it from all of them.
| @@ -64,7 +64,7 @@ internal static class StacktraceHelper | |||
|
|
|||
| var fileName = frame?.GetFileName(); | |||
|
|
|||
| logger.Trace()?.Log("{MethodName}, {lineNo}", functionName, frame?.GetFileLineNumber()); | |||
| logger?.Trace()?.Log("{MethodName}, {lineNo}", functionName, frame?.GetFileLineNumber()); | |||
There was a problem hiding this comment.
The null conditional operator on logger looks unneccessary. StacktraceHelper is internal and GenerateApmStackTrace is called only by agent code where the logger should never be null (if it is null, it's a bug).
| @@ -42,7 +42,7 @@ public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Except | |||
|
|
|||
| if (_agent is ApmAgent apmAgent && exception != null) | |||
| { | |||
| errorLog.StackTrace = StacktraceHelper.GenerateApmStackTrace(exception, null, "CaptureErrorLogsAsApmError", | |||
| errorLog.StackTrace = StacktraceHelper.GenerateApmStackTrace(exception, _agent.Logger, "CaptureErrorLogsAsApmError", | |||
There was a problem hiding this comment.
minor nitpick:
Suggested change
| errorLog.StackTrace = StacktraceHelper.GenerateApmStackTrace(exception, _agent.Logger, "CaptureErrorLogsAsApmError", | |
| errorLog.StackTrace = StacktraceHelper.GenerateApmStackTrace(exception, apmAgent.Logger, "CaptureErrorLogsAsApmError", |
It makes no difference either way, but reads more intuitively to me, since the other passed values come from apmAgent
v1v
added a commit
to v1v/apm-agent-dotnet
that referenced
this pull request
Jun 8, 2021
…u-20 * upstream/master: (21 commits) Prefer W3C traceparent over elastic-apm-traceparent (elastic#1302) fix spacing and cross references in docs (elastic#1328) Update README (elastic#1325) Mark MicrosoftAzureBlobStorageTracer internal (elastic#1326) Update docs (elastic#1327) Update context.destination.address (elastic#1324) synchronize json schema specs (elastic#1320) Don't package Elastic.Apm.Specification (elastic#1316) Update setup.asciidoc (elastic#1318) Prepare release v.1.10.0 (elastic#1314) Fix nullref in Elastic.Apm.Extensions.Logging (elastic#1311) Capture errors with startup hook auto instrumentation (elastic#1298) Use Logger to log exception in AgentComponents initialization (elastic#1305) fix: use .NET native SDK for build and test (elastic#1301) Skip running Elasticsearch docker test when docker not available (elastic#1312) Use TraceLogger as default logger in ASP.NET Full Framework (elastic#1288) Create receive messaging span when inside transaction (elastic#1308) Fix SanitizeFieldNamesTests (elastic#1299) Do not capture HTTP child spans for Elasticsearch (elastic#1306) Use storage account in destination.service.resource (elastic#1284) ...
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.
Fixes #1309
Also extended the test to cover the case where the nullref happened.