Skip to content

Add source to C# Telemetry Generator as a common field #978

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
merged 2 commits into from
Feb 21, 2025
Merged

Add source to C# Telemetry Generator as a common field #978

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
bfe3947
add for VisualStudio
nkomonen-amazon Feb 21, 2025
2dcddb0
Update expected test results
awschristou Feb 21, 2025
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
6 changes: 6 additions & 0 deletions telemetry/csharp/AwsToolkit.Telemetry.Events.Generator.Core/DefinitionsBuilder.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ public class DefinitionsBuilder
{
"reason",
"reasonDesc",
"source",
"errorCode",
"causedBy",
"httpStatusCode",
Expand Down Expand Up @@ -440,6 +441,11 @@ private CodeMemberMethod CreateRecordMetricMethodByDataClass(Metric metric)
tryStatements.Add(new CodeExpressionStatement(new CodeMethodInvokeExpression(datumAddData,
new CodePrimitiveExpression("reasonDesc"), payloadReasonDescription)));

// Generate: datum.AddMetadata("source", payload.Source);
var payloadSource = new CodeFieldReferenceExpression(payload, "Source");
tryStatements.Add(new CodeExpressionStatement(new CodeMethodInvokeExpression(datumAddData,
new CodePrimitiveExpression("source"), payloadSource)));

// Generate: datum.AddMetadata("errorCode", payload.ErrorCode);
var payloadErrorCode = new CodeFieldReferenceExpression(payload, "ErrorCode");
tryStatements.Add(new CodeExpressionStatement(new CodeMethodInvokeExpression(datumAddData,
Expand Down
7 changes: 7 additions & 0 deletions ...lkit.Telemetry.Events.Generator.Tests/SampleData/Outcomes/sampleDefinitions-generated.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ namespace Test
datum.AddMetadata("awsRegion", payload.AwsRegion);
datum.AddMetadata("reason", payload.Reason);
datum.AddMetadata("reasonDesc", payload.ReasonDescription);
datum.AddMetadata("source", payload.Source);
datum.AddMetadata("errorCode", payload.ErrorCode);
datum.AddMetadata("causedBy", payload.CausedBy);
datum.AddMetadata("httpStatusCode", payload.HttpStatusCode);
Expand Down Expand Up @@ -118,6 +119,7 @@ namespace Test
datum.AddMetadata("awsRegion", payload.AwsRegion);
datum.AddMetadata("reason", payload.Reason);
datum.AddMetadata("reasonDesc", payload.ReasonDescription);
datum.AddMetadata("source", payload.Source);
datum.AddMetadata("errorCode", payload.ErrorCode);
datum.AddMetadata("causedBy", payload.CausedBy);
datum.AddMetadata("httpStatusCode", payload.HttpStatusCode);
Expand Down Expand Up @@ -178,6 +180,7 @@ namespace Test
datum.AddMetadata("awsRegion", payload.AwsRegion);
datum.AddMetadata("reason", payload.Reason);
datum.AddMetadata("reasonDesc", payload.ReasonDescription);
datum.AddMetadata("source", payload.Source);
datum.AddMetadata("errorCode", payload.ErrorCode);
datum.AddMetadata("causedBy", payload.CausedBy);
datum.AddMetadata("httpStatusCode", payload.HttpStatusCode);
Expand Down Expand Up @@ -246,6 +249,7 @@ namespace Test
datum.AddMetadata("awsRegion", payload.AwsRegion);
datum.AddMetadata("reason", payload.Reason);
datum.AddMetadata("reasonDesc", payload.ReasonDescription);
datum.AddMetadata("source", payload.Source);
datum.AddMetadata("errorCode", payload.ErrorCode);
datum.AddMetadata("causedBy", payload.CausedBy);
datum.AddMetadata("httpStatusCode", payload.HttpStatusCode);
Expand Down Expand Up @@ -314,6 +318,7 @@ namespace Test
datum.AddMetadata("awsRegion", payload.AwsRegion);
datum.AddMetadata("reason", payload.Reason);
datum.AddMetadata("reasonDesc", payload.ReasonDescription);
datum.AddMetadata("source", payload.Source);
datum.AddMetadata("errorCode", payload.ErrorCode);
datum.AddMetadata("causedBy", payload.CausedBy);
datum.AddMetadata("httpStatusCode", payload.HttpStatusCode);
Expand Down Expand Up @@ -391,6 +396,7 @@ namespace Test
datum.AddMetadata("awsRegion", payload.AwsRegion);
datum.AddMetadata("reason", payload.Reason);
datum.AddMetadata("reasonDesc", payload.ReasonDescription);
datum.AddMetadata("source", payload.Source);
datum.AddMetadata("errorCode", payload.ErrorCode);
datum.AddMetadata("causedBy", payload.CausedBy);
datum.AddMetadata("httpStatusCode", payload.HttpStatusCode);
Expand Down Expand Up @@ -451,6 +457,7 @@ namespace Test
datum.AddMetadata("awsRegion", payload.AwsRegion);
datum.AddMetadata("reason", payload.Reason);
datum.AddMetadata("reasonDesc", payload.ReasonDescription);
datum.AddMetadata("source", payload.Source);
datum.AddMetadata("errorCode", payload.ErrorCode);
datum.AddMetadata("causedBy", payload.CausedBy);
datum.AddMetadata("httpStatusCode", payload.HttpStatusCode);
Expand Down
7 changes: 7 additions & 0 deletions ...t.Telemetry.Events.Generator.Tests/SampleData/Outcomes/sampleDefinitions-supplemental.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ namespace Test
datum.AddMetadata("awsRegion", payload.AwsRegion);
datum.AddMetadata("reason", payload.Reason);
datum.AddMetadata("reasonDesc", payload.ReasonDescription);
datum.AddMetadata("source", payload.Source);
datum.AddMetadata("errorCode", payload.ErrorCode);
datum.AddMetadata("causedBy", payload.CausedBy);
datum.AddMetadata("httpStatusCode", payload.HttpStatusCode);
Expand Down Expand Up @@ -118,6 +119,7 @@ namespace Test
datum.AddMetadata("awsRegion", payload.AwsRegion);
datum.AddMetadata("reason", payload.Reason);
datum.AddMetadata("reasonDesc", payload.ReasonDescription);
datum.AddMetadata("source", payload.Source);
datum.AddMetadata("errorCode", payload.ErrorCode);
datum.AddMetadata("causedBy", payload.CausedBy);
datum.AddMetadata("httpStatusCode", payload.HttpStatusCode);
Expand Down Expand Up @@ -178,6 +180,7 @@ namespace Test
datum.AddMetadata("awsRegion", payload.AwsRegion);
datum.AddMetadata("reason", payload.Reason);
datum.AddMetadata("reasonDesc", payload.ReasonDescription);
datum.AddMetadata("source", payload.Source);
datum.AddMetadata("errorCode", payload.ErrorCode);
datum.AddMetadata("causedBy", payload.CausedBy);
datum.AddMetadata("httpStatusCode", payload.HttpStatusCode);
Expand Down Expand Up @@ -246,6 +249,7 @@ namespace Test
datum.AddMetadata("awsRegion", payload.AwsRegion);
datum.AddMetadata("reason", payload.Reason);
datum.AddMetadata("reasonDesc", payload.ReasonDescription);
datum.AddMetadata("source", payload.Source);
datum.AddMetadata("errorCode", payload.ErrorCode);
datum.AddMetadata("causedBy", payload.CausedBy);
datum.AddMetadata("httpStatusCode", payload.HttpStatusCode);
Expand Down Expand Up @@ -314,6 +318,7 @@ namespace Test
datum.AddMetadata("awsRegion", payload.AwsRegion);
datum.AddMetadata("reason", payload.Reason);
datum.AddMetadata("reasonDesc", payload.ReasonDescription);
datum.AddMetadata("source", payload.Source);
datum.AddMetadata("errorCode", payload.ErrorCode);
datum.AddMetadata("causedBy", payload.CausedBy);
datum.AddMetadata("httpStatusCode", payload.HttpStatusCode);
Expand Down Expand Up @@ -391,6 +396,7 @@ namespace Test
datum.AddMetadata("awsRegion", payload.AwsRegion);
datum.AddMetadata("reason", payload.Reason);
datum.AddMetadata("reasonDesc", payload.ReasonDescription);
datum.AddMetadata("source", payload.Source);
datum.AddMetadata("errorCode", payload.ErrorCode);
datum.AddMetadata("causedBy", payload.CausedBy);
datum.AddMetadata("httpStatusCode", payload.HttpStatusCode);
Expand Down Expand Up @@ -451,6 +457,7 @@ namespace Test
datum.AddMetadata("awsRegion", payload.AwsRegion);
datum.AddMetadata("reason", payload.Reason);
datum.AddMetadata("reasonDesc", payload.ReasonDescription);
datum.AddMetadata("source", payload.Source);
datum.AddMetadata("errorCode", payload.ErrorCode);
datum.AddMetadata("causedBy", payload.CausedBy);
datum.AddMetadata("httpStatusCode", payload.HttpStatusCode);
Expand Down
7 changes: 7 additions & 0 deletions telemetry/csharp/AwsToolkit.Telemetry.Events/Core/BaseTelemetryEvent.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,13 @@ public abstract class BaseTelemetryEvent
/// </summary>
public string ReasonDescription;

/// <summary>
/// The source of the operation. This answers 'who' caused/triggered the operation.
/// Example: did an Auth signout happen because of some expiration or since the user
/// explicitly clicked the signout button.
/// </summary>
public string Source;

/// <summary>
/// Optional - User-friendly error codes describing a failed operation
/// This is often used in failure scenarios to provide additional details about why something failed.
Expand Down