-
Notifications
You must be signed in to change notification settings - Fork 10k
/
KestrelEventSource.cs
429 lines (370 loc) · 16.2 KB
/
KestrelEventSource.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
using System;
using System.Buffers;
using System.Diagnostics.Tracing;
using System.Net.Security;
using System.Runtime.CompilerServices;
using System.Text;
using System.Text.Json;
using Microsoft.AspNetCore.Connections;
using Microsoft.AspNetCore.Server.Kestrel.Core.Internal.Http;
namespace Microsoft.AspNetCore.Server.Kestrel.Core.Internal.Infrastructure
{
[EventSource(Name = "Microsoft-AspNetCore-Server-Kestrel")]
internal sealed class KestrelEventSource : EventSource
{
public static readonly KestrelEventSource Log = new KestrelEventSource();
private IncrementingPollingCounter? _connectionsPerSecondCounter;
private IncrementingPollingCounter? _tlsHandshakesPerSecondCounter;
private PollingCounter? _totalConnectionsCounter;
private PollingCounter? _currentConnectionsCounter;
private PollingCounter? _totalTlsHandshakesCounter;
private PollingCounter? _currentTlsHandshakesCounter;
private PollingCounter? _failedTlsHandshakesCounter;
private PollingCounter? _connectionQueueLengthCounter;
private PollingCounter? _httpRequestQueueLengthCounter;
private PollingCounter? _currrentUpgradedHttpRequestsCounter;
private long _totalConnections;
private long _currentConnections;
private long _connectionQueueLength;
private long _totalTlsHandshakes;
private long _currentTlsHandshakes;
private long _failedTlsHandshakes;
private long _httpRequestQueueLength;
private long _currentUpgradedHttpRequests;
private readonly List<WeakReference<KestrelServerOptions>> _options = new();
private KestrelEventSource()
{
}
// NOTE
// - The 'Start' and 'Stop' suffixes on the following event names have special meaning in EventSource. They
// enable creating 'activities'.
// For more information, take a look at the following blog post:
// https://blogs.msdn.microsoft.com/vancem/2015/09/14/exploring-eventsource-activity-correlation-and-causation-features/
// - A stop event's event id must be next one after its start event.
// - Avoid renaming methods or parameters marked with EventAttribute. EventSource uses these to form the event object.
[NonEvent]
public void ConnectionStart(BaseConnectionContext connection)
{
// avoid allocating strings unless this event source is enabled
Interlocked.Increment(ref _totalConnections);
Interlocked.Increment(ref _currentConnections);
if (IsEnabled(EventLevel.Informational, EventKeywords.None))
{
ConnectionStart(
connection.ConnectionId,
connection.LocalEndPoint?.ToString(),
connection.RemoteEndPoint?.ToString());
}
}
[MethodImpl(MethodImplOptions.NoInlining)]
[Event(1, Level = EventLevel.Informational)]
private void ConnectionStart(string connectionId, string? localEndPoint, string? remoteEndPoint)
{
WriteEvent(1, connectionId, localEndPoint, remoteEndPoint);
}
[NonEvent]
public void ConnectionStop(BaseConnectionContext connection)
{
Interlocked.Decrement(ref _currentConnections);
if (IsEnabled(EventLevel.Informational, EventKeywords.None))
{
ConnectionStop(connection.ConnectionId);
}
}
[MethodImpl(MethodImplOptions.NoInlining)]
[Event(2, Level = EventLevel.Informational)]
private void ConnectionStop(string connectionId)
{
WriteEvent(2, connectionId);
}
[NonEvent]
public void RequestStart(HttpProtocol httpProtocol)
{
if (IsEnabled())
{
Core(httpProtocol);
}
[NonEvent]
void Core(HttpProtocol httpProtocol)
{
// avoid allocating the trace identifier unless logging is enabled
if (IsEnabled(EventLevel.Informational, EventKeywords.None))
{
RequestStart(httpProtocol.ConnectionIdFeature, httpProtocol.TraceIdentifier, httpProtocol.HttpVersion, httpProtocol.Path!, httpProtocol.MethodText);
}
}
}
[Event(3, Level = EventLevel.Informational)]
private void RequestStart(string connectionId, string requestId, string httpVersion, string path, string method)
{
WriteEvent(3, connectionId, requestId, httpVersion, path, method);
}
[NonEvent]
public void RequestStop(HttpProtocol httpProtocol)
{
if (IsEnabled())
{
Core(httpProtocol);
}
[NonEvent]
void Core(HttpProtocol httpProtocol)
{
// avoid allocating the trace identifier unless logging is enabled
if (IsEnabled(EventLevel.Informational, EventKeywords.None))
{
RequestStop(httpProtocol.ConnectionIdFeature, httpProtocol.TraceIdentifier, httpProtocol.HttpVersion, httpProtocol.Path!, httpProtocol.MethodText);
}
}
}
[Event(4, Level = EventLevel.Informational)]
private void RequestStop(string connectionId, string requestId, string httpVersion, string path, string method)
{
WriteEvent(4, connectionId, requestId, httpVersion, path, method);
}
[MethodImpl(MethodImplOptions.NoInlining)]
[Event(5, Level = EventLevel.Informational)]
public void ConnectionRejected(string connectionId)
{
if (IsEnabled(EventLevel.Informational, EventKeywords.None))
{
WriteEvent(5, connectionId);
}
}
[NonEvent]
public void ConnectionQueuedStart(BaseConnectionContext connection)
{
Interlocked.Increment(ref _connectionQueueLength);
}
[NonEvent]
public void ConnectionQueuedStop(BaseConnectionContext connection)
{
Interlocked.Decrement(ref _connectionQueueLength);
}
[NonEvent]
public void TlsHandshakeStart(BaseConnectionContext connectionContext, SslServerAuthenticationOptions sslOptions)
{
Interlocked.Increment(ref _currentTlsHandshakes);
Interlocked.Increment(ref _totalTlsHandshakes);
if (IsEnabled(EventLevel.Informational, EventKeywords.None))
{
TlsHandshakeStart(connectionContext.ConnectionId, sslOptions.EnabledSslProtocols.ToString());
}
}
[MethodImpl(MethodImplOptions.NoInlining)]
[Event(8, Level = EventLevel.Informational)]
private void TlsHandshakeStart(string connectionId, string sslProtocols)
{
WriteEvent(8, connectionId, sslProtocols);
}
[NonEvent]
public void TlsHandshakeStop(BaseConnectionContext connectionContext, TlsConnectionFeature? feature)
{
Interlocked.Decrement(ref _currentTlsHandshakes);
if (IsEnabled(EventLevel.Informational, EventKeywords.None))
{
// TODO: Write this without a string allocation using WriteEventData
var applicationProtocol = feature == null ? string.Empty : Encoding.UTF8.GetString(feature.ApplicationProtocol.Span);
var sslProtocols = feature?.Protocol.ToString() ?? string.Empty;
var hostName = feature?.HostName ?? string.Empty;
TlsHandshakeStop(connectionContext.ConnectionId, sslProtocols, applicationProtocol, hostName);
}
}
[MethodImpl(MethodImplOptions.NoInlining)]
[Event(9, Level = EventLevel.Informational)]
private void TlsHandshakeStop(string connectionId, string sslProtocols, string applicationProtocol, string hostName)
{
WriteEvent(9, connectionId, sslProtocols, applicationProtocol, hostName);
}
[MethodImpl(MethodImplOptions.NoInlining)]
[Event(10, Level = EventLevel.Error)]
public void TlsHandshakeFailed(string connectionId)
{
Interlocked.Increment(ref _failedTlsHandshakes);
if (IsEnabled(EventLevel.Error, EventKeywords.None))
{
WriteEvent(10, connectionId);
}
}
[MethodImpl(MethodImplOptions.NoInlining)]
[Event(11, Level = EventLevel.LogAlways)]
public void Configuration(int instanceId, string configuration)
{
// If the event source is already enabled, dump configuration
WriteEvent(11, instanceId, configuration);
}
[NonEvent]
public void Configuration(KestrelServerOptions options)
{
// If the event source is already enabled, dump configuration
if (IsEnabled())
{
var bufferWriter = new ArrayBufferWriter<byte>();
var writer = new Utf8JsonWriter(bufferWriter);
writer.WriteStartObject();
options.Serialize(writer);
writer.WriteEndObject();
writer.Flush();
var serializedConfig = Encoding.UTF8.GetString(bufferWriter.WrittenSpan);
Configuration(options.GetHashCode(), serializedConfig);
}
}
[NonEvent]
public void AddServerOptions(KestrelServerOptions options)
{
lock (_options)
{
_options.Add(new(options));
}
Configuration(options);
}
[NonEvent]
public void RemoveServerOptions(KestrelServerOptions options)
{
lock (_options)
{
for (var i = _options.Count - 1; i >= 0; i--)
{
var weakReference = _options[i];
if (!weakReference.TryGetTarget(out var target) || ReferenceEquals(target, options))
{
_options.RemoveAt(i);
}
}
}
}
[NonEvent]
public void RequestQueuedStart(HttpProtocol httpProtocol, string httpVersion)
{
Interlocked.Increment(ref _httpRequestQueueLength);
}
[NonEvent]
public void RequestQueuedStop(HttpProtocol httpProtocol, string httpVersion)
{
Interlocked.Decrement(ref _httpRequestQueueLength);
}
[NonEvent]
public void RequestUpgradedStart(HttpProtocol httpProtocol)
{
Interlocked.Increment(ref _currentUpgradedHttpRequests);
}
[NonEvent]
public void RequestUpgradedStop(HttpProtocol httpProtocol)
{
Interlocked.Decrement(ref _currentUpgradedHttpRequests);
}
protected override void OnEventCommand(EventCommandEventArgs command)
{
if (command.Command == EventCommand.Enable)
{
// This is the convention for initializing counters in the RuntimeEventSource (lazily on the first enable command).
// They aren't disabled afterwards...
_connectionsPerSecondCounter ??= new IncrementingPollingCounter("connections-per-second", this, () => Volatile.Read(ref _totalConnections))
{
DisplayName = "Connection Rate",
DisplayRateTimeScale = TimeSpan.FromSeconds(1)
};
_totalConnectionsCounter ??= new PollingCounter("total-connections", this, () => Volatile.Read(ref _totalConnections))
{
DisplayName = "Total Connections",
};
_tlsHandshakesPerSecondCounter ??= new IncrementingPollingCounter("tls-handshakes-per-second", this, () => Volatile.Read(ref _totalTlsHandshakes))
{
DisplayName = "TLS Handshake Rate",
DisplayRateTimeScale = TimeSpan.FromSeconds(1)
};
_totalTlsHandshakesCounter ??= new PollingCounter("total-tls-handshakes", this, () => Volatile.Read(ref _totalTlsHandshakes))
{
DisplayName = "Total TLS Handshakes",
};
_currentTlsHandshakesCounter ??= new PollingCounter("current-tls-handshakes", this, () => Volatile.Read(ref _currentTlsHandshakes))
{
DisplayName = "Current TLS Handshakes"
};
_failedTlsHandshakesCounter ??= new PollingCounter("failed-tls-handshakes", this, () => Volatile.Read(ref _failedTlsHandshakes))
{
DisplayName = "Failed TLS Handshakes"
};
_currentConnectionsCounter ??= new PollingCounter("current-connections", this, () => Volatile.Read(ref _currentConnections))
{
DisplayName = "Current Connections"
};
_connectionQueueLengthCounter ??= new PollingCounter("connection-queue-length", this, () => Volatile.Read(ref _connectionQueueLength))
{
DisplayName = "Connection Queue Length"
};
_httpRequestQueueLengthCounter ??= new PollingCounter("request-queue-length", this, () => Volatile.Read(ref _httpRequestQueueLength))
{
DisplayName = "Request Queue Length"
};
_currrentUpgradedHttpRequestsCounter ??= new PollingCounter("current-upgraded-requests", this, () => Volatile.Read(ref _currentUpgradedHttpRequests))
{
DisplayName = "Current Upgraded Requests (WebSockets)"
};
// Log the options here
lock (_options)
{
for (var i = _options.Count - 1; i >= 0; i--)
{
var weakReference = _options[i];
if (!weakReference.TryGetTarget(out var target))
{
// Remove any options that have been collected
_options.RemoveAt(i);
}
else
{
Configuration(target);
}
}
}
}
}
[NonEvent]
[SkipLocalsInit]
private unsafe void WriteEvent(int eventId, string? arg1, string? arg2, string? arg3, string? arg4, string? arg5)
{
const int EventDataCount = 5;
arg1 ??= string.Empty;
arg2 ??= string.Empty;
arg3 ??= string.Empty;
arg4 ??= string.Empty;
arg5 ??= string.Empty;
fixed (char* arg1Ptr = arg1)
fixed (char* arg2Ptr = arg2)
fixed (char* arg3Ptr = arg3)
fixed (char* arg4Ptr = arg4)
fixed (char* arg5Ptr = arg5)
{
EventData* data = stackalloc EventData[EventDataCount];
data[0] = new EventData
{
DataPointer = (IntPtr)arg1Ptr,
Size = (arg1.Length + 1) * sizeof(char)
};
data[1] = new EventData
{
DataPointer = (IntPtr)arg2Ptr,
Size = (arg2.Length + 1) * sizeof(char)
};
data[2] = new EventData
{
DataPointer = (IntPtr)arg3Ptr,
Size = (arg3.Length + 1) * sizeof(char)
};
data[3] = new EventData
{
DataPointer = (IntPtr)arg4Ptr,
Size = (arg4.Length + 1) * sizeof(char)
};
data[4] = new EventData
{
DataPointer = (IntPtr)arg5Ptr,
Size = (arg5.Length + 1) * sizeof(char)
};
WriteEventCore(eventId, EventDataCount, data);
}
}
}
}