list-probes

lists events for monitoring GlassFish Server

Synopsis

list-probes [--help] [--details={false|true}] [event-id]

Description

The list-probes subcommand lists events for monitoring GlassFish Server.

To provide statistics to GlassFish Server, components define events for the operations that generate these statistics. At runtime, components send these events when performing the operations for which the events are defined. For example, to enable the number of received requests to be monitored, a component sends a "request received" event each time that the component receives a request.

The list-probes subcommand enables you to identify which events provide the statistics that you want to monitor. Use this information in JavaScript programs that you write for monitoring GlassFish Server.

The list-probes subcommand requires that monitoring is enabled for GlassFish Server. If monitoring for GlassFish Server is disabled, no events are listed. For information about how to enable monitoring for GlassFish Server, see the enable-monitoring(1) help page.

By default, the list-probes subcommand lists the signatures of all events that are defined for all installed components of GlassFish Server. The signatures for events that are related to a container are listed only if the container is loaded.

An event signature consists of the event identifier (ID) followed by a list of the event's parameters in the following format:

event-id(param-type param-name[,param-type param-name]...)

The replaceable items in this format are as follows:

event-id: The event ID, which uniquely identifies the event.
param-type: The type of the event parameter. This type is a Java language primitive, such as int, boolean, or java.lang.String.
param-name: The name of the event parameter.

The format of an event ID is as follows:

module-provider:module:submodule:event

The replaceable items in this format are as follows:

module-provider: Text that identifies the application that is source of the event. For example, for events from Oracle GlassFish Server, module-provider is glassfish.
module: The name of the module for which the event is defined. A module provides significant functionality of GlassFish Server. Examples of module names are web-container, ejb-container, transaction, and webservices.
submodule: The submodule of module for which the event is defined, for example, web-module.
event-type: The type of the event, for example, webModuleStartedEvent.

This subcommand is supported in remote mode only.

Options

--help

-?

Displays the help text for the subcommand.

--details

Specifies whether detailed information about an event is displayed. Possible values are as follows:

false: Detailed information about the events is not displayed (default). Only the event signature of each event is displayed.
true: Detailed information about the events is displayed. If the --details option is set to true, an operand is required. Otherwise, an error occurs.

Operands

event-id: The full event ID of the event that is to be listed. If this operand is specified without the --details option, the signature of the specified event is listed. If this operand is omitted, all events are listed.

Examples

Example 1 Listing All Events

This command lists all events for monitoring GlassFish Server. For better readability, some events that would listed by this example are not shown.

asadmin> list-probes
glassfish:jdbc:connection-pool:connectionRequestDequeuedEvent (java.lang.String 
poolName)
glassfish:jca:connection-pool:connectionsFreedEvent (java.lang.String poolName, 
int count)
glassfish:transaction:transaction-service:deactivated ()
glassfish:kernel:connections-keep-alive:incrementCountFlushesEvent (java.lang.String 
listenerName)
glassfish:kernel:file-cache:countInfoMissEvent (java.lang.String fileCacheName)
glassfish:ejb:timers:timerRemovedEvent ()
glassfish:jdbc:connection-pool:decrementNumConnFreeEvent (java.lang.String poolName)

...
glassfish:kernel:thread-pool:threadAllocatedEvent (java.lang.String monitoringId, 
java.lang.String threadPoolName, java.lang.String threadId)
glassfish:jca:connection-pool:connectionCreatedEvent (java.lang.String poolName)
glassfish:kernel:connection-queue:connectionAcceptedEvent (java.lang.String 
listenerName, int connection)

Command list-probes executed successfully.

Example 2 Displaying Detailed Information About an Event

This example displays detailed information about the glassfish:web:web-module:webModuleStartedEvent

asadmin list-probes --details glassfish:web:web-module:webModuleStartedEvent

Information similar to the following is displayed.

Events       glassfish:web:web-module:webModuleStartedEvent(5GFP)

NAME
     glassfish:web:web-module:webModuleStartedEvent - web  module
     started event

SYNOPSIS
     glassfish:web:web-module:webModuleStartedEvent(
     java.lang.String appName,
     java.lang.String hostName)

DESCRIPTION
     This event is sent whenever an application has been  started
     (for example, as part of its deployment).

PARAMETERS
     appName

         The name of the web application that has been started.

     hostName
         The name of the virtual server on which the  application
         has been deployed.

Java EE 6           Last change: 19 Nov 2009                    1


Command list-probes executed successfully.

Exit Status

0: command executed successfully
1: error in executing the command