Petals Documentation > Petals ESB > Petals Components > Components User Guide > Petals-BC-SQL > Petals-BC-SQL 1.9.0+

Petals-BC-SQL 1.9.0+

  • This version must be installed on [Petals ESB 5.4.0]+,
  • and, JDBC drivers must be compliant with JDBC 4.1.

Extract and insert data from/to databases (Provides mode)

Usage

The component comes with default local operation names defined in an abstract WSDL. You might import this abstract WSDL in your final WSDL when designing your SU.
Any result is returned in the OUT message by a dedicated thread while the response message is sent back by the message processing thread (piped streaming mechanism), to increase performance.
Table of contents
Contributors
No contributors found for: authors on selected page(s)

Select Operation

MEP supported : InOut
When the select operation is set on the incoming exchange, the component performs the SQL SELECT statement(s) defined in the sql element of the IN message. The OUT message returned contains the SQL Result Set.

If you want to get meta-data (name of a column, type of a column, index of a row) in the response, you must activate the meta-data feature. This feature can be set at the Service definition, in the SU, or at runtime, by setting a property 'metadata' to true in the IN message.

Example of a IN message :

   <sql xmlns="http://petals.ow2.org/components/sql/version-1">SELECT name, firstname FROM user WHERE id='123'</sql>

Example of an OUT message returning the content of the SQL Result Set in a XML representation.

<result xmlns="http://petals.ow2.org/components/sql/version-1">
  <row index="1">
    <column name="name" type="varchar">Field</column>
    <column name="firstname" type="varchar">Jean</column>
  </row>
  <row index="2">
    <column name="name" type="varchar">Foo</column>
    <column name="firstname" type="varchar">John</column>
  </row>
</result>

Insert Operation

MEP supported : InOnly
When the insert operation is set on the incoming exchange, the component performs the SQL INSERT statement(s) defined in the sql element of the IN message.
Example of a IN message :

  <sql xmlns="http://petals.ow2.org/components/sql/version-1">insert into user values('toto','toto')</sql>

Delete Operation

MEP supported : InOnly
When the delete operation is set on the incoming exchange, the component performs the SQL DELETE statement(s) defined in the sql element of the IN message.
Example of a IN message :

  <sql xmlns="http://petals.ow2.org/components/sql/version-1">delete from user where name='toto2'</sql>

Update Operation

MEP supported : InOnly
When the delete operation is set on the incoming exchange, the component performs the SQL UPDATE statement(s) defined in the sql element of the IN message.
Example of a IN message :

  <sql xmlns="http://petals.ow2.org/components/sql/version-1">update user set firstname='toto3' where name='toto2'</sql>

InsertWithResponse Operation

MEP supported : InOut
When the insertWithResponse operation is set on the incoming exchange, the component performs the SQL INSERT statement(s) defined in the sql element of the IN message.
The OUT message returned contains the number of row that has been inserted by the statement(s).
Example of a IN message :

  <sql xmlns="http://petals.ow2.org/components/sql/version-1">insert into user values('toto','toto')</sql>

Example of a OUT message returning the number of inserted row :

  <updated xmlns="http://petals.ow2.org/components/sql/version-1">1</updated>

DeleteWithResponse Operation

MEP supported : InOut
When the deleteWithResponse operation is set on the incoming exchange, the component performs the SQL DELETE statement(s) defined in the sql element of the IN message.
The OUT message returned contains the number of row that has been deleted by the statement(s).
Example of a IN message :

  <sql xmlns="http://petals.ow2.org/components/sql/version-1">delete from user where name!='test'</sql>

Example of a OUT message returning the number of deleted row :

  <updated xmlns="http://petals.ow2.org/components/sql/version-1">3</updated>

UpdateWithResponse Operation

MEP supported : InOut
When the updateWithResponse operation is set on the incoming exchange, the component performs the SQL UPDATE statement(s) defined in the sql element of the IN message.
The OUT message returned contains the number of row that has been updated by the statement(s).
Example of a IN message :

  <sql xmlns="http://petals.ow2.org/components/sql/version-1">update user set firstname='toto3' where name='toto2'</sql>

Example of a OUT message returning the number of updated row :

  <updated xmlns="http://petals.ow2.org/components/sql/version-1">1</updated>

StoredProcedure Operation

MEP supported : InOut
Before using this operation, it is possible to register the target stored procedure, defined in the SU, during the deployment of this latter.
If the stored procedure has been registered, it will be unregistered at the undeployment of the SU.

If the stored procedure already exits, the signature of the stored procedure must be defined in the SU.

When the storedProcedure operation is set on the incoming exchange, the component extracts the list of IN or/and INOUT parameter(s) set in the request. Then, it performs the stored procedure.
The OUT message contains the list of INOUT or/and OUT parameter(s) returned by the stored procedure, in a raw form.
Example of a IN message :

  <storedProcedure xmlns="http://petals.ow2.org/components/sql/version-1">
    <parameter rank="1">toto</parameter>
    <parameter rank="2">3</parameter>
    <parameter rank="3">2008-03-28</parameter>
  </storedProcedure>

Example of a OUT message containing INOUT or/and OUT parameter(s) :

  <storedProcedure xmlns="http://petals.ow2.org/components/sql/version-1">2:INOUT:5;4:OUT:true</storedProcedure>

XMLStoredProcedure Operation

MEP supported : InOut
Before using this operation, it is possible to register the target stored procedure, defined in the SU, during the deployment of this latter.
If the stored procedure has been registered, it will be unregistered at the undeployment of the SU.

If the stored procedure already exits, the signature of the stored procedure must be defined in the SU.

When the storedProcedure operation is set on the incoming exchange, the component extracts the list of IN or/and INOUT parameter(s) set in the request. Then, it performs the stored procedure.
The OUT message contains the list of INOUT or/and OUT parameter(s) returned by the stored procedure, in a XML structured form.
Example of a IN message :

  <storedProcedure xmlns="http://petals.ow2.org/components/sql/version-1">
    <parameter rank="1">toto</parameter>
    <parameter rank="2">3</parameter>
    <parameter rank="3">2008-03-28</parameter>
  </storedProcedure>

Example of a OUT message containing INOUT or/and OUT parameter(s) :

  <storedProcedure xmlns="http://petals.ow2.org/components/sql/version-1">
    <parameter rank="2">5</parameter>
    <parameter rank="4">true</parameter>
  </storedProcedure>

Service Unit Configuration

All needed information must be defined in the service-unit JBI descriptor. This JBI descriptor is configured through parameters divided in following groups:

  • JBI parameters that defines the service provider identification,
  • CDK parameters that are parameters driving the service provider implementation at CDK layer,
  • CDK interceptor parameters that are parameters driving interceptors at CDK layer,
  • Dedicated parameters that are parameters driving the service provider implementation at component layer.

Placeholder

A placeholder is a specific value that is resolved at runtime against a property available in the property file set at component level. It is mainly used in the service unit JBI descriptor to be able to configure your service providers and/or your service consumers.

<service-unit-parameter>${dgfip.quotient-familial.base-url}</service-unit-parameter>

Its syntax is: '${placeholder-name[:default-value]}',

  • if no property with name 'placeholder-name' exists in the component property file, the default value 'default-value' is used. If no default value is defined, the literal value '${placeholder-name}' is used,
  • if a placeholder name must contain the character ':' (colon), it must be escaped by the character '\', example: ${placeholder-name-with-\:-colon:default-value}',
  • if a placeholder default value must contain the character ':' (colon), it must be escaped by the character '\', example: ${placeholder-name:default-value-with-\:-colon}'.
  • the escape character can be escaped by itself.

Placeholders are not supported for each service unit parameter, check your documentation before to use them.
It is also possible to change a placeholder value at runtime reloading the component property file. It is not sufficient, the parameter associated to the placeholder must be changeable at runtime. So check component documentation to know that.

CDK parameters defining service provider implementation

The following parameters correspond to the CDK configuration of the service provider implementation.

The service provider is defined into the section 'provides' of the JBI descriptor, containing:

Parameter
Description
Default
Required
Support placeholders
interface-name
 Interface name of the service provider. Must match the one defined in the WSDL.
-
Yes
No
service-name
 Service name of the service provider. Must match the one defined in the WSDL.
-
Yes
No
endpoint-name
 Endpoint name of the service provider. Must match the one defined in the WSDL. The value 'autogenerate' will force Petals ESB to generate an endpoint name as UUID at deployment time.
-
Yes
No
timeout
 Timeout in milliseconds of a synchronous send. This parameter is used by the method sendSync(Exchange exchange) proposes by the CDK Listeners classes.
Set it to 0 for an infinite timeout.
30000
No
Yes
su-interceptors
 Service unit interceptor configuration. See Service unit interceptor configuration.
-
No
No
exchange-properties
 This sections defines the list of properties to set to the JBI exchange when processing a service.
-
No
No
message-properties
 This sections defines the list of properties to set to the JBI message when processing a service.
-
No
No
validate-wsdl
 Activate the validation of the WSDL when deploying a service unit.
true
No
No
forward-security-subject
 Defines if the security subject will be forwarded from IN message to OUT message.
false
No
No
forward-message-properties
 Defines if the message properties will be forwarded from IN message to OUT message.
false
No
No
forward-attachments
 Defines if attachment will be forwarded from IN message to OUT message.
false
No
No
activate-flow-tracing
 Enable ('true') or disable ('false') the flow tracing for this service provider. This value overrides the value defined at component level and can be overridden at incoming exchange level.
Value defined at component
No
Yes
wsdl
 Path to the WSDL document describing services and operations exposed by the provided JBI endpoints defined in the SU.
The value of this parameter is :
  • an URL
  • a file relative to the root of the SU package
    If not specified, a basic WSDL description is automatically provided by the CDK.
-
Yes
No

CDK parameters driving interceptors

The following parameters drive interceptors at CDK layer.

Interceptors can be defined to inject some post or pre-processing in the service provider processing or service consumer processing.

Using interceptor is very sensitive and must be manipulated only by power users. A non properly coded interceptor engaged in a component can lead to uncontrolled behaviors, out of the standard process.

Example of an interceptor configuration:

<?xml version="1.0" encoding="UTF-8"?>
<jbi:jbi xmlns:jbi="http://java.sun.com/xml/ns/jbi" xmlns:petalsCDK="http://petals.ow2.org/components/extensions/version-5">
   <jbi:services>
      <jbi:provides|consumes>
         <!--...-->
         <petalsCDK:su-interceptors>
            <petalsCDK:send>
               <petalsCDK:interceptor name="myInterceptorName">
                  <petalsCDK:param name="myParamName">myParamValue</petalsCDK:param>
                  <petalsCDK:param name="myParamName2">myParamValue2</petalsCDK:param>
               </petalsCDK:interceptor>
            </petalsCDK:send>
            <petalsCDK:accept>
               <petalsCDK:interceptor name="myInterceptorName">
                  <petalsCDK:param name="myParamName">myParamValue</petalsCDK:param>
               </petalsCDK:interceptor>
            </petalsCDK:accept>
            <petalsCDK:send-response>
               <petalsCDK:Interceptor name="myInterceptorName">
                  <petalsCDK:param name="myParamName">myParamValue</petalsCDK:param>
               </petalsCDK:Interceptor>
            </petalsCDK:send-response>
            <petalsCDK:accept-response>
               <petalsCDK:Interceptor name="myInterceptorName">
                  <petalsCDK:param name="myParamName">myParamValue</petalsCDK:param>
               </petalsCDK:Interceptor>
            </petalsCDK:accept-response>
         </petalsCDK:su-interceptors>
         <!--...-->
      </jbi:provides|consumes>
      <!--...-->
   </jbi:services>
</jbi:jbi>

Interceptors configuration for SU (CDK)

Parameter Description Default Required
send Interceptor dedicated to send phase, for an exchange sent by a consumer - No
accept Interceptor dedicated to receive phase, for an exchange received by a provider - No
send-response Interceptor dedicated to send phase, for an exchange (a response) received by a consumer - No
accept-response Interceptor dedicated to receive phase, for an exchange sent (a response) by a provider - No
interceptor - name Logical name of the interceptor instance defined at component level, see CDK Component Interceptor configuration. - Yes
param[] - name The name of the parameter to use for the interceptor for this SU - No
param[] The value of the parameter to use for the interceptor for this SU - No

Dedicated configuration

The following parameters correspond to the component specific configuration of the service provider implementation.

Parameter
Description
Default
Required
Support placeholders
url The JDBC URL of the target database
-
Yes
Yes
driver The JDBC Driver class name. The JDBC library must be accessible via a JBI Shared Library.
If not set, the driver is automatically resolved for: mysql, oracle, hsql, sqlserver, derby, postgresql, db2, sybase, sqlite.
automatic
No
Yes
user The database user.
-
Yes
Yes
password The database password.
-
Yes
Yes
maxActive The maximum number of active connections that can be allocated from the database connection pool at the same time.
Negative for no limit.
8
No
Yes
maxIdle The maximum number of connections that can remain idle in the database connection pool, without extra ones being released.
Negative for no limit.
8
No
Yes
minIdle The minimum number of connections that can remain idle in the the database connection pool, without extra ones being created.
Zero to create none.
0
No
Yes
maxWait The maximum amount of milliseconds that the pool will wait for a connection to be returned before throwing an exception (when there are no available connections).
-1 to wait indefinitely.
-1
No
Yes
timeBetweenEvictionRunsMillis The number of milliseconds to sleep between runs of the idle object evictor thread.
When non-positive, no idle object evictor thread will be run.
-1
No
Yes
metadata If true, when the 'select' operation is used, the response contains metadata on result elements(Row type,index...).
false
No
No
storeProcedure Define the stored procedure that you want to register at the deployment of the SU and the unregister at the undeployment. The database user must have the proper rights to register this procedure.
-
No
No
storedProcedureSignature Define the stored procedure signature that you want to invoke with this SU.
-
No
No
ctrl-characters-replacement A flag to enable the replacement of control characters (Unicode: 0x01 to 0x1f except whitespace 0x09, 0x0a, 0x0d) existing in data returned by database, to return a valid XML response.
false
No
No

Service unit content

The service unit has to contain the following elements, packaged in the archive:

  • the META-INF/jbi.xml descriptor file as described above,
  • it is also highly recommended to provide a WSDL description for service provider embedded in the service-unit. The service provider contract must implement the interface "{http://petals.ow2.org/components/sql/version-1}SQLInterface" defined in the abstract WSDL 'SQLInterface.wsdl' available as resource in the component archive.
service-unit.zip
  + META-INF
    - jbi.xml (as defined above)
  - service.wsdl (recommended)

Example

An example of a Service Unit descriptor to provide an SQL service:

<jbi:jbi version="1.0"
         xmlns:interfaceNs="http://petals.ow2.org/components/sql/version-1"
         xmlns:serviceNs="http://test"

         xmlns:sql="http://petals.ow2.org/components/sql/version-1"
         xmlns:petalsCDK="http://petals.ow2.org/components/extensions/version-5"
         xmlns:jbi="http://java.sun.com/xml/ns/jbi"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

   <jbi:services binding-component="true">
      <jbi:provides
              interface-name="interfaceNs:SQLInterface"
              service-name="serviceNs:MyDatabaseSQLService"
              endpoint-name="MyDatabaseSQLServiceEndpoint">
         <petalsCDK:wsdl>SQLService.wsdl</petalsCDK:wsdl>

         <sql:url>jdbc:mysql://host_name:port/dbname</sql:url>
         <sql:user>test</sql:user>
         <sql:password>test</sql:password>
         <sql:maxActive>8</sql:maxActive>
         <sql:maxIdle>8</sql:maxIdle>
         <sql:minIdle>0</sql:minIdle>
         <sql:maxWait>-1</sql:maxWait>
         <sql:timeBetweenEvictionRunsMillis>-1</sql:timeBetweenEvictionRunsMillis>
         <sql:metadata>true</sql:metadata>
      </jbi:provides>
   </jbi:services>
</jbi:jbi>

Configuring the component

The component can be configured through the parameters of its JBI descriptor file. These parameters are divided in following groups:

  • JBI parameters that have not to be changed otherwise the component will not work,
  • CDK parameters that are parameters driving the processing of the CDK layer,
  • Dedicated parameters that are parameters specific to this component.
Caution: The component requires the right JDBC Shared Libraries to communicate with your databases. Please install first valid Shared Libraries containing your database JDBC drivers. Then you can configure your component by using PETALS Maven plugin with the goal jbi:configure or the PETALS Ant task petals-configure-component.

CDK parameters

The component configuration includes the configuration of the CDK. The following parameters correspond to the CDK configuration.

Parameter Description Default Scope*
acceptor-pool-size The size of the thread pool used to accept Message Exchanges from the NMR. Once a message is accepted, its processing is delegated to the processor pool thread. 1
 Runtime
acceptor-retry-number Number of tries to submit a message exchange to a processor for processing before to declare that it cannot be processed. 40
 Installation
acceptor-retry-wait Base duration, in milliseconds, to wait between two processing submission tries. At each try, the new duration is the previous one plus this base duration. 250
 Installation
acceptor-stop-max-wait The max duration (in milliseconds) before, on component stop, each acceptor is stopped by force. 500
 Runtime
processor-pool-size The size of the thread pool used to process Message Exchanges. Once a message is accepted, its processing is delegated to one of the thread of this pool. 10 Runtime
processor-max-pool-size The maximum size of the thread pool used to process Message Exchanges. The difference between this size and the processor-pool-size represents the dynamic threads that can be created and destroyed during overhead processing time.
50
 Runtime
processor-keep-alive-time When the number of processors is greater than the core, this is the maximum time that excess idle processors will wait for new tasks before terminating, in seconds.
300
 Runtime
processor-stop-max-wait The max duration (in milliseconds) of message exchange processing on stop phase (for all processors).
 15000
 Runtime
time-beetween-async-cleaner-runs The time (in milliseconds) between two runs of the asynchronous message exchange cleaner.
 2000
 Installation
properties-file Name of the file containing properties used as reference by other parameters. Parameters reference the property name using a placeholder in the following pattern ${myPropertyName}. At runtime, the expression is replaced by the value of the property.

The properties file can be reloaded using the JMX API of the component. The runtime configuration MBean provides an operation to reload these place holders. Check the service unit parameters that support this reloading.

The value of this parameter is :
  • an URL
  • a file relative to the PEtALS installation path
  • an absolute file path
  • an empty value to stipulate a non-using file.
 - Installation
monitoring-sampling-period Period, in seconds, of a sample used by response time probes of the monitoring feature. 300 Installation
activate-flow-tracing Enable ('true') or disable ('false') the flow tracing. This value can be overridden at service consumer or service provider level, or at exchange level. true Runtime
propagate-flow-tracing-activation Control whether the flow tracing activation state must be propagated to next flow steps or not. If 'true', the flow tracing activation state is propagated. This value can be overridden at service consumer level. true Runtime
component-interceptors Component interceptor configuration. See CDK Component interceptor configuration. - See Maven Petals plugin to known how to inject component interceptor configuration in component configuration

* Definition of CDK parameter scopes:

  • Installation: The parameter can be set during the installation of the component, by using the installation MBean (see JBI specifications for details about the installation sequence). If the parameter is optional and has not been defined during the development of the component, it is not available at installation time.
  • Runtime: The paramater can be set during the installation of the component and during runtime. The runtime configuration can be changed using the CDK custom MBean named RuntimeConfiguration. If the parameter is optional and has not been defined during the development of the component, it is not available at installation and runtime times.

Interception configuration

Interceptors can be defined to inject some post or pre-processing in the component during service processing.

Using interceptor is very sensitive and must be manipulated only by power users. A non properly coded interceptor engaged in a component can lead to uncontrolled behaviors, out of the standard process.

Example of an interceptor configuration:

<?xml version="1.0" encoding="UTF-8"?>
<jbi:jbi xmlns:jbi="http://java.sun.com/xml/ns/jbi" xmlns:petalsCDK="http://petals.ow2.org/components/extensions/version-5" ...>
   <jbi:component>
      <!--...-->
      <petalsCDK:component-interceptors>
         <petalsCDK:interceptor active="true" class="org.ow2.petals.myInterceptor" name="myInterceptorName">
            <petalsCDK:param name="myParamName">myParamValue</petalsCDK:param>
            <petalsCDK:param name="myParamName2">myParamValue2</petalsCDK:param>
         </petalsCDK:interceptor>
      </petalsCDK:component-interceptors>
      <!--...-->
   </jbi:component>
</jbi:jbi>

Interceptors configuration for Component (CDK)

Parameter Description Default Required
interceptor - class Name of the interceptor class to implement. This class must extend the abstract class org.ow2.petals.component.common.interceptor.Interceptor. This class must be loadable from the component classloader, or in a dependent Shared Library classloader. - Yes
interceptor - name Logical name of the interceptor instance. It is referenced at service unit level to register this interceptor for services of the service unit. See SU Interceptor configuration. - Yes
interceptor - active If true, the Interceptor instance is activated for every SU deployed on the component.
If false, the Interceptor can be activated:
-by the InterceptorManager Mbean at runtime, to activate the interceptor for every deployed SU.
-by a SU configuration 		- Yes
param[] - name The name of the parameter to use for the interceptor. - No
param[] The value of the parameter to use for the interceptor. - No

Dedicated configuration

No dedicated configuration parameter is available.

Business monitoring

MONIT traces

Each service provider exposed in Petals ESB is able to log MONIT traces with following information:

  • on service provider invocation, when receiving an incoming request, with following attributes:
    • traceCode set to provideFlowStepBegin,
    • flowInstanceId set to the flow instance identifier retrieved from the incoming request,
    • flowStepId set to an UUID value,
    • flowStepInterfaceName set to the service provider interface name,
    • flowStepServiceName set to the service provider service name,
    • flowStepOperationName set to the operation of the invoked service provider,
    • flowStepEndpointName set to the service provider endpoint name,
    • flowPreviousStepId set to the step identifier of the previous step, retrieved from the incoming request.
  • on external service provider invocation, when sending a request to the external service provider, with following attributes:
    • traceCode set to provideExtFlowStepBegin,
    • flowInstanceId set to the flow instance identifier retrieved from the incoming request,
    • flowStepId set to an UUID value,
    • flowPreviousStepId set to the step identifier of the previous step that is the internal processing of the incoming request into the BC.
  • on external service provider termination, when receiving the outgoing response of the external service provider, with following attributes:
    • traceCode set to provideExtFlowStepEnd or provideExtFlowStepFailure,
    • flowInstanceId set to the flow instance identifier retrieved from the incoming request,
    • flowStepId set to the flow step identifier defined for the external service provider invocation.
  • on service provider termination, when returning the outgoing response, with following attributes:
    • traceCode set to provideFlowStepEnd or provideFlowStepFailure,
    • flowInstanceId set to the flow instance identifier retrieved from the incoming request,
    • flowStepId set to the flow step identifier defined on incoming request receipt.

Flow tracing activation

The flow tracing (ie. MONIT traces generation) is defined according to the property 'org.ow2.petals.monitoring.business.activate-flow-tracing' of the incoming request. If the property does not exist, the parameter activate-flow-tracing of the service provider definition will be inspected. If no parameter is defined at service provider level, the component configuration parameter 'activate-flow-tracing' is used. Finally, by default, the flow tracing is enabled.

Monitoring the component

Using metrics

Several probes providing metrics are included in the component, and are available through the JMX MBean 'org.ow2.petals:type=custom,name=monitoring_<component-id>', where <component-id> is the unique JBI identifier of the component.

Common metrics

The following metrics are provided through the Petals CDK, and are common to all components:

Metrics, as MBean attribute Description Detail of the value Configurable
MessageExchangeAcceptorThreadPoolMaxSize The maximum number of threads of the message exchange acceptor thread pool integer value, since the last startup of the component yes, through acceptor-pool-size
MessageExchangeAcceptorThreadPoolCurrentSize The current number of threads of the message exchange acceptor thread pool. Should be always equals to MessageExchangeAcceptorThreadPoolMaxSize. instant integer value no
MessageExchangeAcceptorCurrentWorking The current number of working message exchange acceptors. instant long value no
MessageExchangeAcceptorMaxWorking The max number of working message exchange acceptors. long value, since the last startup of the component no
MessageExchangeAcceptorAbsoluteDurations The aggregated durations of the working message exchange acceptors since the last startup of the component. n-tuple value containing, in nanosecond:
  • the maximum duration,
  • the average duration,
  • the minimum duration.
 no
MessageExchangeAcceptorRelativeDurations The aggregated durations of the working message exchange acceptors on the last sample. n-tuple value containing, in nanosecond:
  • the maximum duration,
  • the average duration,
  • the minimum duration,
  • the 10-percentile duration (10% of the durations are lesser than this value),
  • the 50-percentile duration (50% of the durations are lesser than this value),
  • the 90-percentile duration (90% of the durations are upper than this value).
 no
MessageExchangeProcessorAbsoluteDurations The aggregated durations of the working message exchange processor since the last startup of the component. n-tuple value containing, in milliseconds:
  • the maximum duration,
  • the average duration,
  • the minimum duration.
 no
MessageExchangeProcessorRelativeDurations The aggregated durations of the working message exchange processor on the last sample. n-tuple value containing, in milliseconds:
  • the maximum duration,
  • the average duration,
  • the minimum duration,
  • the 10-percentile duration (10% of the durations are lesser than this value),
  • the 50-percentile duration (50% of the durations are lesser than this value),
  • the 90-percentile duration (90% of the durations are upper than this value).
 no
MessageExchangeProcessorThreadPoolActiveThreadsCurrent The current number of active threads of the message exchange processor thread pool instant integer value no
MessageExchangeProcessorThreadPoolActiveThreadsMax The maximum number of threads of the message exchange processor thread pool that was active integer value, since the last startup of the component no
MessageExchangeProcessorThreadPoolIdleThreadsCurrent The current number of idle threads of the message exchange processor thread pool instant integer value no
MessageExchangeProcessorThreadPoolIdleThreadsMax The maximum number of threads of the message exchange processor thread pool that was idle integer value, since the last startup of the component no
MessageExchangeProcessorThreadPoolMaxSize The maximum size, in threads, of the message exchange processor thread pool instant integer value yes, through http-thread-pool-size-max
MessageExchangeProcessorThreadPoolMinSize The minimum size, in threads, of the message exchange processor thread pool instant integer value yes, through http-thread-pool-size-min
MessageExchangeProcessorThreadPoolQueuedRequestsCurrent The current number of enqueued requests waiting to be processed by the message exchange processor thread pool instant integer value no
MessageExchangeProcessorThreadPoolQueuedRequestsMax The maximum number of enqueued requests waiting to be processed by the message exchange processor thread pool since the last startup of the component instant integer value no
ServiceProviderInvocations The number of service provider invocations grouped by:
  • interface name, as QName, the invoked service provider,
  • service name, as QName, the invoked service provider,
  • invoked operation, as QName,
  • message exchange pattern,
  • and execution status (PENDING, ERROR, FAULT, SUCCEEDED).
 integer counter value since the last startup of the component no
ServiceProviderInvocationsResponseTimeAbs The aggregated response times of the service provider invocations since the last startup of the component grouped by:
  • interface name, as QName, the invoked service provider,
  • service name, as QName, the invoked service provider,
  • invoked operation, as QName,
  • message exchange pattern,
  • and execution status (PENDING, ERROR, FAULT, SUCCEEDED).
 n-tuple value containing, in millisecond:
  • the maximum response time,
  • the average response time,
  • the minimum response time.
 no
ServiceProviderInvocationsResponseTimeRel The aggregated response times of the service provider invocations on the last sample, grouped by:
  • interface name, as QName, the invoked service provider,
  • service name, as QName, the invoked service provider,
  • invoked operation, as QName,
  • message exchange pattern,
  • and execution status (PENDING, ERROR, FAULT, SUCCEEDED).
 n-tuple value containing, in millisecond:
  • the maximum response time,
  • the average response time,
  • the minimum response time,
  • the 10-percentile response time (10% of the response times are lesser than this value),
  • the 50-percentile response time (50% of the response times are lesser than this value),
  • the 90-percentile response time (90% of the response times are lesser than this value).
 no

Dedicated metrics

No dedicated metric is available.

Receiving alerts

Several alerts are notified by the component through notification of the JMX MBean 'org.ow2.petals:type=custom,name=monitoring_<component-id>', where <component-id> is the unique JBI identifier of the component.

To integrate these alerts with Nagios, see Receiving Petals ESB defects in Nagios.

Common alerts

Defect JMX Notification
A message exchange acceptor thread is dead
  • type: org.ow2.petals.component.framework.process.message.acceptor.pool.thread.dead
  • no user data
No more thread is available in the message exchange acceptor thread pool
  • type: org.ow2.petals.component.framework.process.message.acceptor.pool.exhausted
  • no user data
No more thread is available to run a message exchange processor
  • type: org.ow2.petals.component.framework.process.message.processor.thread.pool.exhausted
  • no user data

Dedicated alerts

No dedicated alert is available.

Labels

petals petals Delete
component component Delete
user user Delete
guide guide Delete
components-bc-family components-bc-family Delete
bc bc Delete
sql sql Delete
1-2-x 1-2-x Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.