Preview TraceWriter: Fixes Argument Null Exception / Null Reference Exception #2246
Conversation
bchong95
requested review from
ealsur,
FabianMeiswinkel,
j82w,
khdang,
kirankumarkolli,
kirillg and
sboshra
as code owners
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Please follow the required format: "[Internal] Category: (Adds|Fixes|Refactors) Description"
Examples:
Diagnostics: Adds GetElapsedClientLatency to CosmosDiagnostics
PartitionKey: Fixes null reference when using default(PartitionKey)
[v4] Client Encryption: Refactors code to external project
[Internal] Query: Adds code generator for CosmosNumbers for easy additions in the future.
Microsoft.Azure.Cosmos/src/Tracing/TraceWriter.TraceJsonWriter.cs
Outdated
Show resolved
Hide resolved
bchong95
changed the title
There was a problem hiding this comment.
Please follow the required format: "[Internal] Category: (Adds|Fixes|Refactors) Description"
Examples:
Diagnostics: Adds GetElapsedClientLatency to CosmosDiagnostics
PartitionKey: Fixes null reference when using default(PartitionKey)
[v4] Client Encryption: Refactors code to external project
[Internal] Query: Adds code generator for CosmosNumbers for easy additions in the future.
bchong95
changed the title
bchong95
changed the title
bchong95
changed the title
| @@ -158,7 +158,7 @@ public void Visit(PointOperationStatisticsTraceDatum pointOperationStatisticsTra | |||
| this.jsonWriter.WriteStringValue("PointOperationStatistics"); | |||
|
|
|||
| this.jsonWriter.WriteFieldName("ActivityId"); | |||
| this.jsonWriter.WriteStringValue(pointOperationStatisticsTraceDatum.ActivityId); | |||
| this.WriteStringValueOrNull(pointOperationStatisticsTraceDatum.ActivityId); | |||
|
|
|||
| this.jsonWriter.WriteFieldName("ResponseTimeUtc"); | |||
| this.jsonWriter.WriteStringValue(pointOperationStatisticsTraceDatum.ResponseTimeUtc.ToString("o", CultureInfo.InvariantCulture)); | |||
There was a problem hiding this comment.
I think it is after the diff.
Preview TraceWriter: Fixes NRE
Description
The trace datum classes don't have a strong contract with null. Values like endpoint are sometimes allowed to be null. In the old trace writer we would call on Newtonsoft's JsonWriter.WriteValue(value), which is tolerant of null values. Currently we use Cosmos.Json.JsonWriter.WriteStringValue() which does not handle null. The fix is to just handle null in the writer. We can not push the invariants up to the type, since we don't know what code in production might set a value to null and don't want to cause a NullArgumentException at runtime. As we see diagnostics with nulls we can investigate what caused it and hunt down the values.