Improve logging

This commit is contained in:
Luis Barrios
2017-01-11 15:56:24 +01:00
parent 1f1bfff4f7
commit 8be6e1e86b
2 changed files with 57 additions and 19 deletions
@@ -49,11 +49,12 @@ class DefaultMoquetteSslContextCreator implements ISslContextCreator {
@Override @Override
public SSLContext initSSLContext() { public SSLContext initSSLContext() {
LOG.info("Checking SSL configuration properties...");
final String jksPath = props.getProperty(BrokerConstants.JKS_PATH_PROPERTY_NAME); final String jksPath = props.getProperty(BrokerConstants.JKS_PATH_PROPERTY_NAME);
LOG.info("Starting SSL using keystore at {}", jksPath); LOG.info("Initializing SSL context. KeystorePath = {}.", jksPath);
if (jksPath == null || jksPath.isEmpty()) { if (jksPath == null || jksPath.isEmpty()) {
//key_store_password or key_manager_password are empty //key_store_password or key_manager_password are empty
LOG.warn("You have configured the SSL port but not the jks_path, SSL not started"); LOG.warn("The keystore path is null or empty. The SSL context won't be initialized.");
return null; return null;
} }
@@ -63,12 +64,12 @@ class DefaultMoquetteSslContextCreator implements ISslContextCreator {
final String keyManagerPassword = props.getProperty(BrokerConstants.KEY_MANAGER_PASSWORD_PROPERTY_NAME); final String keyManagerPassword = props.getProperty(BrokerConstants.KEY_MANAGER_PASSWORD_PROPERTY_NAME);
if (keyStorePassword == null || keyStorePassword.isEmpty()) { if (keyStorePassword == null || keyStorePassword.isEmpty()) {
//key_store_password or key_manager_password are empty //key_store_password or key_manager_password are empty
LOG.warn("You have configured the SSL port but not the key_store_password, SSL not started"); LOG.warn("The keystore password is null or empty. The SSL context won't be initialized.");
return null; return null;
} }
if (keyManagerPassword == null || keyManagerPassword.isEmpty()) { if (keyManagerPassword == null || keyManagerPassword.isEmpty()) {
//key_manager_password or key_manager_password are empty //key_manager_password or key_manager_password are empty
LOG.warn("You have configured the SSL port but not the key_manager_password, SSL not started"); LOG.warn("The key manager password is null or empty. The SSL context won't be initialized.");
return null; return null;
} }
@@ -78,26 +79,33 @@ class DefaultMoquetteSslContextCreator implements ISslContextCreator {
boolean needsClientAuth = Boolean.valueOf(sNeedsClientAuth); boolean needsClientAuth = Boolean.valueOf(sNeedsClientAuth);
try { try {
LOG.info("Loading keystore. KeystorePath = {}.", jksPath);
InputStream jksInputStream = jksDatastore(jksPath); InputStream jksInputStream = jksDatastore(jksPath);
SSLContext serverContext = SSLContext.getInstance("TLS"); SSLContext serverContext = SSLContext.getInstance("TLS");
final KeyStore ks = KeyStore.getInstance("JKS"); final KeyStore ks = KeyStore.getInstance("JKS");
ks.load(jksInputStream, keyStorePassword.toCharArray()); ks.load(jksInputStream, keyStorePassword.toCharArray());
LOG.info("Initializing key manager...");
final KeyManagerFactory kmf = KeyManagerFactory.getInstance(KeyManagerFactory.getDefaultAlgorithm()); final KeyManagerFactory kmf = KeyManagerFactory.getInstance(KeyManagerFactory.getDefaultAlgorithm());
kmf.init(ks, keyManagerPassword.toCharArray()); kmf.init(ks, keyManagerPassword.toCharArray());
TrustManager[] trustManagers = null; TrustManager[] trustManagers = null;
if (needsClientAuth) { if (needsClientAuth) {
LOG.warn(
"Client authentication is enabled. The keystore will be used as a truststore. KeystorePath = {}.",
jksPath);
// use keystore as truststore, as server needs to trust certificates signed by the server certificates // use keystore as truststore, as server needs to trust certificates signed by the server certificates
TrustManagerFactory tmf = TrustManagerFactory.getInstance(TrustManagerFactory.getDefaultAlgorithm()); TrustManagerFactory tmf = TrustManagerFactory.getInstance(TrustManagerFactory.getDefaultAlgorithm());
tmf.init(ks); tmf.init(ks);
trustManagers = tmf.getTrustManagers(); trustManagers = tmf.getTrustManagers();
} }
// init sslContext // init sslContext
LOG.info("Initializing SSL context...");
serverContext.init(kmf.getKeyManagers(), trustManagers, null); serverContext.init(kmf.getKeyManagers(), trustManagers, null);
LOG.info("The SSL context has been initialized successfully.");
return serverContext; return serverContext;
} catch (NoSuchAlgorithmException | UnrecoverableKeyException | CertificateException | KeyStoreException } catch (NoSuchAlgorithmException | UnrecoverableKeyException | CertificateException | KeyStoreException
| KeyManagementException | IOException ex) { | KeyManagementException | IOException ex) {
LOG.error("Can't start SSL layer!", ex); LOG.error("Unable to initialize SSL context. Cause = {}, errorMessage = {}.", ex.getCause(), ex.getMessage());
return null; return null;
} }
} }
@@ -108,13 +116,13 @@ class DefaultMoquetteSslContextCreator implements ISslContextCreator {
LOG.info("Starting with jks at {}, jks normal {}", jksUrl.toExternalForm(), jksUrl); LOG.info("Starting with jks at {}, jks normal {}", jksUrl.toExternalForm(), jksUrl);
return getClass().getClassLoader().getResourceAsStream(jksPath); return getClass().getClassLoader().getResourceAsStream(jksPath);
} }
LOG.info("jks not found in bundled resources, try on the filesystem"); LOG.warn("No keystore has been found in the bundled resources. Scanning filesystem...");
File jksFile = new File(jksPath); File jksFile = new File(jksPath);
if (jksFile.exists()) { if (jksFile.exists()) {
LOG.info("Using {} ", jksFile.getAbsolutePath()); LOG.info("Loading external keystore. Url = {}.", jksFile.getAbsolutePath());
return new FileInputStream(jksFile); return new FileInputStream(jksFile);
} }
LOG.warn("File {} doesn't exists", jksFile.getAbsolutePath()); LOG.warn("The keystore file does not exist. Url = {}.", jksFile.getAbsolutePath());
return null; return null;
} }
} }
@@ -45,6 +45,8 @@ import java.util.Collections;
import java.util.List; import java.util.List;
import java.util.Properties; import java.util.Properties;
import static io.moquette.logging.LoggingUtils.getInterceptorIds;
/** /**
* Launch a configured version of the server. * Launch a configured version of the server.
* @author andrea * @author andrea
@@ -68,7 +70,7 @@ public class Server {
public static void main(String[] args) throws IOException { public static void main(String[] args) throws IOException {
final Server server = new Server(); final Server server = new Server();
server.startServer(); server.startServer();
System.out.println("Server started, version 0.9-SNAPSHOT"); LOG.info("Server started, version 0.9-SNAPSHOT");
//Bind a shutdown hook //Bind a shutdown hook
Runtime.getRuntime().addShutdownHook(new Thread() { Runtime.getRuntime().addShutdownHook(new Thread() {
@Override @Override
@@ -84,7 +86,9 @@ public class Server {
* @throws IOException in case of any IO error. * @throws IOException in case of any IO error.
*/ */
public void startServer() throws IOException { public void startServer() throws IOException {
IResourceLoader filesystemLoader = new FileResourceLoader(defaultConfigFile()); File defaultConfigurationFile = defaultConfigFile();
LOG.info("Starting Moquette server. Configuration file path = {}.", defaultConfigurationFile.getAbsolutePath());
IResourceLoader filesystemLoader = new FileResourceLoader(defaultConfigurationFile);
final IConfig config = new ResourceLoaderConfig(filesystemLoader); final IConfig config = new ResourceLoaderConfig(filesystemLoader);
startServer(config); startServer(config);
} }
@@ -100,7 +104,7 @@ public class Server {
* @throws IOException in case of any IO Error. * @throws IOException in case of any IO Error.
*/ */
public void startServer(File configFile) throws IOException { public void startServer(File configFile) throws IOException {
LOG.info("Using m_config file: " + configFile.getAbsolutePath()); LOG.info("Starting Moquette server. Configuration file path = {}.", configFile.getAbsolutePath());
IResourceLoader filesystemLoader = new FileResourceLoader(configFile); IResourceLoader filesystemLoader = new FileResourceLoader(configFile);
final IConfig config = new ResourceLoaderConfig(filesystemLoader); final IConfig config = new ResourceLoaderConfig(filesystemLoader);
startServer(config); startServer(config);
@@ -119,6 +123,7 @@ public class Server {
* @throws IOException in case of any IO Error. * @throws IOException in case of any IO Error.
*/ */
public void startServer(Properties configProps) throws IOException { public void startServer(Properties configProps) throws IOException {
LOG.info("Starting Moquette server using properties object...");
final IConfig config = new MemoryConfig(configProps); final IConfig config = new MemoryConfig(configProps);
startServer(config); startServer(config);
} }
@@ -129,6 +134,7 @@ public class Server {
* @throws IOException in case of any IO Error. * @throws IOException in case of any IO Error.
*/ */
public void startServer(IConfig config) throws IOException { public void startServer(IConfig config) throws IOException {
LOG.info("Starting Moquette server using IConfig instance...");
startServer(config, null); startServer(config, null);
} }
@@ -140,6 +146,7 @@ public class Server {
* @throws IOException in case of any IO Error. * @throws IOException in case of any IO Error.
* */ * */
public void startServer(IConfig config, List<? extends InterceptHandler> handlers) throws IOException { public void startServer(IConfig config, List<? extends InterceptHandler> handlers) throws IOException {
LOG.info("Starting moquette server using IConfig instance and intercept handlers...");
startServer(config, handlers, null, null, null); startServer(config, handlers, null, null, null);
} }
@@ -149,29 +156,37 @@ public class Server {
if (handlers == null) { if (handlers == null) {
handlers = Collections.emptyList(); handlers = Collections.emptyList();
} }
LOG.info("Starting Moquette Server. MQTT message interceptors = {}.", getInterceptorIds(handlers));
final String handlerProp = System.getProperty(BrokerConstants.INTERCEPT_HANDLER_PROPERTY_NAME); final String handlerProp = System.getProperty(BrokerConstants.INTERCEPT_HANDLER_PROPERTY_NAME);
if (handlerProp != null) { if (handlerProp != null) {
config.setProperty(BrokerConstants.INTERCEPT_HANDLER_PROPERTY_NAME, handlerProp); config.setProperty(BrokerConstants.INTERCEPT_HANDLER_PROPERTY_NAME, handlerProp);
} }
configureCluster(config); configureCluster(config);
LOG.info("Persistent store file: {}", config.getProperty(BrokerConstants.PERSISTENT_STORE_PROPERTY_NAME)); LOG.info("Configuring Using persistent store file. Path = {}.", config.getProperty(BrokerConstants.PERSISTENT_STORE_PROPERTY_NAME));
m_processorBootstrapper = new ProtocolProcessorBootstrapper(); m_processorBootstrapper = new ProtocolProcessorBootstrapper();
LOG.info("Initializing MQTT protocol processor...");
final ProtocolProcessor processor = m_processorBootstrapper.init(config, handlers, authenticator, authorizator, this); final ProtocolProcessor processor = m_processorBootstrapper.init(config, handlers, authenticator, authorizator, this);
if (sslCtxCreator == null) { if (sslCtxCreator == null) {
LOG.warn("Using default SSL context creator...");
sslCtxCreator = new DefaultMoquetteSslContextCreator(config); sslCtxCreator = new DefaultMoquetteSslContextCreator(config);
} }
LOG.info("Binding server to the configured ports...");
m_acceptor = new NettyAcceptor(); m_acceptor = new NettyAcceptor();
m_acceptor.initialize(processor, config, sslCtxCreator); m_acceptor.initialize(processor, config, sslCtxCreator);
m_processor = processor; m_processor = processor;
LOG.info("The Moquette server has been initialized successfully.");
m_initialized = true; m_initialized = true;
} }
private void configureCluster(IConfig config) throws FileNotFoundException { private void configureCluster(IConfig config) throws FileNotFoundException {
LOG.info("Configuring embedded Hazelcast instance...");
String interceptHandlerClassname = config.getProperty(BrokerConstants.INTERCEPT_HANDLER_PROPERTY_NAME); String interceptHandlerClassname = config.getProperty(BrokerConstants.INTERCEPT_HANDLER_PROPERTY_NAME);
if (interceptHandlerClassname == null || !HZ_INTERCEPT_HANDLER.equals(interceptHandlerClassname)) { if (interceptHandlerClassname == null || !HZ_INTERCEPT_HANDLER.equals(interceptHandlerClassname)) {
LOG.info("There are no Hazelcast intercept handlers. The server won't start a Hazelcast instance.");
return; return;
} }
String hzConfigPath = config.getProperty(BrokerConstants.HAZELCAST_CONFIGURATION); String hzConfigPath = config.getProperty(BrokerConstants.HAZELCAST_CONFIGURATION);
@@ -180,16 +195,17 @@ public class Server {
Config hzconfig = isHzConfigOnClasspath ? Config hzconfig = isHzConfigOnClasspath ?
new ClasspathXmlConfig(hzConfigPath) : new ClasspathXmlConfig(hzConfigPath) :
new FileSystemXmlConfig(hzConfigPath); new FileSystemXmlConfig(hzConfigPath);
LOG.info(String.format("starting server with hazelcast configuration file : %s",hzconfig)); LOG.info("Starting Hazelcast instance. ConfigurationFile = {}.",hzconfig);
hazelcastInstance = Hazelcast.newHazelcastInstance(hzconfig); hazelcastInstance = Hazelcast.newHazelcastInstance(hzconfig);
} else { } else {
LOG.info("starting server with hazelcast default file"); LOG.info("Starting Hazelcast instance with default configuration.");
hazelcastInstance = Hazelcast.newHazelcastInstance(); hazelcastInstance = Hazelcast.newHazelcastInstance();
} }
listenOnHazelCastMsg(); listenOnHazelCastMsg();
} }
private void listenOnHazelCastMsg() { private void listenOnHazelCastMsg() {
LOG.info("Subscribing to Hazelcast topic. TopicName = {}.", "moquette");
HazelcastInstance hz = getHazelcastInstance(); HazelcastInstance hz = getHazelcastInstance();
ITopic<HazelcastMsg> topic = hz.getTopic("moquette"); ITopic<HazelcastMsg> topic = hz.getTopic("moquette");
topic.addMessageListener(new HazelcastListener(this)); topic.addMessageListener(new HazelcastListener(this));
@@ -208,24 +224,31 @@ public class Server {
* */ * */
public void internalPublish(PublishMessage msg) { public void internalPublish(PublishMessage msg) {
if (!m_initialized) { if (!m_initialized) {
throw new IllegalStateException("Can't publish on a server is not yet started"); LOG.error("The server is not started. The message cannot be published. MqttClientId = {}, messageId = {}.",
msg.getClientId(), msg.getMessageID());
throw new IllegalStateException("Can't publish on a server is not yet started");
}
if (LOG.isDebugEnabled()) {
LOG.debug("Publishing message. MqttClientId = {}, messageId = {}.", msg.getClientId(), msg.getMessageID());
} }
m_processor.internalPublish(msg); m_processor.internalPublish(msg);
} }
public void stopServer() { public void stopServer() {
LOG.info("Server stopping..."); LOG.info("Unbinding server from the configured ports...");
m_acceptor.close(); m_acceptor.close();
LOG.info("Stopping MQTT protocol processor...");
m_processorBootstrapper.shutdown(); m_processorBootstrapper.shutdown();
m_initialized = false; m_initialized = false;
if (hazelcastInstance != null) { if (hazelcastInstance != null) {
LOG.info("Stopping embedded Hazelcast instance...");
try { try {
hazelcastInstance.shutdown(); hazelcastInstance.shutdown();
} catch (HazelcastInstanceNotActiveException e) { } catch (HazelcastInstanceNotActiveException e) {
LOG.info("hazelcast already shutdown"); LOG.warn("The embedded Hazelcast instance is already shut down.");
} }
} }
LOG.info("Server stopped"); LOG.info("The Moquette server has been stopped.");
} }
/** /**
@@ -248,8 +271,12 @@ public class Server {
* */ * */
public void addInterceptHandler(InterceptHandler interceptHandler) { public void addInterceptHandler(InterceptHandler interceptHandler) {
if (!m_initialized) { if (!m_initialized) {
LOG.error("The server is not started. The MQTT message interceptor cannot be added. InterceptorId = {}.",
interceptHandler.getID());
throw new IllegalStateException("Can't register interceptors on a server that is not yet started"); throw new IllegalStateException("Can't register interceptors on a server that is not yet started");
} }
LOG.info("Adding MQTT message interceptor. InterceptorId = {}.", interceptHandler.getID());
m_processor.addInterceptHandler(interceptHandler); m_processor.addInterceptHandler(interceptHandler);
} }
@@ -260,8 +287,11 @@ public class Server {
* */ * */
public void removeInterceptHandler(InterceptHandler interceptHandler) { public void removeInterceptHandler(InterceptHandler interceptHandler) {
if (!m_initialized) { if (!m_initialized) {
LOG.error("The server is not started. The MQTT message interceptor cannot be removed. InterceptorId = {}.",
interceptHandler.getID());
throw new IllegalStateException("Can't deregister interceptors from a server that is not yet started"); throw new IllegalStateException("Can't deregister interceptors from a server that is not yet started");
} }
LOG.info("Removing MQTT message interceptor. InterceptorId = {}.", interceptHandler.getID());
m_processor.removeInterceptHandler(interceptHandler); m_processor.removeInterceptHandler(interceptHandler);
} }