Skip to content

Commit 664d96c

Browse files
BorisDogBorisDog
authored
CSHARP-4348: Improve logging related class and member names (#899)
1 parent c0d3b4c commit 664d96c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+282
-267
lines changed

‎src/MongoDB.Driver.Core/Core/Clusters/Cluster.cs

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,8 @@ internal abstract class Cluster : ICluster
7171
private TaskCompletionSource<bool> _descriptionChangedTaskCompletionSource;
7272
private readonly object _descriptionLock = new object();
7373
private readonly LatencyLimitingServerSelector _latencyLimitingServerSelector;
74-
protected readonly EventsLogger<LogCategories.Cluster> _clusterEventsLogger;
75-
protected readonly EventsLogger<LogCategories.ServerSelection> _serverSelectionEventsLogger;
74+
protected readonly EventLogger<LogCategories.Cluster> _clusterEventLogger;
75+
protected readonly EventLogger<LogCategories.ServerSelection> _serverSelectionEventLogger;
7676
private Timer _rapidHeartbeatTimer;
7777
private readonly object _serverSelectionWaitQueueLock = new object();
7878
private int _serverSelectionWaitQueueSize;
@@ -101,8 +101,8 @@ protected Cluster(ClusterSettings settings, IClusterableServerFactory serverFact
101101

102102
_serverSessionPool = new CoreServerSessionPool(this);
103103

104-
_clusterEventsLogger = loggerFactory.CreateEventsLogger<LogCategories.Cluster>(eventSubscriber);
105-
_serverSelectionEventsLogger = loggerFactory.CreateEventsLogger<LogCategories.ServerSelection>(eventSubscriber);
104+
_clusterEventLogger = loggerFactory.CreateEventLogger<LogCategories.Cluster>(eventSubscriber);
105+
_serverSelectionEventLogger = loggerFactory.CreateEventLogger<LogCategories.ServerSelection>(eventSubscriber);
106106

107107
ClusterDescription CreateInitialDescription()
108108
{
@@ -166,7 +166,7 @@ protected virtual void Dispose(bool disposing)
166166
{
167167
if (_state.TryChange(State.Disposed))
168168
{
169-
_clusterEventsLogger.Logger?.LogDebug(_clusterId, "Disposing");
169+
_clusterEventLogger.Logger?.LogDebug(_clusterId, "Disposing");
170170

171171
#pragma warning disable CS0618 // Type or member is obsolete
172172
var connectionModeSwitch = _description.ConnectionModeSwitch;
@@ -188,7 +188,7 @@ protected virtual void Dispose(bool disposing)
188188
_rapidHeartbeatTimer.Dispose();
189189
_cryptClient?.Dispose();
190190

191-
_clusterEventsLogger.Logger?.LogDebug(_clusterId, "Disposed");
191+
_clusterEventLogger.Logger?.LogDebug(_clusterId, "Disposed");
192192
}
193193
}
194194

@@ -224,14 +224,14 @@ public virtual void Initialize()
224224
ThrowIfDisposed();
225225
if (_state.TryChange(State.Initial, State.Open))
226226
{
227-
_clusterEventsLogger.Logger?.LogDebug(_clusterId, "Initialized");
227+
_clusterEventLogger.Logger?.LogDebug(_clusterId, "Initialized");
228228

229229
if (_settings.CryptClientSettings != null)
230230
{
231231
_cryptClient = CryptClientCreator.CreateCryptClient(_settings.CryptClientSettings);
232232

233-
_clusterEventsLogger.Logger?.LogDebug(
234-
StructuredLogsTemplates.ClusterId_Message_SharedLibraryVersion,
233+
_clusterEventLogger.Logger?.LogDebug(
234+
StructuredLogTemplateProviders.ClusterId_Message_SharedLibraryVersion,
235235
_clusterId,
236236
"CryptClient created. Configured shared library version: ",
237237
_cryptClient.CryptSharedLibraryVersion ?? "None");
@@ -267,7 +267,7 @@ protected void OnDescriptionChanged(ClusterDescription oldDescription, ClusterDe
267267
{
268268
if (shouldClusterDescriptionChangedEventBePublished)
269269
{
270-
_clusterEventsLogger.LogAndPublish(new ClusterDescriptionChangedEvent(oldDescription, newDescription));
270+
_clusterEventLogger.LogAndPublish(new ClusterDescriptionChangedEvent(oldDescription, newDescription));
271271
}
272272

273273
DescriptionChanged?.Invoke(this, new ClusterDescriptionChangedEventArgs(oldDescription, newDescription));
@@ -468,7 +468,7 @@ public void Dispose()
468468

469469
public void HandleException(Exception exception)
470470
{
471-
_cluster._serverSelectionEventsLogger.LogAndPublish(new ClusterSelectingServerFailedEvent(
471+
_cluster._serverSelectionEventLogger.LogAndPublish(new ClusterSelectingServerFailedEvent(
472472
_description,
473473
_selector,
474474
exception,
@@ -486,7 +486,7 @@ public IServer SelectServer()
486486
if (!_serverSelectionWaitQueueEntered)
487487
{
488488
// this is our first time through...
489-
_cluster._serverSelectionEventsLogger.LogAndPublish(new ClusterSelectingServerEvent(
489+
_cluster._serverSelectionEventLogger.LogAndPublish(new ClusterSelectingServerEvent(
490490
_description,
491491
_selector,
492492
EventContext.OperationId));
@@ -526,7 +526,7 @@ public IServer SelectServer()
526526
{
527527
_stopwatch.Stop();
528528

529-
_cluster._serverSelectionEventsLogger.LogAndPublish(new ClusterSelectedServerEvent(
529+
_cluster._serverSelectionEventLogger.LogAndPublish(new ClusterSelectedServerEvent(
530530
_description,
531531
_selector,
532532
selectedServer.Description,

‎src/MongoDB.Driver.Core/Core/Clusters/DnsMonitor.cs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ private static string EnsureLookupDomainNameIsValid(string lookupDomainName)
4747
private DnsMonitorState _state;
4848
private Exception _unhandledException;
4949

50-
private readonly EventsLogger<LogCategories.SDAM> _eventsLogger;
50+
private readonly EventLogger<LogCategories.SDAM> _eventLogger;
5151

5252
// constructors
5353
public DnsMonitor(IDnsMonitoringCluster cluster,
@@ -64,7 +64,7 @@ public DnsMonitor(IDnsMonitoringCluster cluster,
6464
_service = "_mongodb._tcp." + _lookupDomainName;
6565
_state = DnsMonitorState.Created;
6666

67-
_eventsLogger = logger.ToEventsLogger(eventSubscriber);
67+
_eventLogger = logger.ToEventLogger(eventSubscriber);
6868
}
6969

7070
// public properties
@@ -101,7 +101,7 @@ private void ThreadStart()
101101
{
102102
_unhandledException = exception;
103103

104-
_eventsLogger.LogAndPublish(exception, new SdamInformationEvent("Unhandled exception in DnsMonitor: {0}.", exception));
104+
_eventLogger.LogAndPublish(exception, new SdamInformationEvent("Unhandled exception in DnsMonitor: {0}.", exception));
105105

106106
_state = DnsMonitorState.Failed;
107107
return;
@@ -146,7 +146,7 @@ private List<DnsEndPoint> GetValidEndPoints(List<SrvRecord> srvRecords)
146146
}
147147
else
148148
{
149-
_eventsLogger.LogAndPublish(new SdamInformationEvent("Invalid host returned by DNS SRV lookup: {0}.", host));
149+
_eventLogger.LogAndPublish(new SdamInformationEvent("Invalid host returned by DNS SRV lookup: {0}.", host));
150150
}
151151
}
152152

@@ -190,7 +190,7 @@ private void Monitor()
190190
}
191191
else
192192
{
193-
_eventsLogger.LogAndPublish(new SdamInformationEvent("A DNS SRV query on \"{0}\" returned no valid hosts.", _service));
193+
_eventLogger.LogAndPublish(new SdamInformationEvent("A DNS SRV query on \"{0}\" returned no valid hosts.", _service));
194194
}
195195
}
196196

‎src/MongoDB.Driver.Core/Core/Clusters/LoadBalancedCluster.cs

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ internal class LoadBalancedCluster : ICluster, IDnsMonitoringCluster
5151
private readonly ICoreServerSessionPool _serverSessionPool;
5252
private readonly ClusterSettings _settings;
5353
private readonly InterlockedInt32 _state;
54-
private readonly EventsLogger<LogCategories.Cluster> _eventsLogger;
54+
private readonly EventLogger<LogCategories.Cluster> _eventLogger;
5555

5656
public LoadBalancedCluster(
5757
ClusterSettings settings,
@@ -109,7 +109,7 @@ public LoadBalancedCluster(
109109
#pragma warning restore CS0618 // Type or member is obsolete
110110
null);
111111

112-
_eventsLogger = loggerFactory.CreateEventsLogger<LogCategories.Cluster>(eventSubscriber);
112+
_eventLogger = loggerFactory.CreateEventLogger<LogCategories.Cluster>(eventSubscriber);
113113
}
114114

115115
public ClusterId ClusterId => _clusterId;
@@ -143,15 +143,15 @@ private void Dispose(bool disposing)
143143
_dnsMonitorCancellationTokenSource.Cancel();
144144
_dnsMonitorCancellationTokenSource.Dispose();
145145

146-
_eventsLogger.LogAndPublish(new ClusterClosingEvent(ClusterId));
146+
_eventLogger.LogAndPublish(new ClusterClosingEvent(ClusterId));
147147

148148
var stopwatch = Stopwatch.StartNew();
149149
if (_server != null)
150150
{
151151
_server.DescriptionChanged -= ServerDescriptionChangedHandler;
152152
_server.Dispose();
153153
}
154-
_eventsLogger.LogAndPublish(new ClusterClosedEvent(ClusterId, stopwatch.Elapsed));
154+
_eventLogger.LogAndPublish(new ClusterClosedEvent(ClusterId, stopwatch.Elapsed));
155155
}
156156
}
157157
}
@@ -163,7 +163,7 @@ public void Initialize()
163163
if (_state.TryChange(State.Initial, State.Open))
164164
{
165165
var stopwatch = Stopwatch.StartNew();
166-
_eventsLogger.LogAndPublish(new ClusterOpeningEvent(ClusterId, Settings));
166+
_eventLogger.LogAndPublish(new ClusterOpeningEvent(ClusterId, Settings));
167167

168168
if (_settings.CryptClientSettings != null)
169169
{
@@ -185,7 +185,7 @@ public void Initialize()
185185
_dnsMonitorThread = monitor.Start();
186186
}
187187

188-
_eventsLogger.LogAndPublish(new ClusterOpenedEvent(ClusterId, Settings, stopwatch.Elapsed));
188+
_eventLogger.LogAndPublish(new ClusterOpenedEvent(ClusterId, Settings, stopwatch.Elapsed));
189189
}
190190
}
191191

@@ -258,7 +258,7 @@ private void UpdateClusterDescription(ClusterDescription newClusterDescription)
258258

259259
void OnClusterDescriptionChanged(ClusterDescription oldDescription, ClusterDescription newDescription)
260260
{
261-
_eventsLogger.LogAndPublish(new ClusterDescriptionChangedEvent(oldDescription, newDescription));
261+
_eventLogger.LogAndPublish(new ClusterDescriptionChangedEvent(oldDescription, newDescription));
262262

263263
// used only in tests and legacy
264264
var handler = DescriptionChanged;

‎src/MongoDB.Driver.Core/Core/Clusters/MultiServerCluster.cs

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ protected override void Dispose(bool disposing)
8282
{
8383
if (disposing)
8484
{
85-
_clusterEventsLogger.LogAndPublish(new ClusterClosingEvent(ClusterId));
85+
_clusterEventLogger.LogAndPublish(new ClusterClosingEvent(ClusterId));
8686

8787
stopwatch = Stopwatch.StartNew();
8888
_monitorServersCancellationTokenSource.Cancel();
@@ -103,7 +103,7 @@ protected override void Dispose(bool disposing)
103103

104104
if (stopwatch != null)
105105
{
106-
_clusterEventsLogger.LogAndPublish(new ClusterClosedEvent(ClusterId, stopwatch.Elapsed));
106+
_clusterEventLogger.LogAndPublish(new ClusterClosedEvent(ClusterId, stopwatch.Elapsed));
107107
}
108108
}
109109

@@ -112,7 +112,7 @@ public override void Initialize()
112112
base.Initialize();
113113
if (_state.TryChange(State.Initial, State.Open))
114114
{
115-
_clusterEventsLogger.LogAndPublish(new ClusterOpeningEvent(ClusterId, Settings));
115+
_clusterEventLogger.LogAndPublish(new ClusterOpeningEvent(ClusterId, Settings));
116116

117117
var stopwatch = Stopwatch.StartNew();
118118

@@ -145,7 +145,7 @@ public override void Initialize()
145145
server.Initialize();
146146
}
147147

148-
_clusterEventsLogger.LogAndPublish(new ClusterOpenedEvent(ClusterId, Settings, stopwatch.Elapsed));
148+
_clusterEventLogger.LogAndPublish(new ClusterOpenedEvent(ClusterId, Settings, stopwatch.Elapsed));
149149

150150
if (Settings.Scheme == ConnectionStringScheme.MongoDBPlusSrv)
151151
{
@@ -236,7 +236,7 @@ private void ServerDescriptionChangedHandler(object sender, ServerDescriptionCha
236236
catch (Exception unexpectedException)
237237
{
238238
// if we catch an exception here it's because of a bug in the driver
239-
_clusterEventsLogger.LogAndPublish(new SdamInformationEvent(
239+
_clusterEventLogger.LogAndPublish(new SdamInformationEvent(
240240
"Unexpected exception in MultiServerCluster.ServerDescriptionChangedHandler: {0}",
241241
unexpectedException),
242242
unexpectedException);
@@ -362,7 +362,7 @@ private ClusterDescription ProcessReplicaSetChange(ClusterDescription clusterDes
362362
var server = _servers.SingleOrDefault(x => EndPointHelper.Equals(args.NewServerDescription.EndPoint, x.EndPoint));
363363
server.Invalidate("ReportedPrimaryIsStale", args.NewServerDescription.TopologyVersion);
364364

365-
_clusterEventsLogger.LogAndPublish(new SdamInformationEvent(
365+
_clusterEventLogger.LogAndPublish(new SdamInformationEvent(
366366
@"Invalidating server: Setting ServerType to ""Unknown"" for {0} because it " +
367367
@"claimed to be the replica set primary for replica set ""{1}"" but sent a " +
368368
@"(setVersion, electionId) tuple of ({2}, {3}) that was less than than the " +
@@ -384,7 +384,7 @@ private ClusterDescription ProcessReplicaSetChange(ClusterDescription clusterDes
384384
{
385385
if (_maxElectionInfo == null)
386386
{
387-
_clusterEventsLogger.LogAndPublish(new SdamInformationEvent(
387+
_clusterEventLogger.LogAndPublish(new SdamInformationEvent(
388388
@"Initializing (maxSetVersion, maxElectionId): Saving tuple " +
389389
@"(setVersion, electionId) of ({0}, {1}) as (maxSetVersion, maxElectionId) for " +
390390
@"replica set ""{2}"" because replica set primary {3} sent ({0}, {1}), the first " +
@@ -404,7 +404,7 @@ private ClusterDescription ProcessReplicaSetChange(ClusterDescription clusterDes
404404
if (_maxElectionInfo.SetVersion < args.NewServerDescription.ReplicaSetConfig.Version.Value)
405405
{
406406
var electionId = args.NewServerDescription.ElectionId ?? _maxElectionInfo.ElectionId;
407-
_clusterEventsLogger.LogAndPublish(new SdamInformationEvent(
407+
_clusterEventLogger.LogAndPublish(new SdamInformationEvent(
408408
@"Updating stale setVersion: Updating the current " +
409409
@"(maxSetVersion, maxElectionId) tuple from ({0}, {1}) to ({2}, {3}) for " +
410410
@"replica set ""{4}"" because replica set primary {5} sent ({6}, {7})—a larger " +
@@ -424,7 +424,7 @@ private ClusterDescription ProcessReplicaSetChange(ClusterDescription clusterDes
424424
}
425425
else // current primary is stale & setVersion is not stale ⇒ the electionId must be stale
426426
{
427-
_clusterEventsLogger.LogAndPublish(new SdamInformationEvent(
427+
_clusterEventLogger.LogAndPublish(new SdamInformationEvent(
428428
@"Updating stale electionId: Updating the current " +
429429
@"(maxSetVersion, maxElectionId) tuple from ({0}, {1}) to ({2}, {3}) for " +
430430
@"replica set ""{4}"" because replica set primary {5} sent ({6}, {7})—" +
@@ -583,7 +583,7 @@ private ClusterDescription EnsureServer(ClusterDescription clusterDescription, E
583583
return clusterDescription;
584584
}
585585

586-
_clusterEventsLogger.LogAndPublish(new ClusterAddingServerEvent(ClusterId, endPoint));
586+
_clusterEventLogger.LogAndPublish(new ClusterAddingServerEvent(ClusterId, endPoint));
587587

588588
stopwatch.Start();
589589
server = CreateServer(endPoint);
@@ -595,7 +595,7 @@ private ClusterDescription EnsureServer(ClusterDescription clusterDescription, E
595595
clusterDescription = clusterDescription.WithServerDescription(server.Description);
596596
stopwatch.Stop();
597597

598-
_clusterEventsLogger.LogAndPublish(new ClusterAddedServerEvent(server.ServerId, stopwatch.Elapsed));
598+
_clusterEventLogger.LogAndPublish(new ClusterAddedServerEvent(server.ServerId, stopwatch.Elapsed));
599599

600600
return clusterDescription;
601601
}
@@ -636,7 +636,7 @@ private ClusterDescription RemoveServer(ClusterDescription clusterDescription, E
636636
return clusterDescription;
637637
}
638638

639-
_clusterEventsLogger.LogAndPublish(new ClusterRemovingServerEvent(server.ServerId, reason));
639+
_clusterEventLogger.LogAndPublish(new ClusterRemovingServerEvent(server.ServerId, reason));
640640

641641
stopwatch.Start();
642642
_servers.Remove(server);
@@ -646,7 +646,7 @@ private ClusterDescription RemoveServer(ClusterDescription clusterDescription, E
646646
server.Dispose();
647647
stopwatch.Stop();
648648

649-
_clusterEventsLogger.LogAndPublish(new ClusterRemovedServerEvent(server.ServerId, reason, stopwatch.Elapsed));
649+
_clusterEventLogger.LogAndPublish(new ClusterRemovedServerEvent(server.ServerId, reason, stopwatch.Elapsed));
650650

651651
return clusterDescription.WithoutServerDescription(endPoint);
652652
}

0 commit comments

Comments
 (0)