-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
EnterpriseReadReplicaEditionModule.java
402 lines (336 loc) · 20.1 KB
/
EnterpriseReadReplicaEditionModule.java
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
/*
* Copyright (c) 2002-2018 "Neo Technology,"
* Network Engine for Objects in Lund AB [http://neotechnology.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.neo4j.causalclustering.readreplica;
import java.io.File;
import java.io.IOException;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.NoSuchElementException;
import java.util.concurrent.TimeUnit;
import java.util.function.Predicate;
import java.util.function.Supplier;
import org.neo4j.causalclustering.catchup.CatchUpClient;
import org.neo4j.causalclustering.catchup.CatchupServer;
import org.neo4j.causalclustering.catchup.CheckpointerSupplier;
import org.neo4j.causalclustering.catchup.storecopy.CopiedStoreRecovery;
import org.neo4j.causalclustering.catchup.storecopy.LocalDatabase;
import org.neo4j.causalclustering.catchup.storecopy.RemoteStore;
import org.neo4j.causalclustering.catchup.storecopy.StoreCopyClient;
import org.neo4j.causalclustering.catchup.storecopy.StoreCopyProcess;
import org.neo4j.causalclustering.catchup.storecopy.StoreFiles;
import org.neo4j.causalclustering.catchup.tx.BatchingTxApplier;
import org.neo4j.causalclustering.catchup.tx.CatchupPollingProcess;
import org.neo4j.causalclustering.catchup.tx.TransactionLogCatchUpFactory;
import org.neo4j.causalclustering.catchup.tx.TxPullClient;
import org.neo4j.causalclustering.core.CausalClusteringSettings;
import org.neo4j.causalclustering.core.consensus.schedule.TimerService;
import org.neo4j.causalclustering.discovery.DiscoveryServiceFactory;
import org.neo4j.causalclustering.discovery.HostnameResolver;
import org.neo4j.causalclustering.discovery.TopologyService;
import org.neo4j.causalclustering.discovery.TopologyServiceMultiRetryStrategy;
import org.neo4j.causalclustering.discovery.TopologyServiceRetryStrategy;
import org.neo4j.causalclustering.discovery.procedures.ReadReplicaRoleProcedure;
import org.neo4j.causalclustering.handlers.DuplexPipelineWrapperFactory;
import org.neo4j.causalclustering.handlers.PipelineWrapper;
import org.neo4j.causalclustering.handlers.VoidPipelineWrapperFactory;
import org.neo4j.causalclustering.helper.ExponentialBackoffStrategy;
import org.neo4j.causalclustering.identity.MemberId;
import org.neo4j.com.storecopy.StoreUtil;
import org.neo4j.function.Predicates;
import org.neo4j.graphdb.DependencyResolver;
import org.neo4j.graphdb.factory.GraphDatabaseSettings;
import org.neo4j.internal.kernel.api.exceptions.KernelException;
import org.neo4j.io.fs.FileSystemAbstraction;
import org.neo4j.io.pagecache.PageCache;
import org.neo4j.kernel.DatabaseAvailability;
import org.neo4j.kernel.api.bolt.BoltConnectionTracker;
import org.neo4j.kernel.configuration.Config;
import org.neo4j.kernel.configuration.Settings;
import org.neo4j.kernel.configuration.ssl.SslPolicyLoader;
import org.neo4j.kernel.enterprise.builtinprocs.EnterpriseBuiltInDbmsProcedures;
import org.neo4j.kernel.impl.api.CommitProcessFactory;
import org.neo4j.kernel.impl.api.ReadOnlyTransactionCommitProcess;
import org.neo4j.kernel.impl.api.TransactionCommitProcess;
import org.neo4j.kernel.impl.api.TransactionRepresentationCommitProcess;
import org.neo4j.kernel.impl.core.DelegatingLabelTokenHolder;
import org.neo4j.kernel.impl.core.DelegatingPropertyKeyTokenHolder;
import org.neo4j.kernel.impl.core.DelegatingRelationshipTypeTokenHolder;
import org.neo4j.kernel.impl.core.ReadOnlyTokenCreator;
import org.neo4j.kernel.impl.coreapi.CoreAPIAvailabilityGuard;
import org.neo4j.kernel.impl.enterprise.EnterpriseConstraintSemantics;
import org.neo4j.kernel.impl.enterprise.EnterpriseEditionModule;
import org.neo4j.kernel.impl.enterprise.StandardBoltConnectionTracker;
import org.neo4j.kernel.impl.enterprise.configuration.OnlineBackupSettings;
import org.neo4j.kernel.impl.enterprise.id.EnterpriseIdTypeConfigurationProvider;
import org.neo4j.kernel.impl.enterprise.transaction.log.checkpoint.ConfigurableIOLimiter;
import org.neo4j.kernel.impl.factory.DatabaseInfo;
import org.neo4j.kernel.impl.factory.EditionModule;
import org.neo4j.kernel.impl.factory.GraphDatabaseFacade;
import org.neo4j.kernel.impl.factory.PlatformModule;
import org.neo4j.kernel.impl.factory.ReadOnly;
import org.neo4j.kernel.impl.factory.StatementLocksFactorySelector;
import org.neo4j.kernel.impl.index.IndexConfigStore;
import org.neo4j.kernel.impl.logging.LogService;
import org.neo4j.kernel.impl.pagecache.PageCacheWarmer;
import org.neo4j.kernel.impl.proc.Procedures;
import org.neo4j.kernel.impl.store.id.DefaultIdGeneratorFactory;
import org.neo4j.kernel.impl.store.id.IdReuseEligibility;
import org.neo4j.kernel.impl.store.stats.IdBasedStoreEntityCounters;
import org.neo4j.kernel.impl.transaction.TransactionHeaderInformationFactory;
import org.neo4j.kernel.impl.transaction.log.LogicalTransactionStore;
import org.neo4j.kernel.impl.transaction.log.TransactionAppender;
import org.neo4j.kernel.impl.transaction.log.TransactionIdStore;
import org.neo4j.kernel.impl.transaction.log.files.LogFiles;
import org.neo4j.kernel.impl.transaction.log.files.LogFilesBuilder;
import org.neo4j.kernel.impl.transaction.log.files.TransactionLogFiles;
import org.neo4j.kernel.impl.util.Dependencies;
import org.neo4j.kernel.internal.DatabaseHealth;
import org.neo4j.kernel.internal.DefaultKernelData;
import org.neo4j.kernel.lifecycle.LifeSupport;
import org.neo4j.kernel.lifecycle.LifecycleStatus;
import org.neo4j.kernel.monitoring.Monitors;
import org.neo4j.logging.LogProvider;
import org.neo4j.logging.NullLogProvider;
import org.neo4j.storageengine.api.StorageEngine;
import org.neo4j.time.Clocks;
import org.neo4j.udc.UsageData;
import static org.neo4j.causalclustering.discovery.ResolutionResolverFactory.chooseResolver;
/**
* This implementation of {@link org.neo4j.kernel.impl.factory.EditionModule} creates the implementations of services
* that are specific to the Enterprise Read Replica edition.
*/
public class EnterpriseReadReplicaEditionModule extends EditionModule
{
public EnterpriseReadReplicaEditionModule( final PlatformModule platformModule,
final DiscoveryServiceFactory discoveryServiceFactory, MemberId myself )
{
LogService logging = platformModule.logging;
ioLimiter = new ConfigurableIOLimiter( platformModule.config );
org.neo4j.kernel.impl.util.Dependencies dependencies = platformModule.dependencies;
Config config = platformModule.config;
config.augment( backupDisabledSettings() );
FileSystemAbstraction fileSystem = platformModule.fileSystem;
PageCache pageCache = platformModule.pageCache;
File storeDir = platformModule.storeDir;
LifeSupport life = platformModule.life;
Monitors monitors = platformModule.monitors;
eligibleForIdReuse = IdReuseEligibility.ALWAYS;
this.accessCapability = new ReadOnly();
watcherService = createFileSystemWatcherService( fileSystem, storeDir, logging, platformModule.jobScheduler, fileWatcherFileNameFilter() );
dependencies.satisfyDependencies( watcherService );
GraphDatabaseFacade graphDatabaseFacade = platformModule.graphDatabaseFacade;
lockManager = dependencies.satisfyDependency( new ReadReplicaLockManager() );
statementLocksFactory = new StatementLocksFactorySelector( lockManager, config, logging ).select();
idTypeConfigurationProvider = new EnterpriseIdTypeConfigurationProvider( config );
idGeneratorFactory = dependencies.satisfyDependency( new DefaultIdGeneratorFactory( fileSystem, idTypeConfigurationProvider ) );
idController = createDefaultIdController();
dependencies.satisfyDependency( idGeneratorFactory );
dependencies.satisfyDependency( idController );
dependencies.satisfyDependency( new IdBasedStoreEntityCounters( this.idGeneratorFactory ) );
propertyKeyTokenHolder = life.add( dependencies.satisfyDependency( new DelegatingPropertyKeyTokenHolder( new ReadOnlyTokenCreator() ) ) );
labelTokenHolder = life.add( dependencies.satisfyDependency( new DelegatingLabelTokenHolder( new ReadOnlyTokenCreator() ) ) );
relationshipTypeTokenHolder = life.add( dependencies.satisfyDependency( new DelegatingRelationshipTypeTokenHolder( new ReadOnlyTokenCreator() ) ) );
life.add( dependencies.satisfyDependency( new DefaultKernelData( fileSystem, pageCache, storeDir, config, graphDatabaseFacade ) ) );
headerInformationFactory = TransactionHeaderInformationFactory.DEFAULT;
schemaWriteGuard = () ->
{
};
transactionStartTimeout = config.get( GraphDatabaseSettings.transaction_start_timeout ).toMillis();
constraintSemantics = new EnterpriseConstraintSemantics();
coreAPIAvailabilityGuard = new CoreAPIAvailabilityGuard( platformModule.availabilityGuard, transactionStartTimeout );
registerRecovery( platformModule.databaseInfo, life, dependencies );
publishEditionInfo( dependencies.resolveDependency( UsageData.class ), platformModule.databaseInfo, config );
commitProcessFactory = readOnly();
LogProvider logProvider = platformModule.logging.getInternalLogProvider();
LogProvider userLogProvider = platformModule.logging.getUserLogProvider();
logProvider.getLog( getClass() ).info( String.format( "Generated new id: %s", myself ) );
HostnameResolver hostnameResolver = chooseResolver( config, logProvider, userLogProvider );
configureDiscoveryService( discoveryServiceFactory, dependencies, config, logProvider );
TopologyService topologyService =
discoveryServiceFactory.topologyService( config, logProvider, platformModule.jobScheduler, myself,
hostnameResolver, resolveStrategy( config, logProvider ) );
life.add( dependencies.satisfyDependency( topologyService ) );
// We need to satisfy the dependency here to keep users of it, such as BoltKernelExtension, happy.
dependencies.satisfyDependency( SslPolicyLoader.create( config, logProvider ) );
DuplexPipelineWrapperFactory pipelineWrapperFactory = pipelineWrapperFactory();
PipelineWrapper serverPipelineWrapper = pipelineWrapperFactory.forServer( config, dependencies, logProvider );
PipelineWrapper clientPipelineWrapper = pipelineWrapperFactory.forClient( config, dependencies, logProvider );
long inactivityTimeoutMillis = config.get( CausalClusteringSettings.catch_up_client_inactivity_timeout ).toMillis();
CatchUpClient catchUpClient =
life.add( new CatchUpClient( logProvider, Clocks.systemClock(), inactivityTimeoutMillis, monitors, clientPipelineWrapper ) );
final Supplier<DatabaseHealth> databaseHealthSupplier = dependencies.provideDependency( DatabaseHealth.class );
Supplier<TransactionCommitProcess> writableCommitProcess =
() -> new TransactionRepresentationCommitProcess( dependencies.resolveDependency( TransactionAppender.class ),
dependencies.resolveDependency( StorageEngine.class ) );
LifeSupport txPulling = new LifeSupport();
int maxBatchSize = config.get( CausalClusteringSettings.read_replica_transaction_applier_batch_size );
BatchingTxApplier batchingTxApplier = new BatchingTxApplier(
maxBatchSize, dependencies.provideDependency( TransactionIdStore.class ), writableCommitProcess,
platformModule.monitors, platformModule.tracers.pageCursorTracerSupplier,
platformModule.versionContextSupplier, logProvider );
TimerService timerService = new TimerService( platformModule.jobScheduler, logProvider );
StoreFiles storeFiles = new StoreFiles( fileSystem, pageCache );
LogFiles logFiles = buildLocalDatabaseLogFiles( platformModule, fileSystem, storeDir, config );
LocalDatabase localDatabase =
new LocalDatabase( platformModule.storeDir, storeFiles, logFiles, platformModule.dataSourceManager,
databaseHealthSupplier,
watcherService, platformModule.availabilityGuard, logProvider );
RemoteStore remoteStore = new RemoteStore( platformModule.logging.getInternalLogProvider(), fileSystem, platformModule.pageCache,
new StoreCopyClient( catchUpClient, logProvider ),
new TxPullClient( catchUpClient, platformModule.monitors ),
new TransactionLogCatchUpFactory(), config, platformModule.monitors );
CopiedStoreRecovery copiedStoreRecovery = new CopiedStoreRecovery( config, platformModule.kernelExtensions.listFactories(), platformModule.pageCache );
txPulling.add( copiedStoreRecovery );
LifeSupport servicesToStopOnStoreCopy = new LifeSupport();
StoreCopyProcess storeCopyProcess = new StoreCopyProcess( fileSystem, pageCache, localDatabase,
copiedStoreRecovery, remoteStore, logProvider );
ConnectToRandomCoreServerStrategy defaultStrategy = new ConnectToRandomCoreServerStrategy();
defaultStrategy.inject( topologyService, config, logProvider, myself );
UpstreamDatabaseStrategiesLoader loader;
if ( config.get( CausalClusteringSettings.multi_dc_license ) )
{
loader = new UpstreamDatabaseStrategiesLoader( topologyService, config, myself, logProvider );
logProvider.getLog( getClass() ).info( "Multi-Data Center option enabled." );
}
else
{
loader = new NoOpUpstreamDatabaseStrategiesLoader();
}
UpstreamDatabaseStrategySelector upstreamDatabaseStrategySelector =
new UpstreamDatabaseStrategySelector( defaultStrategy, loader, myself, logProvider );
CatchupPollingProcess catchupProcess =
new CatchupPollingProcess( logProvider, localDatabase, servicesToStopOnStoreCopy, catchUpClient, upstreamDatabaseStrategySelector,
timerService, config.get( CausalClusteringSettings.pull_interval ).toMillis(), batchingTxApplier, platformModule.monitors,
storeCopyProcess, databaseHealthSupplier, topologyService );
dependencies.satisfyDependencies( catchupProcess );
txPulling.add( batchingTxApplier );
txPulling.add( catchupProcess );
txPulling.add( new WaitForUpToDateStore( catchupProcess, logProvider ) );
ExponentialBackoffStrategy retryStrategy = new ExponentialBackoffStrategy( 1, 30, TimeUnit.SECONDS );
life.add( new ReadReplicaStartupProcess( remoteStore, localDatabase, txPulling, upstreamDatabaseStrategySelector, retryStrategy, logProvider,
platformModule.logging.getUserLogProvider(), storeCopyProcess, topologyService ) );
CatchupServer catchupServer =
new CatchupServer( platformModule.logging.getInternalLogProvider(), platformModule.logging.getUserLogProvider(), localDatabase::storeId,
platformModule.dependencies.provideDependency( TransactionIdStore.class ),
platformModule.dependencies.provideDependency( LogicalTransactionStore.class ), localDatabase::dataSource, localDatabase::isAvailable,
null, config, platformModule.monitors, new CheckpointerSupplier( platformModule.dependencies ), fileSystem, pageCache,
platformModule.storeCopyCheckPointMutex, serverPipelineWrapper );
servicesToStopOnStoreCopy.add( catchupServer );
dependencies.satisfyDependency( createSessionTracker() );
life.add( catchupServer ); // must start last and stop first, since it handles external requests
}
protected void configureDiscoveryService( DiscoveryServiceFactory discoveryServiceFactory, Dependencies dependencies,
Config config, LogProvider logProvider )
{
}
protected DuplexPipelineWrapperFactory pipelineWrapperFactory()
{
return new VoidPipelineWrapperFactory();
}
static Predicate<String> fileWatcherFileNameFilter()
{
return Predicates.any( fileName -> fileName.startsWith( TransactionLogFiles.DEFAULT_NAME ),
fileName -> fileName.startsWith( IndexConfigStore.INDEX_DB_FILE_NAME ),
filename -> filename.startsWith( StoreUtil.BRANCH_SUBDIRECTORY ),
filename -> filename.startsWith( StoreUtil.TEMP_COPY_DIRECTORY_NAME ),
filename -> filename.endsWith( PageCacheWarmer.SUFFIX_CACHEPROF ) );
}
@Override
public void registerEditionSpecificProcedures( Procedures procedures ) throws KernelException
{
procedures.registerProcedure( EnterpriseBuiltInDbmsProcedures.class, true );
procedures.register( new ReadReplicaRoleProcedure() );
}
private void registerRecovery( final DatabaseInfo databaseInfo, LifeSupport life, final DependencyResolver dependencyResolver )
{
life.addLifecycleListener( ( instance, from, to ) ->
{
if ( instance instanceof DatabaseAvailability && to.equals( LifecycleStatus.STARTED ) )
{
doAfterRecoveryAndStartup( databaseInfo, dependencyResolver );
}
} );
}
private CommitProcessFactory readOnly()
{
return ( appender, storageEngine, config ) -> new ReadOnlyTransactionCommitProcess();
}
@Override
protected BoltConnectionTracker createSessionTracker()
{
return new StandardBoltConnectionTracker();
}
@Override
public void setupSecurityModule( PlatformModule platformModule, Procedures procedures )
{
EnterpriseEditionModule.setupEnterpriseSecurityModule( platformModule, procedures );
}
private class NoOpUpstreamDatabaseStrategiesLoader extends UpstreamDatabaseStrategiesLoader
{
NoOpUpstreamDatabaseStrategiesLoader()
{
super( null, null, null, NullLogProvider.getInstance() );
}
@Override
public Iterator<UpstreamDatabaseSelectionStrategy> iterator()
{
return new Iterator<UpstreamDatabaseSelectionStrategy>()
{
@Override
public boolean hasNext()
{
return false;
}
@Override
public UpstreamDatabaseSelectionStrategy next()
{
throw new NoSuchElementException();
}
};
}
}
private static TopologyServiceRetryStrategy resolveStrategy( Config config, LogProvider logProvider )
{
long refreshPeriodMillis = config.get( CausalClusteringSettings.cluster_topology_refresh ).toMillis();
int pollingFrequencyWithinRefreshWindow = 2;
int numberOfRetries =
pollingFrequencyWithinRefreshWindow + 1; // we want to have more retries at the given frequency than there is time in a refresh period
return new TopologyServiceMultiRetryStrategy( refreshPeriodMillis / pollingFrequencyWithinRefreshWindow, numberOfRetries, logProvider );
}
private static Map<String,String> backupDisabledSettings()
{
Map<String,String> overrideBackupSettings = new HashMap<>( );
overrideBackupSettings.put( OnlineBackupSettings.online_backup_enabled.name(), Settings.FALSE );
return overrideBackupSettings;
}
private LogFiles buildLocalDatabaseLogFiles( PlatformModule platformModule, FileSystemAbstraction fileSystem,
File storeDir, Config config )
{
try
{
return LogFilesBuilder.activeFilesBuilder( storeDir, fileSystem, platformModule.pageCache ).withConfig( config ).build();
}
catch ( IOException e )
{
throw new RuntimeException( e );
}
}
}