From 30a91e935445d764d58d9e329236e9696264eeff Mon Sep 17 00:00:00 2001 From: Ivan Topolnjak Date: Fri, 30 Jan 2015 03:25:54 +0100 Subject: + all: use ModuleSupervisor init all auto-start modules. The new ModuleSupervisor implementation will make use of special configuration keys under the `kamon.modules` section to detect all the available modules in the classpath and do two things with that info: 1. Log the AspectJ Weaver missing error if any of the available modules requires AspectJ. 2. Start all available modules that are marked with the auto-start setting. --- kamon-core/src/main/resources/META-INF/aop.xml | 4 +- kamon-core/src/main/resources/reference.conf | 8 ++ kamon-core/src/main/scala/kamon/Kamon.scala | 6 +- .../src/main/scala/kamon/ModuleSupervisor.scala | 65 ------------ .../main/scala/kamon/metric/MetricsExtension.scala | 28 +----- .../scala/kamon/supervisor/AspectJPresent.scala | 15 +++ .../supervisor/ModuleSupervisorExtension.scala | 109 +++++++++++++++++++++ .../supervisor/ModuleSupervisorSettings.scala | 33 +++++++ 8 files changed, 174 insertions(+), 94 deletions(-) delete mode 100644 kamon-core/src/main/scala/kamon/ModuleSupervisor.scala create mode 100644 kamon-core/src/main/scala/kamon/supervisor/AspectJPresent.scala create mode 100644 kamon-core/src/main/scala/kamon/supervisor/ModuleSupervisorExtension.scala create mode 100644 kamon-core/src/main/scala/kamon/supervisor/ModuleSupervisorSettings.scala (limited to 'kamon-core/src') diff --git a/kamon-core/src/main/resources/META-INF/aop.xml b/kamon-core/src/main/resources/META-INF/aop.xml index 854e9437..2ffb8b09 100644 --- a/kamon-core/src/main/resources/META-INF/aop.xml +++ b/kamon-core/src/main/resources/META-INF/aop.xml @@ -3,8 +3,8 @@ - - + + diff --git a/kamon-core/src/main/resources/reference.conf b/kamon-core/src/main/resources/reference.conf index dabeda69..746652eb 100644 --- a/kamon-core/src/main/resources/reference.conf +++ b/kamon-core/src/main/resources/reference.conf @@ -166,4 +166,12 @@ kamon { parallelism-max = 10 } } + + + disable-aspectj-missing-warning = false + + modules { + # Just a place holder to ensure that the key is always available. Non-core Kamon modules should provide their + # settings in a module-info section. + } } \ No newline at end of file diff --git a/kamon-core/src/main/scala/kamon/Kamon.scala b/kamon-core/src/main/scala/kamon/Kamon.scala index d29061f8..6fedc065 100644 --- a/kamon-core/src/main/scala/kamon/Kamon.scala +++ b/kamon-core/src/main/scala/kamon/Kamon.scala @@ -18,6 +18,7 @@ import _root_.akka.actor import _root_.akka.actor._ import com.typesafe.config.Config import kamon.metric._ +import kamon.supervisor.ModuleSupervisor import kamon.trace.{ Tracer, TracerExtension } class Kamon(val actorSystem: ActorSystem) { @@ -25,7 +26,10 @@ class Kamon(val actorSystem: ActorSystem) { val tracer: TracerExtension = Tracer.get(actorSystem) val userMetrics: UserMetricsExtension = UserMetrics.get(actorSystem) - def shutdown: Unit = + // This will cause all auto-start modules to initiate. + ModuleSupervisor.get(actorSystem) + + def shutdown(): Unit = actorSystem.shutdown() } diff --git a/kamon-core/src/main/scala/kamon/ModuleSupervisor.scala b/kamon-core/src/main/scala/kamon/ModuleSupervisor.scala deleted file mode 100644 index 44daa6a7..00000000 --- a/kamon-core/src/main/scala/kamon/ModuleSupervisor.scala +++ /dev/null @@ -1,65 +0,0 @@ -/* - * ========================================================================================= - * Copyright © 2013-2015 the kamon project - * - * 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 kamon - -import _root_.akka.actor -import _root_.akka.actor._ -import kamon.ModuleSupervisor.CreateModule - -import scala.concurrent.{ Future, Promise } -import scala.util.Success - -object ModuleSupervisor extends ExtensionId[ModuleSupervisorExtension] with ExtensionIdProvider { - - def lookup(): ExtensionId[_ <: actor.Extension] = ModuleSupervisor - def createExtension(system: ExtendedActorSystem): ModuleSupervisorExtension = new ModuleSupervisorExtensionImpl(system) - - case class CreateModule(name: String, props: Props, childPromise: Promise[ActorRef]) -} - -trait ModuleSupervisorExtension extends actor.Extension { - def createModule(name: String, props: Props): Future[ActorRef] -} - -class ModuleSupervisorExtensionImpl(system: ExtendedActorSystem) extends ModuleSupervisorExtension { - import system.dispatcher - private val supervisor = system.actorOf(Props[ModuleSupervisor], "kamon") - - def createModule(name: String, props: Props): Future[ActorRef] = Future {} flatMap { _: Unit ⇒ - val modulePromise = Promise[ActorRef]() - supervisor ! CreateModule(name, props, modulePromise) - modulePromise.future - } -} - -class ModuleSupervisor extends Actor with ActorLogging { - - def receive = { - case CreateModule(name, props, childPromise) ⇒ createChildModule(name, props, childPromise) - } - - def createChildModule(name: String, props: Props, childPromise: Promise[ActorRef]): Unit = { - - context.child(name).map { alreadyAvailableModule ⇒ - log.warning("Received a request to create module [{}] but the module is already available, returning the existent one.") - childPromise.complete(Success(alreadyAvailableModule)) - - } getOrElse { - childPromise.complete(Success(context.actorOf(props, name))) - } - } -} diff --git a/kamon-core/src/main/scala/kamon/metric/MetricsExtension.scala b/kamon-core/src/main/scala/kamon/metric/MetricsExtension.scala index 0b7fc7f2..c14d4e16 100644 --- a/kamon-core/src/main/scala/kamon/metric/MetricsExtension.scala +++ b/kamon-core/src/main/scala/kamon/metric/MetricsExtension.scala @@ -18,8 +18,9 @@ package kamon.metric import akka.actor import kamon.metric.SubscriptionsDispatcher.{ Unsubscribe, Subscribe } -import kamon.{ ModuleSupervisor, Kamon } +import kamon.Kamon import kamon.metric.instrument.{ InstrumentFactory, CollectionContext } +import kamon.supervisor.ModuleSupervisor import scala.collection.concurrent.TrieMap import akka.actor._ @@ -127,30 +128,5 @@ class MetricsExtensionImpl(system: ExtendedActorSystem) extends MetricsExtension builder.result() } - - /* def printInitializationMessage(eventStream: EventStream, disableWeaverMissingError: Boolean): Unit = { - if (!disableWeaverMissingError) { - val weaverMissingMessage = - """ - | - | ___ _ ___ _ _ ___ ___ _ _ - | / _ \ | | |_ | | | | | | \/ |(_) (_) - |/ /_\ \ ___ _ __ ___ ___ | |_ | | | | | | ___ __ _ __ __ ___ _ __ | . . | _ ___ ___ _ _ __ __ _ - || _ |/ __|| '_ \ / _ \ / __|| __| | | | |/\| | / _ \ / _` |\ \ / // _ \| '__| | |\/| || |/ __|/ __|| || '_ \ / _` | - || | | |\__ \| |_) || __/| (__ | |_ /\__/ / \ /\ /| __/| (_| | \ V /| __/| | | | | || |\__ \\__ \| || | | || (_| | - |\_| |_/|___/| .__/ \___| \___| \__|\____/ \/ \/ \___| \__,_| \_/ \___||_| \_| |_/|_||___/|___/|_||_| |_| \__, | - | | | __/ | - | |_| |___/ - | - | It seems like your application wasn't started with the -javaagent:/path-to-aspectj-weaver.jar option. Without that Kamon might - | not work properly, if you need help on setting up the weaver go to http://kamon.io/introduction/get-started/ for more info. If - | you are sure that you don't need the weaver (e.g. you are only using KamonStandalone) then you can disable this error message - | by changing the kamon.metrics.disable-aspectj-weaver-missing-error setting in your configuration file. - | - """.stripMargin - - eventStream.publish(Error("MetricsExtension", classOf[MetricsExtension], weaverMissingMessage)) - } - }*/ } diff --git a/kamon-core/src/main/scala/kamon/supervisor/AspectJPresent.scala b/kamon-core/src/main/scala/kamon/supervisor/AspectJPresent.scala new file mode 100644 index 00000000..bbb8b69b --- /dev/null +++ b/kamon-core/src/main/scala/kamon/supervisor/AspectJPresent.scala @@ -0,0 +1,15 @@ +package kamon.supervisor + +import org.aspectj.lang.ProceedingJoinPoint +import org.aspectj.lang.annotation.{ Around, Aspect, Pointcut } + +@Aspect +class AspectJPresent { + + @Pointcut("execution(* kamon.supervisor.KamonSupervisor.isAspectJPresent())") + def isAspectJPresentAtModuleSupervisor(): Unit = {} + + @Around("isAspectJPresentAtModuleSupervisor()") + def aroundIsAspectJPresentAtModuleSupervisor(pjp: ProceedingJoinPoint): Boolean = true + +} diff --git a/kamon-core/src/main/scala/kamon/supervisor/ModuleSupervisorExtension.scala b/kamon-core/src/main/scala/kamon/supervisor/ModuleSupervisorExtension.scala new file mode 100644 index 00000000..1ff6bfc6 --- /dev/null +++ b/kamon-core/src/main/scala/kamon/supervisor/ModuleSupervisorExtension.scala @@ -0,0 +1,109 @@ +package kamon.supervisor + +import akka.actor +import akka.actor._ +import kamon.Kamon +import kamon.supervisor.KamonSupervisor.CreateModule + +import scala.concurrent.{ Promise, Future } +import scala.util.Success + +object ModuleSupervisor extends ExtensionId[ModuleSupervisorExtension] with ExtensionIdProvider { + def lookup(): ExtensionId[_ <: actor.Extension] = ModuleSupervisor + def createExtension(system: ExtendedActorSystem): ModuleSupervisorExtension = new ModuleSupervisorExtensionImpl(system) +} + +trait ModuleSupervisorExtension extends actor.Extension { + def createModule(name: String, props: Props): Future[ActorRef] +} + +class ModuleSupervisorExtensionImpl(system: ExtendedActorSystem) extends ModuleSupervisorExtension { + import system.dispatcher + + private val _settings = ModuleSupervisorSettings(system) + private val _supervisor = system.actorOf(KamonSupervisor.props(_settings, system.dynamicAccess), "kamon") + + def createModule(name: String, props: Props): Future[ActorRef] = Future {} flatMap { _: Unit ⇒ + val modulePromise = Promise[ActorRef]() + _supervisor ! CreateModule(name, props, modulePromise) + modulePromise.future + } +} + +class KamonSupervisor(settings: ModuleSupervisorSettings, dynamicAccess: DynamicAccess) extends Actor with ActorLogging { + + init() + + def receive = { + case CreateModule(name, props, childPromise) ⇒ createChildModule(name, props, childPromise) + } + + def createChildModule(name: String, props: Props, childPromise: Promise[ActorRef]): Unit = + context.child(name).map { alreadyAvailableModule ⇒ + log.warning("Received a request to create module [{}] but the module is already available, returning the existent instance.") + childPromise.complete(Success(alreadyAvailableModule)) + + } getOrElse (childPromise.complete(Success(context.actorOf(props, name)))) + + def init(): Unit = { + if (settings.modulesRequiringAspectJ.nonEmpty && !isAspectJPresent && !settings.disableAspectJMissingWarning) + logAspectJWeaverMissing(settings.modulesRequiringAspectJ) + + // Force initialization of all modules marked with auto-start. + settings.availableModules.filter(_.autoStart).foreach { module ⇒ + if (module.extensionClass == "none") + log.debug("Ignoring auto start of the [{}] module with no extension class.") + else + dynamicAccess.getObjectFor[ExtensionId[Kamon.Extension]](module.extensionClass).map { moduleID ⇒ + moduleID.get(context.system) + log.debug("Auto starting the [{}] module.", module.name) + + } recover { + case th: Throwable ⇒ log.error(th, "Failed to auto start the [{}] module.", module.name) + } + + } + } + + // When AspectJ is present the kamon.supervisor.AspectJPresent aspect will make this return true. + def isAspectJPresent: Boolean = false + + def logAspectJWeaverMissing(modulesRequiringAspectJ: List[AvailableModuleInfo]): Unit = { + val moduleNames = modulesRequiringAspectJ.map(_.name).mkString(", ") + val weaverMissingMessage = + """ + | + | ___ _ ___ _ _ ___ ___ _ _ + | / _ \ | | |_ | | | | | | \/ |(_) (_) + |/ /_\ \ ___ _ __ ___ ___ | |_ | | | | | | ___ __ _ __ __ ___ _ __ | . . | _ ___ ___ _ _ __ __ _ + || _ |/ __|| '_ \ / _ \ / __|| __| | | | |/\| | / _ \ / _` |\ \ / // _ \| '__| | |\/| || |/ __|/ __|| || '_ \ / _` | + || | | |\__ \| |_) || __/| (__ | |_ /\__/ / \ /\ /| __/| (_| | \ V /| __/| | | | | || |\__ \\__ \| || | | || (_| | + |\_| |_/|___/| .__/ \___| \___| \__|\____/ \/ \/ \___| \__,_| \_/ \___||_| \_| |_/|_||___/|___/|_||_| |_| \__, | + | | | __/ | + | |_| |___/ + | + | It seems like your application was not started with the -javaagent:/path-to-aspectj-weaver.jar option but Kamon detected + | the following modules which require AspecJ to work properly: + | + """.stripMargin + moduleNames + + """ + | + | If you need help on setting up the aspectj weaver go to http://kamon.io/introduction/get-started/ for more info. On the + | other hand, if you are sure that you do not need or do not want to use the weaver then you can disable this error message + | by changing the kamon.disable-aspectj-missing-warning setting in your configuration file. + | + """.stripMargin + + log.error(weaverMissingMessage) + } + +} + +object KamonSupervisor { + case class CreateModule(name: String, props: Props, childPromise: Promise[ActorRef]) + + def props(settings: ModuleSupervisorSettings, dynamicAccess: DynamicAccess): Props = + Props(new KamonSupervisor(settings, dynamicAccess)) + +} + diff --git a/kamon-core/src/main/scala/kamon/supervisor/ModuleSupervisorSettings.scala b/kamon-core/src/main/scala/kamon/supervisor/ModuleSupervisorSettings.scala new file mode 100644 index 00000000..c5556004 --- /dev/null +++ b/kamon-core/src/main/scala/kamon/supervisor/ModuleSupervisorSettings.scala @@ -0,0 +1,33 @@ +package kamon.supervisor + +import akka.actor.ActorSystem + +case class AvailableModuleInfo(name: String, extensionClass: String, requiresAspectJ: Boolean, autoStart: Boolean) +case class ModuleSupervisorSettings(disableAspectJMissingWarning: Boolean, availableModules: List[AvailableModuleInfo]) { + val modulesRequiringAspectJ = availableModules.filter(_.requiresAspectJ) +} + +object ModuleSupervisorSettings { + + def apply(system: ActorSystem): ModuleSupervisorSettings = { + import kamon.util.ConfigTools.Syntax + + val config = system.settings.config.getConfig("kamon.modules") + val disableAspectJMissingWarning = system.settings.config.getBoolean("kamon.disable-aspectj-missing-warning") + + val modules = config.firstLevelKeys + val availableModules = modules.map { moduleName ⇒ + val moduleConfig = config.getConfig(moduleName) + + AvailableModuleInfo( + moduleName, + moduleConfig.getString("extension-id"), + moduleConfig.getBoolean("requires-aspectj"), + moduleConfig.getBoolean("auto-start")) + + } toList + + ModuleSupervisorSettings(disableAspectJMissingWarning, availableModules) + } + +} -- cgit v1.2.3