Skip to content

Commit c15f1e1

Browse files
BrennanConroyBrennanConroy
authored
[SignalR] Change log levels (#12742)
1 parent d312d79 commit c15f1e1

File tree

9 files changed

+71
-256
lines changed

9 files changed

+71
-256
lines changed

‎src/SignalR/clients/csharp/Client/test/FunctionalTests/HubConnectionTests.cs

Lines changed: 13 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -491,13 +491,8 @@ public async Task StreamAsyncTest(string protocolName, HttpTransportType transpo
491491
[LogLevel(LogLevel.Trace)]
492492
public async Task StreamAsyncDoesNotStartIfTokenAlreadyCanceled(string protocolName, HttpTransportType transportType, string path)
493493
{
494-
bool ExpectedErrors(WriteContext writeContext)
495-
{
496-
return writeContext.LoggerName == DefaultHubDispatcherLoggerName &&
497-
writeContext.EventId.Name == "FailedInvokingHubMethod";
498-
}
499494
var protocol = HubProtocols[protocolName];
500-
using (StartServer<Startup>(out var server, ExpectedErrors))
495+
using (StartServer<Startup>(out var server))
501496
{
502497
var connection = CreateHubConnection(server.Url, path, transportType, protocol, LoggerFactory);
503498
try
@@ -901,16 +896,8 @@ await Assert.ThrowsAsync<TaskCanceledException>(async () =>
901896
[LogLevel(LogLevel.Trace)]
902897
public async Task CanCloseStreamMethodEarly(string protocolName, HttpTransportType transportType, string path)
903898
{
904-
bool ExpectedErrors(WriteContext writeContext)
905-
{
906-
// Writing is not allowed after writer was completed.
907-
// Can happen since we are closing the connection while the connection could still be writing the streaming data
908-
return writeContext.LoggerName == typeof(HubConnectionContext).FullName &&
909-
writeContext.EventId.Name == "FailedWritingMessage";
910-
}
911-
912899
var protocol = HubProtocols[protocolName];
913-
using (StartServer<Startup>(out var server, ExpectedErrors))
900+
using (StartServer<Startup>(out var server))
914901
{
915902
var connection = CreateHubConnection(server.Url, path, transportType, protocol, LoggerFactory);
916903
try
@@ -1013,14 +1000,8 @@ bool ExpectedErrors(WriteContext writeContext)
10131000
[MemberData(nameof(HubProtocolsAndTransportsAndHubPaths))]
10141001
public async Task ServerThrowsHubExceptionIfHubMethodCannotBeResolved(string hubProtocolName, HttpTransportType transportType, string hubPath)
10151002
{
1016-
bool ExpectedErrors(WriteContext writeContext)
1017-
{
1018-
return writeContext.LoggerName == DefaultHubDispatcherLoggerName &&
1019-
writeContext.EventId.Name == "FailedInvokingHubMethod";
1020-
}
1021-
10221003
var hubProtocol = HubProtocols[hubProtocolName];
1023-
using (StartServer<Startup>(out var server, ExpectedErrors))
1004+
using (StartServer<Startup>(out var server))
10241005
{
10251006
var connection = CreateHubConnection(server.Url, hubPath, transportType, hubProtocol, LoggerFactory);
10261007
try
@@ -1046,14 +1027,8 @@ bool ExpectedErrors(WriteContext writeContext)
10461027
[MemberData(nameof(HubProtocolsAndTransportsAndHubPaths))]
10471028
public async Task ServerThrowsHubExceptionIfHubMethodCannotBeResolvedAndArgumentsPassedIn(string hubProtocolName, HttpTransportType transportType, string hubPath)
10481029
{
1049-
bool ExpectedErrors(WriteContext writeContext)
1050-
{
1051-
return writeContext.LoggerName == DefaultHubDispatcherLoggerName &&
1052-
writeContext.EventId.Name == "FailedInvokingHubMethod";
1053-
}
1054-
10551030
var hubProtocol = HubProtocols[hubProtocolName];
1056-
using (StartServer<Startup>(out var server, ExpectedErrors))
1031+
using (StartServer<Startup>(out var server))
10571032
{
10581033
var connection = CreateHubConnection(server.Url, hubPath, transportType, hubProtocol, LoggerFactory);
10591034
try
@@ -1079,14 +1054,8 @@ bool ExpectedErrors(WriteContext writeContext)
10791054
[MemberData(nameof(HubProtocolsList))]
10801055
public async Task ServerThrowsHubExceptionOnHubMethodArgumentCountMismatch(string hubProtocolName)
10811056
{
1082-
bool ExpectedErrors(WriteContext writeContext)
1083-
{
1084-
return writeContext.LoggerName == DefaultHubDispatcherLoggerName &&
1085-
writeContext.EventId.Name == "FailedInvokingHubMethod";
1086-
}
1087-
10881057
var hubProtocol = HubProtocols[hubProtocolName];
1089-
using (StartServer<Startup>(out var server, ExpectedErrors))
1058+
using (StartServer<Startup>(out var server))
10901059
{
10911060
var connection = CreateHubConnection(server.Url, "/default", HttpTransportType.LongPolling, hubProtocol, LoggerFactory);
10921061
try
@@ -1112,14 +1081,8 @@ bool ExpectedErrors(WriteContext writeContext)
11121081
[MemberData(nameof(HubProtocolsAndTransportsAndHubPaths))]
11131082
public async Task ServerThrowsHubExceptionOnHubMethodArgumentTypeMismatch(string hubProtocolName, HttpTransportType transportType, string hubPath)
11141083
{
1115-
bool ExpectedErrors(WriteContext writeContext)
1116-
{
1117-
return writeContext.LoggerName == DefaultHubDispatcherLoggerName &&
1118-
writeContext.EventId.Name == "FailedInvokingHubMethod";
1119-
}
1120-
11211084
var hubProtocol = HubProtocols[hubProtocolName];
1122-
using (StartServer<Startup>(out var server, ExpectedErrors))
1085+
using (StartServer<Startup>(out var server))
11231086
{
11241087
var connection = CreateHubConnection(server.Url, hubPath, transportType, hubProtocol, LoggerFactory);
11251088
try
@@ -1145,14 +1108,8 @@ bool ExpectedErrors(WriteContext writeContext)
11451108
[MemberData(nameof(HubProtocolsAndTransportsAndHubPaths))]
11461109
public async Task ServerThrowsHubExceptionIfStreamingHubMethodCannotBeResolved(string hubProtocolName, HttpTransportType transportType, string hubPath)
11471110
{
1148-
bool ExpectedErrors(WriteContext writeContext)
1149-
{
1150-
return writeContext.LoggerName == DefaultHubDispatcherLoggerName &&
1151-
writeContext.EventId.Name == "FailedInvokingHubMethod";
1152-
}
1153-
11541111
var hubProtocol = HubProtocols[hubProtocolName];
1155-
using (StartServer<Startup>(out var server, ExpectedErrors))
1112+
using (StartServer<Startup>(out var server))
11561113
{
11571114
var connection = CreateHubConnection(server.Url, hubPath, transportType, hubProtocol, LoggerFactory);
11581115
try
@@ -1179,14 +1136,8 @@ bool ExpectedErrors(WriteContext writeContext)
11791136
[MemberData(nameof(HubProtocolsAndTransportsAndHubPaths))]
11801137
public async Task ServerThrowsHubExceptionOnStreamingHubMethodArgumentCountMismatch(string hubProtocolName, HttpTransportType transportType, string hubPath)
11811138
{
1182-
bool ExpectedErrors(WriteContext writeContext)
1183-
{
1184-
return writeContext.LoggerName == DefaultHubDispatcherLoggerName &&
1185-
writeContext.EventId.Name == "FailedInvokingHubMethod";
1186-
}
1187-
11881139
var hubProtocol = HubProtocols[hubProtocolName];
1189-
using (StartServer<Startup>(out var server, ExpectedErrors))
1140+
using (StartServer<Startup>(out var server))
11901141
{
11911142
var connection = CreateHubConnection(server.Url, hubPath, transportType, hubProtocol, LoggerFactory);
11921143
try
@@ -1213,14 +1164,8 @@ bool ExpectedErrors(WriteContext writeContext)
12131164
[MemberData(nameof(HubProtocolsAndTransportsAndHubPaths))]
12141165
public async Task ServerThrowsHubExceptionOnStreamingHubMethodArgumentTypeMismatch(string hubProtocolName, HttpTransportType transportType, string hubPath)
12151166
{
1216-
bool ExpectedErrors(WriteContext writeContext)
1217-
{
1218-
return writeContext.LoggerName == DefaultHubDispatcherLoggerName &&
1219-
writeContext.EventId.Name == "FailedInvokingHubMethod";
1220-
}
1221-
12221167
var hubProtocol = HubProtocols[hubProtocolName];
1223-
using (StartServer<Startup>(out var server, ExpectedErrors))
1168+
using (StartServer<Startup>(out var server))
12241169
{
12251170
var connection = CreateHubConnection(server.Url, hubPath, transportType, hubProtocol, LoggerFactory);
12261171
try
@@ -1247,14 +1192,8 @@ bool ExpectedErrors(WriteContext writeContext)
12471192
[MemberData(nameof(HubProtocolsAndTransportsAndHubPaths))]
12481193
public async Task ServerThrowsHubExceptionIfNonStreamMethodInvokedWithStreamAsync(string hubProtocolName, HttpTransportType transportType, string hubPath)
12491194
{
1250-
bool ExpectedErrors(WriteContext writeContext)
1251-
{
1252-
return writeContext.LoggerName == DefaultHubDispatcherLoggerName &&
1253-
writeContext.EventId.Name == "NonStreamingMethodCalledWithStream";
1254-
}
1255-
12561195
var hubProtocol = HubProtocols[hubProtocolName];
1257-
using (StartServer<Startup>(out var server, ExpectedErrors))
1196+
using (StartServer<Startup>(out var server))
12581197
{
12591198
var connection = CreateHubConnection(server.Url, hubPath, transportType, hubProtocol, LoggerFactory);
12601199
try
@@ -1280,14 +1219,8 @@ bool ExpectedErrors(WriteContext writeContext)
12801219
[MemberData(nameof(HubProtocolsAndTransportsAndHubPaths))]
12811220
public async Task ServerThrowsHubExceptionIfStreamMethodInvokedWithInvoke(string hubProtocolName, HttpTransportType transportType, string hubPath)
12821221
{
1283-
bool ExpectedErrors(WriteContext writeContext)
1284-
{
1285-
return writeContext.LoggerName == DefaultHubDispatcherLoggerName &&
1286-
writeContext.EventId.Name == "StreamingMethodCalledWithInvoke";
1287-
}
1288-
12891222
var hubProtocol = HubProtocols[hubProtocolName];
1290-
using (StartServer<Startup>(out var server, ExpectedErrors))
1223+
using (StartServer<Startup>(out var server))
12911224
{
12921225
var connection = CreateHubConnection(server.Url, hubPath, transportType, hubProtocol, LoggerFactory);
12931226
try
@@ -1313,14 +1246,8 @@ bool ExpectedErrors(WriteContext writeContext)
13131246
[MemberData(nameof(HubProtocolsAndTransportsAndHubPaths))]
13141247
public async Task ServerThrowsHubExceptionIfBuildingAsyncEnumeratorIsNotPossible(string hubProtocolName, HttpTransportType transportType, string hubPath)
13151248
{
1316-
bool ExpectedErrors(WriteContext writeContext)
1317-
{
1318-
return writeContext.LoggerName == DefaultHubDispatcherLoggerName &&
1319-
writeContext.EventId.Name == "InvalidReturnValueFromStreamingMethod";
1320-
}
1321-
13221249
var hubProtocol = HubProtocols[hubProtocolName];
1323-
using (StartServer<Startup>(out var server, ExpectedErrors))
1250+
using (StartServer<Startup>(out var server))
13241251
{
13251252
var connection = CreateHubConnection(server.Url, hubPath, transportType, hubProtocol, LoggerFactory);
13261253
try
@@ -1345,16 +1272,11 @@ bool ExpectedErrors(WriteContext writeContext)
13451272
[Fact]
13461273
public async Task RandomGenericIsNotTreatedAsStream()
13471274
{
1348-
bool ExpectedErrors(WriteContext writeContext)
1349-
{
1350-
return "Microsoft.AspNetCore.SignalR.Internal.DefaultHubDispatcher" == writeContext.LoggerName &&
1351-
"FailedInvokingHubMethod" == writeContext.EventId.Name;
1352-
}
13531275
var hubPath = HubPaths[0];
13541276
var hubProtocol = HubProtocols.First().Value;
13551277
var transportType = TransportTypes().First().Cast<HttpTransportType>().First();
13561278

1357-
using (StartServer<Startup>(out var server, ExpectedErrors))
1279+
using (StartServer<Startup>(out var server))
13581280
{
13591281
var connection = CreateHubConnection(server.Url, hubPath, transportType, hubProtocol, LoggerFactory);
13601282
await connection.StartAsync().OrTimeout();

‎src/SignalR/common/Http.Connections/src/Internal/HttpConnectionDispatcher.Log.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ internal static class Log
3232
LoggerMessage.Define<HttpTransportType>(LogLevel.Debug, new EventId(7, "TransportNotSupported"), "{TransportType} transport not supported by this connection handler.");
3333

3434
private static readonly Action<ILogger, HttpTransportType, HttpTransportType, Exception> _cannotChangeTransport =
35-
LoggerMessage.Define<HttpTransportType, HttpTransportType>(LogLevel.Error, new EventId(8, "CannotChangeTransport"), "Cannot change transports mid-connection; currently using {TransportType}, requesting {RequestedTransport}.");
35+
LoggerMessage.Define<HttpTransportType, HttpTransportType>(LogLevel.Debug, new EventId(8, "CannotChangeTransport"), "Cannot change transports mid-connection; currently using {TransportType}, requesting {RequestedTransport}.");
3636

3737
private static readonly Action<ILogger, Exception> _postNotallowedForWebsockets =
3838
LoggerMessage.Define(LogLevel.Debug, new EventId(9, "PostNotAllowedForWebSockets"), "POST requests are not allowed for websocket connections.");

‎src/SignalR/common/Http.Connections/src/Internal/Transports/WebSocketsTransport.Log.cs renamed to ‎src/SignalR/common/Http.Connections/src/Internal/Transports/WebSocketsServerTransport.Log.cs

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,9 @@ private static class Log
4545
LoggerMessage.Define<long>(LogLevel.Trace, new EventId(11, "SendPayload"), "Sending payload: {Size} bytes.");
4646

4747
private static readonly Action<ILogger, Exception> _errorWritingFrame =
48-
LoggerMessage.Define(LogLevel.Error, new EventId(12, "ErrorWritingFrame"), "Error writing frame.");
48+
LoggerMessage.Define(LogLevel.Debug, new EventId(12, "ErrorWritingFrame"), "Error writing frame.");
4949

50-
private static readonly Action<ILogger, Exception> _sendFailed =
51-
LoggerMessage.Define(LogLevel.Error, new EventId(13, "SendFailed"), "Socket failed to send.");
50+
// 13, SendFailed - removed
5251

5352
private static readonly Action<ILogger, Exception> _closedPrematurely =
5453
LoggerMessage.Define(LogLevel.Debug, new EventId(14, "ClosedPrematurely"), "Socket connection closed prematurely.");
@@ -116,11 +115,6 @@ public static void ErrorWritingFrame(ILogger logger, Exception ex)
116115
_errorWritingFrame(logger, ex);
117116
}
118117

119-
public static void SendFailed(ILogger logger, Exception ex)
120-
{
121-
_sendFailed(logger, ex);
122-
}
123-
124118
public static void ClosedPrematurely(ILogger logger, Exception ex)
125119
{
126120
_closedPrematurely(logger, ex);

‎src/SignalR/server/Core/src/HubConnectionContext.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -593,7 +593,7 @@ private static class Log
593593
{
594594
// Category: HubConnectionContext
595595
private static readonly Action<ILogger, string, Exception> _handshakeComplete =
596-
LoggerMessage.Define<string>(LogLevel.Information, new EventId(1, "HandshakeComplete"), "Completed connection handshake. Using HubProtocol '{Protocol}'.");
596+
LoggerMessage.Define<string>(LogLevel.Debug, new EventId(1, "HandshakeComplete"), "Completed connection handshake. Using HubProtocol '{Protocol}'.");
597597

598598
private static readonly Action<ILogger, Exception> _handshakeCanceled =
599599
LoggerMessage.Define(LogLevel.Debug, new EventId(2, "HandshakeCanceled"), "Handshake was canceled.");
@@ -605,13 +605,13 @@ private static class Log
605605
LoggerMessage.Define(LogLevel.Debug, new EventId(4, "TransportBufferFull"), "Unable to send Ping message to client, the transport buffer is full.");
606606

607607
private static readonly Action<ILogger, Exception> _handshakeFailed =
608-
LoggerMessage.Define(LogLevel.Error, new EventId(5, "HandshakeFailed"), "Failed connection handshake.");
608+
LoggerMessage.Define(LogLevel.Debug, new EventId(5, "HandshakeFailed"), "Failed connection handshake.");
609609

610610
private static readonly Action<ILogger, Exception> _failedWritingMessage =
611-
LoggerMessage.Define(LogLevel.Error, new EventId(6, "FailedWritingMessage"), "Failed writing message. Aborting connection.");
611+
LoggerMessage.Define(LogLevel.Debug, new EventId(6, "FailedWritingMessage"), "Failed writing message. Aborting connection.");
612612

613613
private static readonly Action<ILogger, string, int, Exception> _protocolVersionFailed =
614-
LoggerMessage.Define<string, int>(LogLevel.Warning, new EventId(7, "ProtocolVersionFailed"), "Server does not support version {Version} of the {Protocol} protocol.");
614+
LoggerMessage.Define<string, int>(LogLevel.Debug, new EventId(7, "ProtocolVersionFailed"), "Server does not support version {Version} of the {Protocol} protocol.");
615615

616616
private static readonly Action<ILogger, Exception> _abortFailed =
617617
LoggerMessage.Define(LogLevel.Trace, new EventId(8, "AbortFailed"), "Abort callback failed.");

‎src/SignalR/server/Core/src/HubConnectionHandler.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -287,7 +287,7 @@ private static class Log
287287
LoggerMessage.Define<string>(LogLevel.Error, new EventId(1, "ErrorDispatchingHubEvent"), "Error when dispatching '{HubMethod}' on hub.");
288288

289289
private static readonly Action<ILogger, Exception> _errorProcessingRequest =
290-
LoggerMessage.Define(LogLevel.Error, new EventId(2, "ErrorProcessingRequest"), "Error when processing requests.");
290+
LoggerMessage.Define(LogLevel.Debug, new EventId(2, "ErrorProcessingRequest"), "Error when processing requests.");
291291

292292
private static readonly Action<ILogger, Exception> _abortFailed =
293293
LoggerMessage.Define(LogLevel.Trace, new EventId(3, "AbortFailed"), "Abort callback failed.");

0 commit comments

Comments
 (0)