microsoft / TemplateStudio

Template Studio accelerates the creation of new WinUI 3, WPF, and UWP apps using a wizard-based experience.

Other

2.7k stars 461 forks source link

Feature: Log and email exception details #298

Open mrlacey opened 7 years ago

mrlacey commented 7 years ago

Add ability to log exceptions when app is running and allow user to email those details to a specified address.

In addition to exception details the email should also include:

device info (manufacturer & name)
OS version
OS configured region/locale
app version
app use count
app install date
free disk space
anything else?

Also need to review possible 3rd party utils that could do this and consider using them before using a custom implementation. (I have an implementation if we go that route.)

jamesmcroft commented 7 years ago

I think this is a common scenario that is often used in applications. I don't have a full implementation in this exact format and functionality, but have a diagnostics helper I generally use in most applications to log events out to a log file which could easily be adapted.

In terms of the feature though, it's definitely useful.

crutkas commented 7 years ago

helpful, have this pump into a feedback hub item?

mrlacey commented 7 years ago

@crutkas The scenario for this is beyond what can be done with Feedback hub integration. In addition to feedback hub and any automatically captured analytics information about an exception, apps should have a way to communicate directly with the developer about any problems. This way developers can capture additional, specific information about the app, the system, and it's configuration and it makes it easier to have a conversation with the person reporting the issue.

crutkas commented 6 years ago

i feel like app insights or something like this is a better solution for this. this is old school style telem / exception handling to email.

mrlacey commented 6 years ago

This is a complement to automated telemetry and exception gathering. Having one doesn't invalidate the need for having the other.

Having someone provide exception details via email is an opportunity to connect with the person experiencing the issue and allow the developer to ask follow-up questions and gather more information that may not be available via telemetry.

From a product management perspective, it's another avenue for connecting with the people use the app. It can also be a good way of reminding developers that real people are impacted by exceptions, they're not just numbers on a report.

mrlacey commented 4 years ago

3709 will make this easier ;)