Improve feedback in 'Instance Crashed' email

[knolleary]

The email sent when an instance has crashed is extremely minimal and doesn't provide much help to the user as to what to do next, other than look at the logs.

It would be better to provide some more context to help the user decide what to do next.

The email is triggered by the launcher posting an audit-log entry following the abnormal exit of the NR process. If the launcher can provide some more information in that audit log entry we will be able to show that in the audit log as well as in the email.

Some initial thoughts/questions/things to investigate

1. Can the launcher tell the difference between 'killed due to memory' and 'uncaught exception' - the two most likely causes. If so, tailor the message accordingly.
2. Include a snippet of the logs preceding the exit. If there's an uncaught exception, we should be able to parse that out. It may be trickier to include the logs in the email and get the formatting right.
3. Depending on any insight we can infer from the logs, include recommended actions in the email.

The email should also include the team name to provide more context for what instance has crashed.

Tasks

Preview Give feedback

1. Update launcher to send exit info with crash log nr-launcher#311
   +0
   
2. Use launcher exit info to improve "Instance Crashed" email #4934
   +0
   
3. Changelog for enhanced diagnostic emails website#2897
   +0
   

[Steve-Mcl]

In order to include logs in the email, the narrow HTML format would suit being adjusted somewhat.

For example this is what logs in the unmodified layout look like:

By increasing max-width from 600 to 1200, this looks better and makes better use of available space

@cstns / @joepavitt - are we ok with adjusting the email layout to incorporate log table?

[Steve-Mcl]

This is the OOM error:

[cstns]

I don't see a problem with adjusting the width as long as it plays nicely with most email readers. I don't remember it being a topic of interest either, it was just that we didn't have a lot of content to display during the mvp and left it at that.

[joepavitt]

Can we put it in a <details> so that if people are viewing it on mobile it's not a massive scroll job?

[Steve-Mcl]

Can we put it in a <details> so that if people are viewing it on mobile it's not a massive scroll job?

Great minds think alike - that was what I tried first. Unfortunately...

While the <details> and <summary> elements are valid HTML5 and work in modern browsers, they have inconsistent support in email clients.

This means that while the HTML might be correctly interpreted in some email clients (like Apple Mail or Outlook for Mac), it's likely to fail in others (like Gmail, Outlook on Windows, or older email clients). In those cases, the content within the <details> tag might be displayed by default (ignoring the intended "hide/show" functionality), or it might not be displayed at all.

Therefore, it's generally not recommended to use <details> and <summary> in HTML emails if you need consistent rendering across different email clients.

NOTE: I do limit the log to 20 entries since typically, that is where the v8::xxx errors start apearing (it was originally 10 rows but I could not reliably determined the Out Of Memory error at 10 lines only.

[Steve-Mcl]

I can add you @joepavitt (or @cstns ) as an additional reviewer if desired - in case there is some formatting or other issue you wish to be improved? (PR in comming)