com.lightbend.akka.diagnostics

Class ConfigChecker

java.lang.Object

com.lightbend.akka.diagnostics.ConfigChecker

public class ConfigChecker
extends java.lang.Object

The ConfigChecker will try to find potential configuration issues. It is run when the actor system is started. It also possible to run it as a Java main program, see main(java.lang.String[]).

Detailed documentation can be found in the akka.diagnostics.checker section of the reference.conf and in the "Configuration Checker" section of the Akka Reference Documentation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConfigChecker.ConfigWarning
static class	ConfigChecker.ConfigWarning$
static class	ConfigChecker.ValidationResults
static class	ConfigChecker.ValidationResults$

Constructor Summary

Constructors

Constructor and Description
ConfigChecker(akka.actor.ExtendedActorSystem system)
ConfigChecker(akka.actor.ExtendedActorSystem system, com.typesafe.config.Config config, com.typesafe.config.Config reference)

Method Summary

Modifier and Type	Method and Description
ConfigChecker.ValidationResults	check() Run all checks.
scala.collection.immutable.Map<java.lang.String,com.typesafe.config.Config>	findDispatchers() INTERNAL API
static java.lang.String	format(ConfigChecker.ConfigWarning warning) Formatted string representation of a warning.
boolean	isModifiedPowerUserSetting(java.lang.String path) INTERNAL API
static void	main(java.lang.String[] args) Main method to run the ConfigChecker as a java program.
scala.collection.immutable.Set<java.lang.String>	powerUserSettings()
scala.collection.immutable.Set<java.lang.String>	powerUserWildcardSettings()
static void	reportIssues(akka.actor.ExtendedActorSystem system) Validates the configuration of the given actor system.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConfigChecker

public ConfigChecker(akka.actor.ExtendedActorSystem system,
                     com.typesafe.config.Config config,
                     com.typesafe.config.Config reference)

ConfigChecker

public ConfigChecker(akka.actor.ExtendedActorSystem system)

Method Detail

main

public static void main(java.lang.String[] args)

Main method to run the ConfigChecker as a java program. The configuration is loaded by the Lightbend Config library, i.e. "application.conf" if you don't specify another file with for example -Dconfig.file. See https://github.com/typesafehub/config for details of how to specify configuration location.

Potential configuration issues, if any, are printed to System.out and the JVM is exited with -1 status code.

If no configuration issues are found the message "No configuration issues found" is printed to System.out and the JVM is exited with 0 status code.

Use [#reportIssues] if you don't want to exit the JVM.

Parameters:

args - (undocumented)

reportIssues

public static void reportIssues(akka.actor.ExtendedActorSystem system)

Validates the configuration of the given actor system. This is performed when the actor system is started.

Parameters:

system - (undocumented)

format

public static java.lang.String format(ConfigChecker.ConfigWarning warning)

Formatted string representation of a warning.

Parameters:

warning - (undocumented)

Returns:

(undocumented)

powerUserSettings

public scala.collection.immutable.Set<java.lang.String> powerUserSettings()

powerUserWildcardSettings

public scala.collection.immutable.Set<java.lang.String> powerUserWildcardSettings()

check

public ConfigChecker.ValidationResults check()

Run all checks. No side effects, such as logging.

Returns:

(undocumented)

isModifiedPowerUserSetting

public boolean isModifiedPowerUserSetting(java.lang.String path)

INTERNAL API

Parameters:

path - (undocumented)

Returns:

(undocumented)

findDispatchers

public scala.collection.immutable.Map<java.lang.String,com.typesafe.config.Config> findDispatchers()

INTERNAL API

Returns:

(undocumented)