com.lightbend.akka.diagnostics

Class DiagnosticsRecorder

java.lang.Object

com.lightbend.akka.diagnostics.DiagnosticsRecorder

All Implemented Interfaces:

akka.actor.Extension

public class DiagnosticsRecorder
extends java.lang.Object
implements akka.actor.Extension

INTERNAL API: Akka Diagnostics Recorder writes configuration and system information to a file that customers can attach to Lightbend support cases. The information will help us at Lightbend to give you the best possible support.

It will register a MBean in the "akka" name space, which can be accessed from a JMX console such as JConsole. From JMX you can trigger thread dumps that will also be appended to the file.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DiagnosticsRecorder.DiagnosticsRecorderMBean The MBean interface of the Diagnostics Recorder
class	DiagnosticsRecorder.DiagnosticsRecorderMBeanImpl INTERNAL API

Constructor Summary

Constructors

Constructor and Description
DiagnosticsRecorder(akka.actor.ExtendedActorSystem system)

Method Summary

Modifier and Type	Method and Description
com.typesafe.config.Config	applicationConfig(com.typesafe.config.Config config, com.typesafe.config.Config reference) Extract the application specific configuration, i.e.
static T	apply(akka.actor.ActorSystem system)
static DiagnosticsRecorder	createExtension(akka.actor.ExtendedActorSystem system)
java.lang.String	dumpThreads()
static boolean	equals(java.lang.Object other)
java.lang.String	gatherStartupInfo()
static DiagnosticsRecorder	get(akka.actor.ActorSystem system)
static int	hashCode()
static DiagnosticsRecorder$	lookup()
javax.management.ObjectName	mbeanName()
java.lang.String	reportFileName()
void	runCollectThreadDumps(int count) Collect a number of thread dumps with configured interval.
void	runStartupReport() Collect configuration and some system metrics, such as heap settings and write to the diagnostics report file.

Methods inherited from class java.lang.Object

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

Constructor Detail

DiagnosticsRecorder

public DiagnosticsRecorder(akka.actor.ExtendedActorSystem system)

Method Detail

get

public static DiagnosticsRecorder get(akka.actor.ActorSystem system)

lookup

public static DiagnosticsRecorder$ lookup()

createExtension

public static DiagnosticsRecorder createExtension(akka.actor.ExtendedActorSystem system)

apply

public static T apply(akka.actor.ActorSystem system)

hashCode

public static final int hashCode()

equals

public static final boolean equals(java.lang.Object other)

reportFileName

public java.lang.String reportFileName()

mbeanName

public javax.management.ObjectName mbeanName()

runStartupReport

public void runStartupReport()

Collect configuration and some system metrics, such as heap settings and write to the diagnostics report file.

gatherStartupInfo

public java.lang.String gatherStartupInfo()

applicationConfig

public com.typesafe.config.Config applicationConfig(com.typesafe.config.Config config,
                                                    com.typesafe.config.Config reference)

Extract the application specific configuration, i.e. remove things that come from reference.conf

Parameters:

config - (undocumented)

reference - (undocumented)

Returns:

(undocumented)

runCollectThreadDumps

public void runCollectThreadDumps(int count)

Collect a number of thread dumps with configured interval. The thread dumps and some basic metrics such as heap usage are appended to diagnostics report file.

Parameters:

count - (undocumented)

dumpThreads

public java.lang.String dumpThreads()