Skip to content

Commit

Permalink
WELD-1997 Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mkouba authored and jharting committed Aug 21, 2015
1 parent 4898ee9 commit 2edbcfe
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 8 deletions.
1 change: 1 addition & 0 deletions docs/reference/src/main/asciidoc/configure.asciidoc
Expand Up @@ -167,6 +167,7 @@ Some features of the <<devmode,development mode>> may have negative impact on th
|`org.jboss.weld.probe.invocationMonitor.skipJavaBeanProperties`|<<probe,Probe>>|'true' |If set to `true`, the JavaBean accessor methods are not monitored.
|`org.jboss.weld.probe.eventMonitor.excludeType`|<<probe,Probe>>|'' |A regular expression. If a non-empty string and the runtime class of the event object matches this pattern the event is excluded from monitoring.
|`org.jboss.weld.probe.embedInfoSnippet`|<<probe,Probe>>|'true' | If set to `true` an informative HTML snippet will be added to every HTTP response with Content-Type of value `text/html`.
|`org.jboss.weld.probe.jmxSupport`|<<probe,Probe>>|'false' | If set to `true` one or more MBean components may be registered so that it's possible to use JMX to access the Probe development tool data.
|=======================================================================

TIP: To disable the monitoring entirely set `org.jboss.weld.probe.invocationMonitor.excludeType` and `org.jboss.weld.probe.eventMonitor.excludeType` properties to `.*`.
Expand Down
30 changes: 22 additions & 8 deletions docs/reference/src/main/asciidoc/developmentmode.asciidoc
Expand Up @@ -10,7 +10,9 @@ WARNING: Not all environments and containers may support the development mode an
[[devmode-enable]]
=== How to enable the development mode

Set the Servlet initialization parameter `org.jboss.weld.development` to `true`:
==== Web application

For a web application, set the Servlet initialization parameter `org.jboss.weld.development` to `true`:

[source.XML, xml]
-----------------------------------------------------------------------------------------------------------
Expand All @@ -26,26 +28,38 @@ xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/
</web-app>
-----------------------------------------------------------------------------------------------------------

You should see the following log message when deploying your application:
NOTE: An integrator is allowed to specify an alternative way of enabling the development mode.

==== Weld SE

For a Java SE application, set the system property `org.jboss.weld.development` to `true`:

-----------------------------------------------------------------------------------------------------------
=====================================
java -cp myCoolApp.jar -Dorg.jboss.weld.development=true com.foo.MyMain
-----------------------------------------------------------------------------------------------------------

Weld Development Mode: ENABLED
==== Is The Development Mode Enabled?

You should see the following log message during initialization of your application:

-----------------------------------------------------------------------------------------------------------
=====================================
Weld Development Mode: ENABLED
=====================================
-----------------------------------------------------------------------------------------------------------

NOTE: An integrator is allowed to specify an alternative way of enabling the development mode.

[[devtools]]
=== Development Tools

[[probe]]
==== Probe

This tool allows to inspect the application CDI components at runtime. See also the http://probe-weld.itos.redhat.com/weld-numberguess/weld-probe[demo application hosted on OpenShift]. Currently, this tool is only available in a web application. JSON data are available through the REST API. However, a default HTML client (single-page application) is also available at `{webappContextPath}/weld-probe`, e.g. `http://localhost:8080/weld-numberguess/weld-probe`.
This tool allows to inspect the application CDI components at runtime. See also the http://probe-weld.itos.redhat.com/weld-numberguess/weld-probe[demo application hosted on OpenShift].

JSON data are available through the REST API, eventually (if <<config-dev-mode,JMX support is enabled>>) through the MXBean of name `org.jboss.weld.probe:type=JsonData,context=ID` where ID should be replaced with an idenfitier of an application.

However, a default UI - HTML client (single-page application) is only available in a web application at `{webappContextPath}/weld-probe`, e.g. `http://localhost:8080/weld-numberguess/weld-probe`.

Right now, the integration is provided for WildFly (unofficial patch), Tomcat and Jetty (Weld Servlet).
Right now, the integration is provided for WildFly (unofficial patch), Tomcat and Jetty (Weld Servlet) and Weld SE.

TIP: There are some configuration properties which allow to tune or disable Probe features, e.g. to limit the set of components which will be monitored. See also <<config-dev-mode>>.

0 comments on commit 2edbcfe

Please sign in to comment.