diff --git a/akka-docs/java/logging.rst b/akka-docs/java/logging.rst index ffee92d00e..43cad5c0d3 100644 --- a/akka-docs/java/logging.rst +++ b/akka-docs/java/logging.rst @@ -40,6 +40,95 @@ treatment of this case, e.g. in the SLF4J event listener which will then use the string instead of the class’ name for looking up the logger instance to use. +Auxiliary logging options +------------------------- + +Akka has a couple of configuration options for very low level debugging, that makes most sense in +for developers and not for operations. + +This config option is very good if you want to know what config settings are loaded by Akka: + +.. code-block:: ruby + + akka { + # Log the complete configuration at INFO level when the actor system is started. + # This is useful when you are uncertain of what configuration is used. + logConfigOnStart = off + } + +If you want very detailed logging of all automatically received messages that are processed +by Actors: + +.. code-block:: ruby + + akka { + debug { + # enable DEBUG logging of all AutoReceiveMessages (Kill, PoisonPill and the like) + autoreceive = off + } + } + +If you want very detailed logging of all lifecycle changes of Actors (restarts, deaths etc): + +.. code-block:: ruby + + akka { + debug { + # enable DEBUG logging of actor lifecycle changes + lifecycle = off + } + } + +If you want very detailed logging of all events, transitions and timers of FSM Actors that extend LoggingFSM: + +.. code-block:: ruby + + akka { + debug { + # enable DEBUG logging of all LoggingFSMs for events, transitions and timers + fsm = off + } + } + +If you want to monitor subscriptions (subscribe/unsubscribe) on the ActorSystem.eventStream: + +.. code-block:: ruby + + akka { + debug { + # enable DEBUG logging of subscription changes on the eventStream + event-stream = off + } + } + +Auxiliary remote logging options +-------------------------------- + +If you want to see all messages that are sent through remoting at DEBUG log level: +(This is logged as they are sent by the transport layer, not by the Actor) + +.. code-block:: ruby + + akka { + remote { + # If this is "on", Akka will log all outbound messages at DEBUG level, if off then they are not logged + log-sent-messages = off + } + } + +If you want to see all messages that are received through remoting at DEBUG log level: +(This is logged as they are received by the transport layer, not by any Actor) + +.. code-block:: ruby + + akka { + remote { + # If this is "on", Akka will log all inbound messages at DEBUG level, if off then they are not logged + log-received-messages = off + } + } + + Event Handler ============= diff --git a/akka-docs/scala/logging.rst b/akka-docs/scala/logging.rst index debafcedc5..7ed8f4e7d9 100644 --- a/akka-docs/scala/logging.rst +++ b/akka-docs/scala/logging.rst @@ -37,6 +37,107 @@ The source object is translated to a String according to the following rules: The log message may contain argument placeholders ``{}``, which will be substituted if the log level is enabled. +Auxiliary logging options +------------------------- + +Akka has a couple of configuration options for very low level debugging, that makes most sense in +for developers and not for operations. + +This config option is very good if you want to know what config settings are loaded by Akka: + +.. code-block:: ruby + + akka { + # Log the complete configuration at INFO level when the actor system is started. + # This is useful when you are uncertain of what configuration is used. + logConfigOnStart = off + } + +If you want very detailed logging of all user-level messages that are processed +by Actors that use akka.event.LoggingReceive: + +.. code-block:: ruby + + akka { + debug { + # enable function of LoggingReceive, which is to log any received message at + # DEBUG level + receive = off + } + } + +If you want very detailed logging of all automatically received messages that are processed +by Actors: + +.. code-block:: ruby + + akka { + debug { + # enable DEBUG logging of all AutoReceiveMessages (Kill, PoisonPill and the like) + autoreceive = off + } + } + +If you want very detailed logging of all lifecycle changes of Actors (restarts, deaths etc): + +.. code-block:: ruby + + akka { + debug { + # enable DEBUG logging of actor lifecycle changes + lifecycle = off + } + } + +If you want very detailed logging of all events, transitions and timers of FSM Actors that extend LoggingFSM: + +.. code-block:: ruby + + akka { + debug { + # enable DEBUG logging of all LoggingFSMs for events, transitions and timers + fsm = off + } + } + +If you want to monitor subscriptions (subscribe/unsubscribe) on the ActorSystem.eventStream: + +.. code-block:: ruby + + akka { + debug { + # enable DEBUG logging of subscription changes on the eventStream + event-stream = off + } + } + +Auxiliary remote logging options +-------------------------------- + +If you want to see all messages that are sent through remoting at DEBUG log level: +(This is logged as they are sent by the transport layer, not by the Actor) + +.. code-block:: ruby + + akka { + remote { + # If this is "on", Akka will log all outbound messages at DEBUG level, if off then they are not logged + log-sent-messages = off + } + } + +If you want to see all messages that are received through remoting at DEBUG log level: +(This is logged as they are received by the transport layer, not by any Actor) + +.. code-block:: ruby + + akka { + remote { + # If this is "on", Akka will log all inbound messages at DEBUG level, if off then they are not logged + log-received-messages = off + } + } + Translating Log Source to String and Class ------------------------------------------