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

Diagnostics: Adds Summary for Diagnostic message #2732

Merged
merged 15 commits into from
Sep 23, 2021
Merged

Diagnostics: Adds Summary for Diagnostic message #2732

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
073b448
Adds Summary for Diagnostic message
asketagarwal Sep 14, 2021
90e0f61
total time fix
asketagarwal Sep 14, 2021
e8fe37c
updating baseline perf
asketagarwal Sep 14, 2021
acc56f9
making classes structs
asketagarwal Sep 14, 2021
3cd301e
updating benchmark
asketagarwal Sep 14, 2021
50735e9
Merge branch 'master' into users/askagarw/summaryDiagnosticsImproved
j82w Sep 14, 2021
fe59982
Fix double parsing
asketagarwal Sep 15, 2021
e6429ee
Merge branch 'users/askagarw/summaryDiagnosticsImproved' of https://g…
asketagarwal Sep 15, 2021
58b4134
Merge branch 'master' into users/askagarw/summaryDiagnosticsImproved
j82w Sep 15, 2021
c372797
Merge branch 'master' into users/askagarw/summaryDiagnosticsImproved
j82w Sep 15, 2021
06cdbb0
changing summary contract
asketagarwal Sep 21, 2021
90da6e0
Merge branch 'users/askagarw/summaryDiagnosticsImproved' of https://g…
asketagarwal Sep 21, 2021
5b575ee
changing baseline
asketagarwal Sep 21, 2021
f64b654
Adding substatus code to gateway
asketagarwal Sep 22, 2021
ad285f5
Merge branch 'master' into users/askagarw/summaryDiagnosticsImproved
j82w Sep 22, 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
200 changes: 200 additions & 0 deletions Microsoft.Azure.Cosmos/src/Tracing/TraceData/SummaryDiagnostics.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,200 @@
// ------------------------------------------------------------
// Copyright (c) Microsoft Corporation. All rights reserved.
// ------------------------------------------------------------

namespace Microsoft.Azure.Cosmos.Tracing.TraceData
{
using System.Collections.Generic;
using Microsoft.Azure.Cosmos.Json;
using Microsoft.Azure.Documents;

internal struct SummaryDiagnostics
{
public SummaryDiagnostics(ITrace trace)
: this()
{
this.DirectRequestsSummary = new RequestSummary();
this.GatewayRequestsSummary = new RequestSummary();
this.TotalTimeInMs = trace.Duration.TotalMilliseconds;
this.CollectSummaryFromTraceTree(trace);
}

public double TotalTimeInMs { get; }
public double MaxServiceProcessingTimeInMs { get; private set; }
public double MaxGatewayRequestTimeInMs { get; private set; }
public RequestSummary DirectRequestsSummary { get; private set; }
public RequestSummary GatewayRequestsSummary { get; private set; }

private void CollectSummaryFromTraceTree(ITrace currentTrace)
{
foreach (object datums in currentTrace.Data.Values)
{
// TODO: Add MaxCpuUsage using CpuHistoryTraceDatum
if (datums is ClientSideRequestStatisticsTraceDatum clientSideRequestStatisticsTraceDatum)
{
this.AggregateStatsFromStoreResults(clientSideRequestStatisticsTraceDatum.StoreResponseStatisticsList);
this.AggregateGatewayStatistics(clientSideRequestStatisticsTraceDatum.HttpResponseStatisticsList);
}
}

foreach (ITrace childTrace in currentTrace.Children)
{
this.CollectSummaryFromTraceTree(childTrace);
}
}

private void AggregateGatewayStatistics(IReadOnlyList<ClientSideRequestStatisticsTraceDatum.HttpResponseStatistics> httpResponseStatisticsList)
{
foreach (ClientSideRequestStatisticsTraceDatum.HttpResponseStatistics httpResponseStatistics in httpResponseStatisticsList)
{
this.GatewayRequestsSummary = this.GatewayRequestsSummary.RecordStatusCode((httpResponseStatistics.HttpResponseMessage != null) ?
(int)httpResponseStatistics.HttpResponseMessage.StatusCode : 0);

if (httpResponseStatistics.Duration.TotalMilliseconds > this.MaxGatewayRequestTimeInMs)
{
this.MaxGatewayRequestTimeInMs = httpResponseStatistics.Duration.TotalMilliseconds;
}
}
}

private void AggregateStatsFromStoreResults(IReadOnlyList<ClientSideRequestStatisticsTraceDatum.StoreResponseStatistics> storeResponseStatisticsList)
{
foreach (ClientSideRequestStatisticsTraceDatum.StoreResponseStatistics storeResponseStatistics in storeResponseStatisticsList)
{
StatusCodes statusCode = storeResponseStatistics.StoreResult.StatusCode;
this.DirectRequestsSummary = this.DirectRequestsSummary.RecordStatusCode((int)statusCode);

if (double.TryParse(storeResponseStatistics.StoreResult.BackendRequestDurationInMs, out double backendLatency))
asketagarwal marked this conversation as resolved.
Show resolved Hide resolved
{
if (backendLatency > this.MaxServiceProcessingTimeInMs)
{
this.MaxServiceProcessingTimeInMs = backendLatency;
}
}
}
}

public void WriteSummaryDiagnostics(IJsonWriter jsonWriter)
{
jsonWriter.WriteObjectStart();

jsonWriter.WriteFieldName("TotalTimeMs");
jsonWriter.WriteNumber64Value(this.TotalTimeInMs);

if (this.DirectRequestsSummary.TotalCalls > 0)
{
jsonWriter.WriteFieldName("Direct");
jsonWriter.WriteObjectStart();
SummaryDiagnostics.WriteRequestSummaryObject(jsonWriter, this.DirectRequestsSummary);
jsonWriter.WriteObjectEnd();

jsonWriter.WriteFieldName("MaxBELatencyMs");
jsonWriter.WriteNumber64Value(this.MaxServiceProcessingTimeInMs);
}

if (this.GatewayRequestsSummary.TotalCalls > 0)
{
jsonWriter.WriteFieldName("Gateway");
jsonWriter.WriteObjectStart();
SummaryDiagnostics.WriteRequestSummaryObject(jsonWriter, this.GatewayRequestsSummary);
jsonWriter.WriteObjectEnd();

jsonWriter.WriteFieldName("MaxGatewayRequestTimeInMs");
jsonWriter.WriteNumber64Value(this.MaxGatewayRequestTimeInMs);
}

jsonWriter.WriteObjectEnd();
}

private static void WriteRequestSummaryObject(IJsonWriter jsonWriter, RequestSummary requestSummary)
{
if (requestSummary.SuccessfullCalls > 0)
{
jsonWriter.WriteFieldName("SuccessfullCalls");
jsonWriter.WriteNumber64Value(requestSummary.SuccessfullCalls);
}

if (requestSummary.NumberOf404s > 0)
{
jsonWriter.WriteFieldName("404");
jsonWriter.WriteNumber64Value(requestSummary.NumberOf404s);
}

if (requestSummary.NumberOf408s > 0)
{
jsonWriter.WriteFieldName("408");
jsonWriter.WriteNumber64Value(requestSummary.NumberOf408s);
}

if (requestSummary.NumberOf410s > 0)
{
jsonWriter.WriteFieldName("410");
jsonWriter.WriteNumber64Value(requestSummary.NumberOf410s);
}

if (requestSummary.NumberOf429s > 0)
{
jsonWriter.WriteFieldName("429");
jsonWriter.WriteNumber64Value(requestSummary.NumberOf429s);
}

if (requestSummary.NumberOf449s > 0)
{
jsonWriter.WriteFieldName("449");
jsonWriter.WriteNumber64Value(requestSummary.NumberOf449s);
}

if (requestSummary.OtherErrors > 0)
{
jsonWriter.WriteFieldName("OtherStatusCodes");
jsonWriter.WriteNumber64Value(requestSummary.OtherErrors);
}
}

public struct RequestSummary
{
public int TotalCalls { get; private set; }
public int NumberOf429s { get; private set; }
public int NumberOf410s { get; private set; }
public int NumberOf408s { get; private set; }
public int NumberOf449s { get; private set; }
public int NumberOf404s { get; private set; }
public int OtherErrors { get; private set; }
public int SuccessfullCalls { get; private set; }

public RequestSummary RecordStatusCode(int statusCode)
{
this.TotalCalls++;
if (statusCode >= 200 && statusCode <= 299)
{
this.SuccessfullCalls++;
return this;
}

switch (statusCode)
{
case 429:
this.NumberOf429s++;
break;
case 410:
this.NumberOf410s++;
break;
case 408:
this.NumberOf408s++;
break;
case 449:
this.NumberOf449s++;
break;
case 404:
this.NumberOf404s++;
break;
default:
this.OtherErrors++;
break;
}

return this;
}
}
}
}
14 changes: 12 additions & 2 deletions Microsoft.Azure.Cosmos/src/Tracing/TraceWriter.TraceJsonWriter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ private static class TraceJsonWriter
{
public static void WriteTrace(
IJsonWriter writer,
ITrace trace)
ITrace trace,
bool isRootTrace)
{
if (writer == null)
{
Expand All @@ -34,6 +35,13 @@ public static void WriteTrace(

writer.WriteObjectStart();

if (isRootTrace)
{
writer.WriteFieldName("Summary");
SummaryDiagnostics summaryDiagnostics = new SummaryDiagnostics(trace);
summaryDiagnostics.WriteSummaryDiagnostics(writer);
}

writer.WriteFieldName("name");
writer.WriteStringValue(trace.Name);

Expand Down Expand Up @@ -90,7 +98,9 @@ public static void WriteTrace(

foreach (ITrace child in trace.Children)
{
WriteTrace(writer, child);
WriteTrace(writer,
child,
isRootTrace: false);
}

writer.WriteArrayEnd();
Expand Down
4 changes: 3 additions & 1 deletion Microsoft.Azure.Cosmos/src/Tracing/TraceWriter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,9 @@ public static void WriteTrace(
IJsonWriter writer,
ITrace trace)
{
TraceJsonWriter.WriteTrace(writer, trace);
TraceJsonWriter.WriteTrace(writer,
trace,
isRootTrace: true);
}

public static string TraceToText(
Expand Down
3 changes: 3 additions & 0 deletions ...Tests/BaselineTest/TestBaseline/EndToEndTraceWriterBaselineTests.BatchOperationsAsync.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,9 @@
└── Create Trace(00000000-0000-0000-0000-000000000000) Batch-Component MemberName@FilePath:42 12:00:00:000 0.00 milliseconds
]]></Text>
<Json><![CDATA[{
"Summary": {
"TotalTimeMs": 0
},
"name": "ExecuteAsync",
"id": "00000000-0000-0000-0000-000000000000",
"caller info": {
Expand Down
33 changes: 33 additions & 0 deletions ...rTests/BaselineTest/TestBaseline/EndToEndTraceWriterBaselineTests.BulkOperationsAsync.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,9 @@
└── Create Trace(00000000-0000-0000-0000-000000000000) Batch-Component MemberName@FilePath:42 12:00:00:000 0.00 milliseconds
]]></Text>
<Json><![CDATA[{
"Summary": {
"TotalTimeMs": 0
},
"name": "CreateItemAsync",
"id": "00000000-0000-0000-0000-000000000000",
"caller info": {
Expand Down Expand Up @@ -242,6 +245,9 @@
└── Create Trace(00000000-0000-0000-0000-000000000000) Batch-Component MemberName@FilePath:42 12:00:00:000 0.00 milliseconds
]]></Text>
<Json><![CDATA[{
"Summary": {
"TotalTimeMs": 0
},
"name": "CreateItemAsync",
"id": "00000000-0000-0000-0000-000000000000",
"caller info": {
Expand Down Expand Up @@ -429,6 +435,9 @@
└── Create Trace(00000000-0000-0000-0000-000000000000) Batch-Component MemberName@FilePath:42 12:00:00:000 0.00 milliseconds
]]></Text>
<Json><![CDATA[{
"Summary": {
"TotalTimeMs": 0
},
"name": "CreateItemAsync",
"id": "00000000-0000-0000-0000-000000000000",
"caller info": {
Expand Down Expand Up @@ -616,6 +625,9 @@
└── Create Trace(00000000-0000-0000-0000-000000000000) Batch-Component MemberName@FilePath:42 12:00:00:000 0.00 milliseconds
]]></Text>
<Json><![CDATA[{
"Summary": {
"TotalTimeMs": 0
},
"name": "CreateItemAsync",
"id": "00000000-0000-0000-0000-000000000000",
"caller info": {
Expand Down Expand Up @@ -803,6 +815,9 @@
└── Create Trace(00000000-0000-0000-0000-000000000000) Batch-Component MemberName@FilePath:42 12:00:00:000 0.00 milliseconds
]]></Text>
<Json><![CDATA[{
"Summary": {
"TotalTimeMs": 0
},
"name": "CreateItemAsync",
"id": "00000000-0000-0000-0000-000000000000",
"caller info": {
Expand Down Expand Up @@ -990,6 +1005,9 @@
└── Create Trace(00000000-0000-0000-0000-000000000000) Batch-Component MemberName@FilePath:42 12:00:00:000 0.00 milliseconds
]]></Text>
<Json><![CDATA[{
"Summary": {
"TotalTimeMs": 0
},
"name": "CreateItemAsync",
"id": "00000000-0000-0000-0000-000000000000",
"caller info": {
Expand Down Expand Up @@ -1177,6 +1195,9 @@
└── Create Trace(00000000-0000-0000-0000-000000000000) Batch-Component MemberName@FilePath:42 12:00:00:000 0.00 milliseconds
]]></Text>
<Json><![CDATA[{
"Summary": {
"TotalTimeMs": 0
},
"name": "CreateItemAsync",
"id": "00000000-0000-0000-0000-000000000000",
"caller info": {
Expand Down Expand Up @@ -1364,6 +1385,9 @@
└── Create Trace(00000000-0000-0000-0000-000000000000) Batch-Component MemberName@FilePath:42 12:00:00:000 0.00 milliseconds
]]></Text>
<Json><![CDATA[{
"Summary": {
"TotalTimeMs": 0
},
"name": "CreateItemAsync",
"id": "00000000-0000-0000-0000-000000000000",
"caller info": {
Expand Down Expand Up @@ -1551,6 +1575,9 @@
└── Create Trace(00000000-0000-0000-0000-000000000000) Batch-Component MemberName@FilePath:42 12:00:00:000 0.00 milliseconds
]]></Text>
<Json><![CDATA[{
"Summary": {
"TotalTimeMs": 0
},
"name": "CreateItemAsync",
"id": "00000000-0000-0000-0000-000000000000",
"caller info": {
Expand Down Expand Up @@ -1738,6 +1765,9 @@
└── Create Trace(00000000-0000-0000-0000-000000000000) Batch-Component MemberName@FilePath:42 12:00:00:000 0.00 milliseconds
]]></Text>
<Json><![CDATA[{
"Summary": {
"TotalTimeMs": 0
},
"name": "CreateItemAsync",
"id": "00000000-0000-0000-0000-000000000000",
"caller info": {
Expand Down Expand Up @@ -2079,6 +2109,9 @@
└── Create Trace(00000000-0000-0000-0000-000000000000) Batch-Component MemberName@FilePath:42 12:00:00:000 0.00 milliseconds
]]></Text>
<Json><![CDATA[{
"Summary": {
"TotalTimeMs": 0
},
"name": "CreateItemAsync",
"id": "00000000-0000-0000-0000-000000000000",
"caller info": {
Expand Down
Loading