ru.vyarus.dropwizard.guice.module.context.debug

Class DiagnosticBundle

java.lang.Object

ru.vyarus.dropwizard.guice.module.context.debug.DiagnosticBundle

All Implemented Interfaces:

GuiceyBundle

public class DiagnosticBundle
extends java.lang.Object
implements GuiceyBundle

Bundle prints detailed configuration info and startup metrics.

Sections:

• startup stats - collected timers and counters showing how much time were spent on different stages
• options - used options
• diagnostic section - summary of installed bundles, modules, used installers and extensions (showing execution order). Shows what was configured.
• context tree - tree showing configuration hierarchy (configuration sources). Shows from where configuration parts come from.

Reporting is highly configurable. Default configuration shows most valuable (but not all possible) info. To create bundle with custom configuration use builder:

      DiagnosticBundle.builder()
          .printStartupStats(true)
          .printConfiguration(new DiagnosticConfig().printAll())
          .build();
 

Actual diagnostic rendering is performed by DiagnosticRenderer, ContextTreeRenderer, OptionsRenderer and StatsRenderer. They may be used directly, for example, to show report on web page.

Reporting is performed after context startup (pure guicey context (in tests) or entire web context) and so does not affect collected statistics.

Since:

21.06.2016

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DiagnosticBundle.Builder Diagnostic bundle builder.
static class	DiagnosticBundle.DiagnosticModule Guicey configuration diagnostic module.

Constructor Summary

Constructors

Constructor and Description
DiagnosticBundle() Initialize bundle with default diagnostic configuration.

Method Summary

Modifier and Type	Method and Description
static DiagnosticBundle.Builder	builder()
void	initialize(GuiceyBootstrap bootstrap) Called in run phase.

Methods inherited from class java.lang.Object

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

Constructor Detail

DiagnosticBundle

public DiagnosticBundle()

Initialize bundle with default diagnostic configuration. Configures most commonly required info. Suitable for bundle usage with lookup mechanism.

Method Detail

initialize

public void initialize(GuiceyBootstrap bootstrap)

Description copied from interface: GuiceyBundle

Called in run phase. GuiceyBootstrap contains almost the same methods as GuiceBundle.Builder, which allows to register installers, extensions and guice modules. Existing installer could be replaced by disabling old one and registering new.

WARNING: don't assume that this method will be called before or after dropwizard bundle run method (both possible). If configuration or environment objects required, they may be obtained from bootstrap.

Specified by:

initialize in interface GuiceyBundle

Parameters:

bootstrap - guicey bootstrap object

builder

public static DiagnosticBundle.Builder builder()

Returns:

builder for bundle configuration