Skip to content

Fix for #4965, #6274

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 6 commits into from
May 30, 2018
Merged

Fix for #4965, #6274

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8b61bc8
Fix for #4965,
praries880 May 22, 2018
41fd1c7
Add invocation name to the telemetry
praries880 May 22, 2018
fdbcfb6
Took care of review comments
praries880 May 23, 2018
f0eac80
Fix typo
praries880 May 23, 2018
51448db
Fix indentation
praries880 May 24, 2018
8f3b381
Merge branch 'preview' into update_telemetry
praries880 May 29, 2018
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
15 changes: 15 additions & 0 deletions src/Common/Commands.Common/MetricHelper.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,16 @@ private void LogExceptionEvent(AzurePSQoSEvent qos)
eventProperties.Add("Message", "Message removed due to PII.");
eventProperties.Add("StackTrace", qos.Exception.StackTrace);
eventProperties.Add("ExceptionType", qos.Exception.GetType().ToString());
Exception innerEx = qos.Exception.InnerException;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I forget, how do we feel about var?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure :)
Having said that... i would use a var when dealing with anonymous types.. in this case i odnt foresee it changeing from Exception, so i explicitly use the type.

int exceptionCount = 0;
//keep goin till we get to the last inner exception
while (innerEx != null)
{
//Increment the inner exception count so that we can tell which is the outermost
//and which the innermost
eventProperties.Add("InnerExceptionType-"+exceptionCount++, innerEx.GetType().ToString());
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@praries880 do we need to return all of the inner exceptions? I want to make sure we're not cluttering the telemetry with information that may or may not be relevant to us

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cormacpayne I had initially missed this piece in the linked issue :"InnerExceptionType (shouls contain a list of inner exception types)"

Hence I am adding all the inner exceptions. I can create a comma separated list of exceptions and add it to the dictionary, but I thought it might be better to return each one as a separate item in the dictionary.

innerEx = innerEx.InnerException;
}
client.TrackException(null, eventProperties, eventMetrics);
}
}
Expand Down Expand Up @@ -266,6 +276,9 @@ private void PopulatePropertiesFromQos(AzurePSQoSEvent qos, IDictionary<string,
eventProperties.Add("HashMacAddress", HashMacAddress);
eventProperties.Add("PowerShellVersion", PSVersion);
eventProperties.Add("Version", AzurePowerShell.AssemblyVersion);
eventProperties.Add("CommandParameterSetName", qos.ParameterSetName);
eventProperties.Add("CommandInvocationName", qos.InvocationName);

if (qos.InputFromPipeline != null)
{
eventProperties.Add("InputFromPipeline", qos.InputFromPipeline.Value.ToString());
Expand Down Expand Up @@ -371,6 +384,8 @@ public class AzurePSQoSEvent
public string Uid { get; set; }
public string ClientRequestId { get; set; }
public string SessionId { get; set; }
public string ParameterSetName { get; set; }
public string InvocationName { get; set; }
public Dictionary<string, string> CustomProperties { get; private set; }

public AzurePSQoSEvent()
Expand Down
6 changes: 6 additions & 0 deletions src/ResourceManager/Common/Commands.ResourceManager.Common/AzureRMCmdlet.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,8 +204,14 @@ protected override void InitializeQosEvent()
ClientRequestId = this._clientRequestId,
SessionId = _sessionId,
IsSuccess = true,
ParameterSetName = this.ParameterSetName
};

if (this.MyInvocation != null && !string.IsNullOrWhiteSpace(this.MyInvocation.InvocationName))
{
_qosEvent.InvocationName = this.MyInvocation.InvocationName;
}

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not replace this whole thing (if-statement and all) with:

_qosEvent.InvocationName = this.MyInvocation?.InvocationName;

Or, can this.MyInvocation.InvocationName actually be whitespace?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure... What about the exception scenarios? Just wanted to play on the safer side and pass along only valid values.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@twitchax I don't believe that this.MyInvocation.InvocationName can be whitespace, but it never hurts to make the check 😀

if (this.MyInvocation != null && this.MyInvocation.BoundParameters != null
&& this.MyInvocation.BoundParameters.Keys != null)
{
Expand Down
4 changes: 4 additions & 0 deletions src/ResourceManager/Profile/ChangeLog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@
- Additional information about change #1
-->
## Current Release
* Added the following three values to the telemetry :
- Inner exception types
- ParameterSetName
- InvocationName
* Fix issue where version 10.0.3 of Newtonsoft.Json wasn't being loaded on module import

## Version 5.1.0
Expand Down