Skip to content
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

Jump to bottom

CosmosDiagnostics: Fixes regression in ITrace where direct diagnostics was not included in exception scenarios #2375

Merged
merged 2 commits into from
Apr 9, 2021
Merged

CosmosDiagnostics: Fixes regression in ITrace where direct diagnostics was not included in exception scenarios #2375

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
62400c1
Fixes regression causes the Client Side Request Stats to be missing
Apr 9, 2021
509469f
Merge branch 'master' into users/jawilley/iTrace/BackendLatency
j82w Apr 9, 2021
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
4 changes: 3 additions & 1 deletion Microsoft.Azure.Cosmos/src/Handler/TransportHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,8 @@ internal async Task<ResponseMessage> ProcessMessageAsync(
}

DocumentServiceRequest serviceRequest = request.ToDocumentServiceRequest();
serviceRequest.RequestContext.ClientRequestStatistics = new ClientSideRequestStatisticsTraceDatum(DateTime.UtcNow);
ClientSideRequestStatisticsTraceDatum clientSideRequestStatisticsTraceDatum = new ClientSideRequestStatisticsTraceDatum(DateTime.UtcNow);
serviceRequest.RequestContext.ClientRequestStatistics = clientSideRequestStatisticsTraceDatum;

//TODO: extrace auth into a separate handler
string authorization = await ((ICosmosAuthorizationTokenProvider)this.client.DocumentClient).GetUserAuthorizationTokenAsync(
Expand All @@ -90,6 +91,7 @@ internal async Task<ResponseMessage> ProcessMessageAsync(
Tracing.TraceLevel.Info))
{
request.Trace = processMessageAsyncTrace;
processMessageAsyncTrace.AddDatum("Client Side Request Stats", clientSideRequestStatisticsTraceDatum);

DocumentServiceResponse response = request.OperationType == OperationType.Upsert
? await this.ProcessUpsertAsync(storeProxy, serviceRequest, cancellationToken)
Expand Down
5 changes: 0 additions & 5 deletions Microsoft.Azure.Cosmos/src/Util/Extensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,11 +69,6 @@ internal static ResponseMessage ToCosmosResponseMessage(
Debug.Assert(requestMessage != null, nameof(requestMessage));
Headers headers = new Headers(documentServiceResponse.Headers);

if (documentServiceResponse.RequestStats is ClientSideRequestStatisticsTraceDatum traceDatum)
{
requestMessage.Trace.AddDatum("Client Side Request Stats", traceDatum);
}

if (requestChargeTracker != null && headers.RequestCharge < requestChargeTracker.TotalRequestCharge)
{
headers.RequestCharge = requestChargeTracker.TotalRequestCharge;
Expand Down
33 changes: 33 additions & 0 deletions ...lineTest/TestBaseline/EndToEndTraceWriterBaselineTests.PointOperationsExceptionsAsync.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@
│ └── Send Async(00000000-0000-0000-0000-000000000000) RequestHandler-Component MemberName@FilePath:42 12:00:00:000 0.00 milliseconds
│ └── Microsoft.Azure.Documents.ServerStoreModel Transport Request(00000000-0000-0000-0000-000000000000) Transport-Component MemberName@FilePath:42 12:00:00:000 0.00 milliseconds
│ (
│ [Client Side Request Stats]
│ Redacted To Not Change The Baselines From Run To Run
│ [Point Operation Statistics]
│ Redacted To Not Change The Baselines From Run To Run
│ )
Expand Down Expand Up @@ -185,6 +187,7 @@
"start time": "12:00:00:000",
"duration in milliseconds": 0,
"data": {
"Client Side Request Stats": "Redacted To Not Change The Baselines From Run To Run",
"Point Operation Statistics": "Redacted To Not Change The Baselines From Run To Run"
},
"children": []
Expand Down Expand Up @@ -724,12 +727,16 @@
│ └── Send Async(00000000-0000-0000-0000-000000000000) RequestHandler-Component MemberName@FilePath:42 12:00:00:000 0.00 milliseconds
│ └── Microsoft.Azure.Documents.ServerStoreModel Transport Request(00000000-0000-0000-0000-000000000000) Transport-Component MemberName@FilePath:42 12:00:00:000 0.00 milliseconds
│ │ (
│ │ [Client Side Request Stats]
│ │ Redacted To Not Change The Baselines From Run To Run
│ │ [Point Operation Statistics]
│ │ Redacted To Not Change The Baselines From Run To Run
│ │ )
│ └── Send Async(00000000-0000-0000-0000-000000000000) RequestHandler-Component MemberName@FilePath:42 12:00:00:000 0.00 milliseconds
│ └── Microsoft.Azure.Documents.ServerStoreModel Transport Request(00000000-0000-0000-0000-000000000000) Transport-Component MemberName@FilePath:42 12:00:00:000 0.00 milliseconds
│ (
│ [Client Side Request Stats]
│ Redacted To Not Change The Baselines From Run To Run
│ [Point Operation Statistics]
│ Redacted To Not Change The Baselines From Run To Run
│ )
Expand Down Expand Up @@ -868,6 +875,7 @@
"start time": "12:00:00:000",
"duration in milliseconds": 0,
"data": {
"Client Side Request Stats": "Redacted To Not Change The Baselines From Run To Run",
"Point Operation Statistics": "Redacted To Not Change The Baselines From Run To Run"
},
"children": [
Expand Down Expand Up @@ -896,6 +904,7 @@
"start time": "12:00:00:000",
"duration in milliseconds": 0,
"data": {
"Client Side Request Stats": "Redacted To Not Change The Baselines From Run To Run",
"Point Operation Statistics": "Redacted To Not Change The Baselines From Run To Run"
},
"children": []
Expand Down Expand Up @@ -1020,18 +1029,24 @@
│ └── Send Async(00000000-0000-0000-0000-000000000000) RequestHandler-Component MemberName@FilePath:42 12:00:00:000 0.00 milliseconds
│ └── Microsoft.Azure.Documents.ServerStoreModel Transport Request(00000000-0000-0000-0000-000000000000) Transport-Component MemberName@FilePath:42 12:00:00:000 0.00 milliseconds
│ │ (
│ │ [Client Side Request Stats]
│ │ Redacted To Not Change The Baselines From Run To Run
│ │ [Point Operation Statistics]
│ │ Redacted To Not Change The Baselines From Run To Run
│ │ )
│ └── Send Async(00000000-0000-0000-0000-000000000000) RequestHandler-Component MemberName@FilePath:42 12:00:00:000 0.00 milliseconds
│ └── Microsoft.Azure.Documents.ServerStoreModel Transport Request(00000000-0000-0000-0000-000000000000) Transport-Component MemberName@FilePath:42 12:00:00:000 0.00 milliseconds
│ │ (
│ │ [Client Side Request Stats]
│ │ Redacted To Not Change The Baselines From Run To Run
│ │ [Point Operation Statistics]
│ │ Redacted To Not Change The Baselines From Run To Run
│ │ )
│ └── Send Async(00000000-0000-0000-0000-000000000000) RequestHandler-Component MemberName@FilePath:42 12:00:00:000 0.00 milliseconds
│ └── Microsoft.Azure.Documents.ServerStoreModel Transport Request(00000000-0000-0000-0000-000000000000) Transport-Component MemberName@FilePath:42 12:00:00:000 0.00 milliseconds
│ (
│ [Client Side Request Stats]
│ Redacted To Not Change The Baselines From Run To Run
│ [Point Operation Statistics]
│ Redacted To Not Change The Baselines From Run To Run
│ )
Expand Down Expand Up @@ -1170,6 +1185,7 @@
"start time": "12:00:00:000",
"duration in milliseconds": 0,
"data": {
"Client Side Request Stats": "Redacted To Not Change The Baselines From Run To Run",
"Point Operation Statistics": "Redacted To Not Change The Baselines From Run To Run"
},
"children": [
Expand Down Expand Up @@ -1198,6 +1214,7 @@
"start time": "12:00:00:000",
"duration in milliseconds": 0,
"data": {
"Client Side Request Stats": "Redacted To Not Change The Baselines From Run To Run",
"Point Operation Statistics": "Redacted To Not Change The Baselines From Run To Run"
},
"children": [
Expand Down Expand Up @@ -1226,6 +1243,7 @@
"start time": "12:00:00:000",
"duration in milliseconds": 0,
"data": {
"Client Side Request Stats": "Redacted To Not Change The Baselines From Run To Run",
"Point Operation Statistics": "Redacted To Not Change The Baselines From Run To Run"
},
"children": []
Expand Down Expand Up @@ -1354,30 +1372,40 @@
│ └── Send Async(00000000-0000-0000-0000-000000000000) RequestHandler-Component MemberName@FilePath:42 12:00:00:000 0.00 milliseconds
│ └── Microsoft.Azure.Documents.ServerStoreModel Transport Request(00000000-0000-0000-0000-000000000000) Transport-Component MemberName@FilePath:42 12:00:00:000 0.00 milliseconds
│ │ (
│ │ [Client Side Request Stats]
│ │ Redacted To Not Change The Baselines From Run To Run
│ │ [Point Operation Statistics]
│ │ Redacted To Not Change The Baselines From Run To Run
│ │ )
│ └── Send Async(00000000-0000-0000-0000-000000000000) RequestHandler-Component MemberName@FilePath:42 12:00:00:000 0.00 milliseconds
│ └── Microsoft.Azure.Documents.ServerStoreModel Transport Request(00000000-0000-0000-0000-000000000000) Transport-Component MemberName@FilePath:42 12:00:00:000 0.00 milliseconds
│ │ (
│ │ [Client Side Request Stats]
│ │ Redacted To Not Change The Baselines From Run To Run
│ │ [Point Operation Statistics]
│ │ Redacted To Not Change The Baselines From Run To Run
│ │ )
│ └── Send Async(00000000-0000-0000-0000-000000000000) RequestHandler-Component MemberName@FilePath:42 12:00:00:000 0.00 milliseconds
│ └── Microsoft.Azure.Documents.ServerStoreModel Transport Request(00000000-0000-0000-0000-000000000000) Transport-Component MemberName@FilePath:42 12:00:00:000 0.00 milliseconds
│ │ (
│ │ [Client Side Request Stats]
│ │ Redacted To Not Change The Baselines From Run To Run
│ │ [Point Operation Statistics]
│ │ Redacted To Not Change The Baselines From Run To Run
│ │ )
│ └── Send Async(00000000-0000-0000-0000-000000000000) RequestHandler-Component MemberName@FilePath:42 12:00:00:000 0.00 milliseconds
│ └── Microsoft.Azure.Documents.ServerStoreModel Transport Request(00000000-0000-0000-0000-000000000000) Transport-Component MemberName@FilePath:42 12:00:00:000 0.00 milliseconds
│ │ (
│ │ [Client Side Request Stats]
│ │ Redacted To Not Change The Baselines From Run To Run
│ │ [Point Operation Statistics]
│ │ Redacted To Not Change The Baselines From Run To Run
│ │ )
│ └── Send Async(00000000-0000-0000-0000-000000000000) RequestHandler-Component MemberName@FilePath:42 12:00:00:000 0.00 milliseconds
│ └── Microsoft.Azure.Documents.ServerStoreModel Transport Request(00000000-0000-0000-0000-000000000000) Transport-Component MemberName@FilePath:42 12:00:00:000 0.00 milliseconds
│ (
│ [Client Side Request Stats]
│ Redacted To Not Change The Baselines From Run To Run
│ [Point Operation Statistics]
│ Redacted To Not Change The Baselines From Run To Run
│ )
Expand Down Expand Up @@ -1516,6 +1544,7 @@
"start time": "12:00:00:000",
"duration in milliseconds": 0,
"data": {
"Client Side Request Stats": "Redacted To Not Change The Baselines From Run To Run",
"Point Operation Statistics": "Redacted To Not Change The Baselines From Run To Run"
},
"children": [
Expand Down Expand Up @@ -1544,6 +1573,7 @@
"start time": "12:00:00:000",
"duration in milliseconds": 0,
"data": {
"Client Side Request Stats": "Redacted To Not Change The Baselines From Run To Run",
"Point Operation Statistics": "Redacted To Not Change The Baselines From Run To Run"
},
"children": [
Expand Down Expand Up @@ -1572,6 +1602,7 @@
"start time": "12:00:00:000",
"duration in milliseconds": 0,
"data": {
"Client Side Request Stats": "Redacted To Not Change The Baselines From Run To Run",
"Point Operation Statistics": "Redacted To Not Change The Baselines From Run To Run"
},
"children": [
Expand Down Expand Up @@ -1600,6 +1631,7 @@
"start time": "12:00:00:000",
"duration in milliseconds": 0,
"data": {
"Client Side Request Stats": "Redacted To Not Change The Baselines From Run To Run",
"Point Operation Statistics": "Redacted To Not Change The Baselines From Run To Run"
},
"children": [
Expand Down Expand Up @@ -1628,6 +1660,7 @@
"start time": "12:00:00:000",
"duration in milliseconds": 0,
"data": {
"Client Side Request Stats": "Redacted To Not Change The Baselines From Run To Run",
"Point Operation Statistics": "Redacted To Not Change The Baselines From Run To Run"
},
"children": []
Expand Down
8 changes: 6 additions & 2 deletions ...os/tests/Microsoft.Azure.Cosmos.EmulatorTests/Tracing/EndToEndTraceWriterBaselineTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -960,8 +960,12 @@ public override Output ExecuteTest(Input input)
string text = TraceWriter.TraceToText(traceForBaselineTesting);
string json = TraceWriter.TraceToJson(traceForBaselineTesting);

// AssertTraceProperites(input.Trace);

//AssertTraceProperites(input.Trace);
Assert.IsTrue(text.Contains("Client Side Request Stats"), $"All diagnostics should have request stats: {text}");
Assert.IsTrue(json.Contains("Client Side Request Stats"), $"All diagnostics should have request stats: {json}");
Assert.IsTrue(text.Contains("Client Configuration"), $"All diagnostics should have Client Configuration: {text}");
Assert.IsTrue(json.Contains("Client Configuration"), $"All diagnostics should have Client Configuration: {json}");

return new Output(text, JToken.Parse(json).ToString(Newtonsoft.Json.Formatting.Indented));
}

Expand Down