Como fazer com que o ELMAH inclua valores de sessão?
-
21-09-2019 - |
Pergunta
OBSERVAÇÃO:Conheço os vários motivos para evitar o uso da sessão, mas este é um projeto que herdei, então pule essa parte de qualquer resposta :)
Como é um problema resolvido, espero que alguém possa apontar para um patch/branch/fork ELMAH que inclua o registro de dados da sessão em vez de reinventar a roda.
Uma coisa estranha é uma postagem antiga do Atif que diz que eles já estão logados:
http://markmail.org/message/ncmdgwm5rmzewbwu
o comentarista henningst mencionou a adição de variáveis de sessão aqui:
http://www.hanselman.com/blog/ELMAHErrorLoggingModulesAndHandlersForASPNETAndMVCToo.aspx
Outra abordagem (prefiro evitar) é copiar os valores em cookies
Eu sei que uma alternativa é mudar para algo além do ELMAH (como Exceptioneer - veja http://exceptioneer.com/Public/ExceptioneerAndELMAH.aspx), mas como este é meu único problema com o ELMAH no momento, prefiro apenas ter um ELMAH corrigido do que mudar para outra coisa.
Solução
Atif respondeu no Twitter para dizer que não há patch conhecido:
http://twitter.com/raboof/statuses/7229453423
Então criei um patch que faz isso:
http://twitter.com/manningj/statuses/7231616905
http://blog.sublogic.com/2009/12/patch-to-enable-session-variable-logging-with-elmah/
Outras dicas
Em vez de corrigir o Elmah, fiz isso com dados de exceção.Em Global.asax inseri os dados extras na exceção em Application_Error()."HistoryStack" é minha própria classe para registrar o histórico do usuário, incluindo cliques em botões e guias:
void Application_Error(object sender, EventArgs e)
{
Exception ex = Server.GetLastError().GetBaseException();
var stack = HistoryStack.Dump(); // essentially grabs data from the session
ex.Data.Add("historyStack", stack);
}
Então, em ErrorMail_Mailing() peguei os dados de volta e anexei-os ao e-mail:
void ErrorMail_Mailing(object sender, Elmah.ErrorMailEventArgs e)
{
var stack = e.Error.Exception.Data["historyStack"] as Stack<string>;
if (stack == null && e.Error.Exception.InnerException != null)
{
// could probably skip the first try and go straight to this assignment:
stack = e.Error.Exception.InnerException.Data["historyStack"] as Stack<string>;
}
if (stack != null && stack.Count > 0)
{
e.Mail.Body = e.Mail.Body + "<h1>Browsing History</h1>" + System.Environment.NewLine;
while (stack.Count > 0)
{
e.Mail.Body = e.Mail.Body + stack.Pop() + "<br />" + System.Environment.NewLine;
}
}
}
Agora esses dados são anexados na parte inferior do e-mail.Não são necessários patches ou extensões.
O patch antigo que pode ser desenterrado infelizmente está um pouco desatualizado com Elmah agora.Aqui está o que eu fiz para registrar variáveis de sessão na versão 2.0.15523.27 com base em um patch mais antigo encontrado aqui: https://storage.googleapis.com/google-code-attachments/elmah/issue-12/comment-5/elmah-sessionVariables.patch
Em erro.cs
Importar System.Web.SessionState
using System.Web.SessionState;
Encontrar:
private NameValueCollection _serverVariables;
private NameValueCollection _queryString;
private NameValueCollection _form;
private NameValueCollection _cookies;
Adicione abaixo:
private NameValueCollection _sessionVariables;
Encontrar:
_serverVariables = CopyCollection(request.ServerVariables);
_queryString = CopyCollection(qsfc.QueryString);
_form = CopyCollection(qsfc.Form);
_cookies = CopyCollection(qsfc.Cookies);
Adicione abaixo:
_sessionVariables = CopyCollection(context.Session);
Encontrar:
public NameValueCollection Cookies
{
get { return FaultIn(ref _cookies); }
}
Adicione abaixo:
/// <summary>
/// Gets a collection representing the session variables captured as part of the diagnostic data
/// </summary>
public NameValueCollection SessionVariables
{
get { return FaultIn(ref _sessionVariables); }
}
Encontrar:
copy._serverVariables = CopyCollection(_serverVariables);
copy._queryString = CopyCollection(_queryString);
copy._form = CopyCollection(_form);
copy._cookies = CopyCollection(_cookies);
Adicione abaixo:
copy._sessionVariables = CopyCollection(_sessionVariables);
Encontrar:
private static NameValueCollection CopyCollection(NameValueCollection collection)
Adicione acima:
private static NameValueCollection CopyCollection(HttpSessionStateBase sessionVariables)
{
if (sessionVariables == null || sessionVariables.Count == 0)
return null;
var copy = new NameValueCollection(sessionVariables.Count);
for (int i = 0; i < sessionVariables.Count; i++)
copy.Add(sessionVariables.Keys[i], sessionVariables[i].ToString());
return copy;
}
Em erroJson.cs
Encontrar:
Member(writer, "queryString", error.QueryString);
Member(writer, "form", error.Form);
Member(writer, "cookies", error.Cookies);
Adicione abaixo:
Member(writer, "sessionVariables", error.SessionVariables);
Em ErroXml.cs
Encontrar:
case "form" : collection = error.Form; break;
case "cookies" : collection = error.Cookies; break;
Adicione abaixo:
case "sessionVariables": collection = error.SessionVariables; break;
Encontrar:
WriteCollection(writer, "form", error.Form);
WriteCollection(writer, "cookies", error.Cookies);
Adicione abaixo:
WriteCollection(writer, "sessionVariables", error.SessionVariables);
Em ErrorMailHtmlPage.cshtml
Encontrar:
<p>@(RenderPartial<PoweredBy>())</p>
Adicione acima:
@foreach (var collection in
from collection in new[]
{
new
{
Id = "SessionVariables",
Title = "Session Variables",
Items = error.SessionVariables,
}
}
let data = collection.Items
where data != null && data.Count > 0
let items = from i in Enumerable.Range(0, data.Count)
select KeyValuePair.Create(data.GetKey(i), data[i])
select new
{
collection.Id,
collection.Title,
Items = items.OrderBy(e => e.Key, StringComparer.OrdinalIgnoreCase)
}
)
{
<div id="@collection.Id">
<h1>@collection.Title</h1>
<table class="collection">
<tr><th>Name</th>
<th>Value</th></tr>
@foreach (var item in collection.Items)
{
<tr><td>@item.Key</td>
<td>@item.Value</td></tr>
}
</table>
</div>
}
Depois de fazer alterações em ErrorMailHtmlPage.cshtml no Visual Studio, clique com o botão direito no arquivo e "Executar ferramenta personalizada" para gerar o código para ErrorMailHtmlPage.generated.cs
Em ErrorDetailPage.cshtml
Encontre (no final do arquivo):
@*
}
*@
Adicione acima:
@{
var sessioncollection = new
{
Data = error.SessionVariables,
Id = "SessionVariables",
Title = "Session Variables",
};
//
// If the collection isn't there or it's empty, then bail out.
//
if (sessioncollection.Data != null && sessioncollection.Data.Count > 0)
{
var items =
from i in Enumerable.Range(0, sessioncollection.Data.Count)
select new
{
Index = i,
Key = sessioncollection.Data.GetKey(i),
Value = sessioncollection.Data[i],
};
items = items.OrderBy(e => e.Key, StringComparer.OrdinalIgnoreCase);
<div id="@sessioncollection.Id">
<h2>@sessioncollection.Title</h2>
@*
// Some values can be large and add scroll bars to the page
// as well as ruin some formatting. So we encapsulate the
// table into a scrollable view that is controlled via the
// style sheet.
*@
<div class="scroll-view">
<table cellspacing="0" style="border-collapse:collapse;" class="table table-condensed table-striped">
<tr>
<th class="name-col" style="white-space:nowrap;">Name</th>
<th class="value-col" style="white-space:nowrap;">Value</th>
</tr>
@foreach (var item in items)
{
<tr class="@(item.Index % 2 == 0 ? "even" : "odd")">
<td class="key-col">@item.Key</td>
<td class="value-col">@item.Value</td>
</tr>
}
</table>
</div>
</div>
}
}
Depois de fazer alterações em ErrorDetailPage.cshtml no Visual Studio, clique com o botão direito no arquivo e "Executar ferramenta personalizada" para gerar o código para ErrorDetailPage.generated.cs
Agora você pode construir (usei apenas o arquivo build.cmd que foi incluído no projeto) e pegar os arquivos ddl necessários do bin.
- AntiXssLibrary.dll
- Elmah.AspNet.dll
- Elmah.dll
Talvez você também precise modificar o web.config em seu projeto agora para incluir a versão em quaisquer referências ao Elmah.Se você estiver usando o Resharper, basta clicar em cada um deles e corrigi-los.(Provavelmente há uma maneira diferente de fazer isso para evitar isso, mas não tenho certeza e não estava muito preocupado em descobrir isso)
Um exemplo de um deles seria mudar
<section name="security" requirePermission="false" type="Elmah.SecuritySectionHandler, Elmah" />
para
<section name="security" requirePermission="false" type="Elmah.SecuritySectionHandler, Elmah.AspNet, Version=2.0.15523.27, Culture=neutral, PublicKeyToken=null" />