io.datakernel.jmx.JmxModule Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2015 SoftIndex LLC.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.datakernel.jmx;

import com.google.inject.*;
import com.google.inject.matcher.AbstractMatcher;
import com.google.inject.name.Names;
import com.google.inject.spi.ProvisionListener;
import io.datakernel.bytebuf.ByteBufPool;
import io.datakernel.jmx.JmxMBeans.JmxCustomTypeAdapter;
import io.datakernel.service.BlockingService;
import io.datakernel.service.ServiceGraph;
import io.datakernel.trigger.Severity;
import io.datakernel.trigger.Triggers.TriggerWithResult;
import io.datakernel.util.Initializable;
import io.datakernel.util.MemSize;
import io.datakernel.util.StringFormatUtils;
import io.datakernel.util.guice.OptionalInitializer;
import io.datakernel.util.guice.RequiredDependency;
import io.datakernel.worker.WorkerPoolModule;
import io.datakernel.worker.WorkerPools;

import javax.management.DynamicMBean;
import java.lang.management.ManagementFactory;
import java.lang.reflect.Type;
import java.time.Duration;
import java.time.Instant;
import java.time.LocalDateTime;
import java.time.Period;
import java.util.*;
import java.util.function.Function;

import static io.datakernel.util.Preconditions.checkArgument;
import static io.datakernel.util.guice.GuiceUtils.isSingleton;

/**
 * Turns on support of Jmx in application.
 * 

 * Automatically builds MBeans for parts of application and adds Jmx attributes and operations to it.
 */
public final class JmxModule extends AbstractModule implements Initializable {
	public static final Duration REFRESH_PERIOD_DEFAULT = Duration.ofSeconds(1);
	public static final int MAX_JMX_REFRESHES_PER_ONE_CYCLE_DEFAULT = 50;

	private final Set> singletonKeys = new HashSet<>();
	private final Set> workerKeys = new HashSet<>();

	private final Map, MBeanSettings> keyToSettings = new HashMap<>();
	private final Map typeToSettings = new HashMap<>();
	private final Map, String> keyToObjectNames = new HashMap<>();
	private final Map> customTypes = new HashMap<>();

	private Duration refreshPeriod = REFRESH_PERIOD_DEFAULT;
	private int maxJmxRefreshesPerOneCycle = MAX_JMX_REFRESHES_PER_ONE_CYCLE_DEFAULT;
	private final Map> globalMBeans = new HashMap<>();

	private interface JmxRegistratorService extends BlockingService {
	}

	private JmxModule() {
	}

	public static JmxModule create() {
		return new JmxModule()
				.withCustomType(Duration.class, StringFormatUtils::formatDuration, StringFormatUtils::parseDuration)
				.withCustomType(MemSize.class, StringFormatUtils::formatMemSize, StringFormatUtils::parseMemSize)
				.withCustomType(Period.class, StringFormatUtils::formatPeriod, StringFormatUtils::parsePeriod)
				.withCustomType(Instant.class, StringFormatUtils::formatInstant, StringFormatUtils::parseInstant)
				.withCustomType(LocalDateTime.class, StringFormatUtils::formatLocalDateTime, StringFormatUtils::parseLocalDateTime)
				.withCustomType(TriggerWithResult.class, TriggerWithResult::toString)
				.withCustomType(Severity.class, Severity::toString);
	}

	public JmxModule withRefreshPeriod(Duration refreshPeriod) {
		checkArgument(refreshPeriod.toMillis() > 0);

		this.refreshPeriod = refreshPeriod;
		return this;
	}

	public JmxModule withMaxJmxRefreshesPerOneCycle(int max) {
		checkArgument(max > 0);

		this.maxJmxRefreshesPerOneCycle = max;
		return this;
	}

	public  JmxModule withModifier(Key key, String attrName, AttributeModifier modifier) {
		keyToSettings.computeIfAbsent(key, $ -> MBeanSettings.defaultSettings())
				.withModifier(attrName, modifier);
		return this;
	}

	public  JmxModule withModifier(Type type, String attrName, AttributeModifier modifier) {
		typeToSettings.computeIfAbsent(type, $ -> MBeanSettings.defaultSettings())
				.withModifier(attrName, modifier);
		return this;
	}

	public JmxModule withOptional(Key key, String attrName) {
		keyToSettings.computeIfAbsent(key, $ -> MBeanSettings.defaultSettings())
				.withIncludedOptional(attrName);
		return this;
	}

	public JmxModule withOptional(Type type, String attrName) {
		typeToSettings.computeIfAbsent(type, $ -> MBeanSettings.defaultSettings())
				.withIncludedOptional(attrName);
		return this;
	}

	public JmxModule withHistogram(Key key, String attrName, int[] histogramLevels) {
		return this
				.withOptional(key, attrName + "_histogram")
				.withModifier(key, attrName, (ValueStats attribute) ->
						attribute.setHistogramLevels(histogramLevels));
	}

	public JmxModule withHistogram(Class clazz, String attrName, int[] histogramLevels) {
		return withHistogram(Key.get(clazz), attrName, histogramLevels);
	}

	public JmxModule withGlobalMBean(Type type, String named) {
		return withGlobalMBean(type, Key.get(type, Names.named(named)));
	}

	public JmxModule withGlobalMBean(Type type, Key key) {
		globalMBeans.put(type, key);
		return this;
	}

	public JmxModule withObjectName(Key key, String objectName) {
		this.keyToObjectNames.put(key, objectName);
		return this;
	}

	public JmxModule withObjectName(Type type, String objectName) {
		return withObjectName(Key.get(type), objectName);
	}

	public  JmxModule withCustomType(Class type, Function to, Function from) {
		this.customTypes.put(type, new JmxCustomTypeAdapter<>(to, from));
		return this;
	}

	public  JmxModule withCustomType(Class type, Function to) {
		this.customTypes.put(type, new JmxCustomTypeAdapter<>(to));
		return this;
	}

	@Override
	protected void configure() {
		bindListener(new AbstractMatcher>() {
			@Override
			public boolean matches(Binding binding) {
				return WorkerPoolModule.isWorkerScope(binding);
			}
		}, new ProvisionListener() {
			@Override
			public  void onProvision(ProvisionInvocation provision) {
				synchronized (JmxModule.this) {
					if (provision.provision() != null) {
						workerKeys.add(provision.getBinding().getKey());
					}
				}
			}
		});
		bindListener(new AbstractMatcher>() {
			@Override
			public boolean matches(Binding binding) {
				return isSingleton(binding);
			}
		}, new ProvisionListener() {
			@Override
			public  void onProvision(ProvisionInvocation provision) {
				synchronized (JmxModule.this) {
					if (provision.provision() != null) {
						singletonKeys.add(provision.getBinding().getKey());
					}
				}
			}
		});
		bind(new TypeLiteral>() {
		}).asEagerSingleton();
		bind(new TypeLiteral>() {
		}).asEagerSingleton();
	}

	@Provides
	@Singleton
	JmxRegistratorService jmxRegistratorService(Injector injector, JmxRegistry jmxRegistry, DynamicMBeanFactory mbeanFactory,
	                                            OptionalInitializer optionalInitializer) {
		optionalInitializer.accept(this);
		return new JmxRegistratorService() {
			private void registerJmxMBeans() {
				// register ByteBufPool
				Key byteBufPoolKey = Key.get(ByteBufPool.ByteBufPoolStats.class);
				jmxRegistry.registerSingleton(byteBufPoolKey, ByteBufPool.getStats(), MBeanSettings.defaultSettings().withCustomTypes(customTypes));

				Map> globalMBeanObjects = new HashMap<>();

				// register singletons
				for (Key key : singletonKeys) {
					Object instance = injector.getInstance(key);
					jmxRegistry.registerSingleton(key, instance, ensureSettingsFor(key));

					Type type = key.getTypeLiteral().getType();
					if (globalMBeans.containsKey(type)) {
						globalMBeanObjects.computeIfAbsent(type, type1 -> new ArrayList<>()).add(instance);
					}
				}

				// register workers
				if (!workerKeys.isEmpty()) {
					WorkerPools workerPools = injector.getInstance(WorkerPools.class);
					for (Key key : workerKeys) {
						List objects = workerPools.getWorkerPoolObjects(key).getObjects();
						jmxRegistry.registerWorkers(key, objects, ensureSettingsFor(key));

						Type type = key.getTypeLiteral().getType();
						if (globalMBeans.containsKey(type)) {
							for (Object workerObject : objects) {
								globalMBeanObjects.computeIfAbsent(type, type1 -> new ArrayList<>()).add(workerObject);
							}
						}
					}
				}

				for (Type type : globalMBeanObjects.keySet()) {
					List