org.rutebanken.hazelcasthelper.service.HazelCastService Maven / Gradle / Ivy
/*
* Licensed under the EUPL, Version 1.2 or – as soon they will be approved by
* the European Commission - subsequent versions of the EUPL (the "Licence");
* You may not use this work except in compliance with the Licence.
* You may obtain a copy of the Licence at:
*
* https://joinup.ec.europa.eu/software/page/eupl
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the Licence is distributed on an "AS IS" basis,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the Licence for the specific language governing permissions and
* limitations under the Licence.
*
*/
package org.rutebanken.hazelcasthelper.service;
import com.hazelcast.config.*;
import com.hazelcast.core.Hazelcast;
import com.hazelcast.core.HazelcastInstance;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Service;
import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
@Service
public class HazelCastService {
private static final Logger log = LoggerFactory.getLogger(HazelCastService.class);
protected HazelcastInstance hazelcast;
private boolean startupOk = false;
private KubernetesService kubernetesService;
private final String managementUrl;
@Value("${entur.hazelcast.backup.count.sync:2}")
private int backupCount;
@Value("${entur.hazelcast.backup.count.async:0}")
private int backupCountAsync;
@Value("${entur.hazelcast.shutdownhook.enabled:true}")
private boolean shutDownHookEnabled;
/**
* Create a networked hazelcast instance, or
* @param kubernetesService A networked hazelcast instance is only set up if
* kubernetesService is not null
*/
public HazelCastService(KubernetesService kubernetesService) {
this(kubernetesService, null);
}
public HazelCastService(KubernetesService kubernetesService, String managementUrl) {
this.kubernetesService = kubernetesService;
this.managementUrl = managementUrl;
}
@PostConstruct
public final void init() {
if ( kubernetesService != null && kubernetesService.isKubernetesEnabled()) {
log.info("Configuring hazelcast");
try {
String name = kubernetesService.findDeploymentName();
// Consider: The password part could be a kubernetes secret
hazelcast = runHazelcast( kubernetesService.findEndpoints(), name, name+"_pw" );
startupOk = true;
} catch ( Exception e ) {
throw new RutebankenHazelcastException("Could not run initialization of hazelcast.",e);
}
} else {
log.warn("Using local hazelcast as we do not have kubernetes");
hazelcast = initForLocalHazelCast();
}
Runtime.getRuntime().addShutdownHook(new Thread(() -> hazelcast.shutdown()));
}
@PreDestroy
public final void shutdown() {
log.info("Shutdown initiated");
hazelcast.shutdown();
log.info("Shutdown finished");
}
/**
* Method to be used as part of liveness test for a k8s service
* @return true if started up ok and has cluster members
*/
public Boolean getStartupOk() {
return startupOk && numberOfClusterMembers() > 0;
}
/**
* @return Just debug information - format may change over time
*/
public String information() {
if ( hazelcast == null ) {
return "Hazelcast is null, i.e. not configured.";
}
StringBuilder sb = new StringBuilder("cluster members \n");
hazelcast.getCluster()
.getMembers()
.forEach( m -> sb.append(" - localMember: ")
.append(m.localMember())
.append(" Address: ")
.append(m.getAddress())
.append(" Attributes: ")
.append(m.getAttributes())
.append("\n"));
return sb.toString();
}
public int numberOfClusterMembers() {
return hazelcast == null
? 0
: hazelcast.getCluster().getMembers().size();
}
/**
* Override this method if you want to provide additional configuration to the map config with name "default".
* The map config will be updated with some configuration for backup, after the execution of this very method.
*
* See the example below for overriding:
*
*
* public void updateDefaultMapConfig(MapConfig mapConfig) {
* mapConfig
* .setEvictionPolicy(EvictionPolicy.LRU)
* .setTimeToLiveSeconds(604800)
* .setMaxSizeConfig(
* new MaxSizeConfig(70, MaxSizeConfig.MaxSizePolicy.USED_HEAP_PERCENTAGE));
* logger.info("Map config: {}", mapConfig);
* }
*
*
* @param defaultMapConfig The map config with name "default" to make updates on.
*/
public void updateDefaultMapConfig(MapConfig defaultMapConfig) {
// Should be overridden when needed
}
/**
* If you want to provide additional map configurations to hazelcast, you can override this method.
* This list will be added to the Hazelcast configuration. See {@link com.hazelcast.config.Config#addMapConfig(MapConfig)}
*
* Refer to the Hazelcast documentation for configuring maps programmatically.
* Configuring Programmatically
*
* See code example in Tiamat: ExtendedHazelcastService
*
* See the below example below for how to configure one or more maps by overriding this method.
*
* {@code
* @Override
* public List getAdditionalMapConfigurations() {
* return Arrays.asList(
* new MapConfig()
* .setName("myVeryImportantMap")
* .setBackupCount(2)
* .setTimeToLiveSeconds(300));
* }
* }
*
*
* @return a list with desired map configurations
*/
public List getAdditionalMapConfigurations() {
return new ArrayList<>();
}
/**
* If you want to provide a custom serializer, you can override this method.
* This list will be added to the Hazelcast configuration. See {@link com.hazelcast.config.SerializationConfig#addSerializerConfig(SerializerConfig)}
*
* See code example in Anshar: ExtendedHazelcastService
*
* See the below example below for how to configure one or more maps by overriding this method.
*
* {@code
* @Override
* public List getSerializerConfigs() {
* return Arrays.asList(
* new SerializerConfig()
* .setTypeClass(SpecialClass.class)
* .setImplementation(new AwesomeSerializer()));
*
* }
* }
*
*
* @return a list with serializers
*/
public List getSerializerConfigs() {
return new ArrayList<>();
}
private HazelcastInstance runHazelcast(final List nodes, String groupName, String password) {
final int HC_PORT = 5701;
if ( nodes.isEmpty() ) {
log.warn("No nodes given - will start lonely HZ");
}
// configure Hazelcast instance
final Config cfg = new Config()
.setInstanceName(UUID.randomUUID().toString())
.setGroupConfig(new GroupConfig(groupName, password))
.setProperty("hazelcast.phone.home.enabled", "false");
// the shutdown hook should be disabled in a Spring environment to prevent Hazelcast from being stopped
// too early, leading to the exception "HazelcastInstanceNotActiveException" at shutdown time.
// Instead the shutdown should be managed by Spring at application context-closing time
// see HazelCastService.shutdown()
// TODO the shutdown hook should eventually be disabled by default
if (!shutDownHookEnabled) {
cfg.setProperty("hazelcast.shutdownhook.enabled", "false");
}
// tcp
final TcpIpConfig tcpCfg = new TcpIpConfig();
nodes.forEach(tcpCfg::addMember);
tcpCfg.setEnabled(true);
// network join configuration
final JoinConfig joinCfg = new JoinConfig()
.setMulticastConfig(new MulticastConfig().setEnabled(false))
.setTcpIpConfig(tcpCfg);
final NetworkConfig netCfg = new NetworkConfig()
.setPortAutoIncrement(false)
.setPort(HC_PORT)
.setJoin(joinCfg)
.setSSLConfig(new SSLConfig().setEnabled(false));
MapConfig mapConfig = cfg.getMapConfig("default");
updateDefaultMapConfig(mapConfig);
log.info("Old config: b_count {} async_b_count {} read_backup_data {}", mapConfig.getBackupCount(), mapConfig.getAsyncBackupCount(), mapConfig.isReadBackupData());
// http://docs.hazelcast.org/docs/3.7/manual/html-single/index.html#backing-up-maps
mapConfig.setBackupCount(backupCount)
.setAsyncBackupCount(backupCountAsync)
.setReadBackupData(true);
log.info("Updated config: b_count {} async_b_count {} read_backup_data {}", mapConfig.getBackupCount(), mapConfig.getAsyncBackupCount(), mapConfig.isReadBackupData());
addMgmtIfConfigured(cfg);
cfg.setNetworkConfig(netCfg);
getAdditionalMapConfigurations().forEach(cfg::addMapConfig);
getSerializerConfigs().forEach( cfg.getSerializationConfig()::addSerializerConfig);
return Hazelcast.newHazelcastInstance(cfg);
}
/**
* Adding management configuration if it has been given
*/
private void addMgmtIfConfigured(Config cfg) {
if ( managementUrl != null && !managementUrl.isEmpty() ) {
ManagementCenterConfig mcc = new ManagementCenterConfig(managementUrl, 3);
mcc.setEnabled(true);
cfg.setManagementCenterConfig(mcc);
log.info("Added management URL: {} ", managementUrl);
}
}
/**
* Initialize a VM local instance of hazelcast
*/
private HazelcastInstance initForLocalHazelCast() {
log.info("Running hazelcast with LOCAL configuration ONLY - this is for junit tests and when you do not have a kubernetes environment");
final Config cfg = new Config()
.setInstanceName(UUID.randomUUID().toString())
.setProperty("hazelcast.phone.home.enabled", "false");
final JoinConfig joinCfg = new JoinConfig()
.setMulticastConfig(new MulticastConfig().setEnabled(false))
.setTcpIpConfig(new TcpIpConfig().setEnabled(false));
NetworkConfig networkCfg = new NetworkConfig()
.setJoin(joinCfg);
networkCfg.getInterfaces()
.setEnabled(false);
cfg.setNetworkConfig( networkCfg );
MapConfig mapConfig = cfg.getMapConfig("default");
updateDefaultMapConfig(mapConfig);
getAdditionalMapConfigurations().forEach(cfg::addMapConfig);
getSerializerConfigs().forEach( cfg.getSerializationConfig()::addSerializerConfig);
addMgmtIfConfigured(cfg);
return Hazelcast.newHazelcastInstance(cfg);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy