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

Definition of CDK parameter scope :

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.

Interceptor

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 manipulate only by power users. An 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"?>
<!--...-->
<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>
<!--...-->

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 can be referenced to add extended parameters by a 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

Component specific parameters

Component configuration, specific parameters part

Parameter	Description	Default	Required
consumer-domains-max-pool-size	Max number of threads used for handling incoming consumer partner connections: while each incoming consumer partner connection handles one exchange at a time, this limits the number of concurrent exchange processing amongst all incoming connection	6	No
provider-domains-max-pool-size	Max number of threads used for handling outgoing provider partner connections: while each outgoing provider partner connection handles one exchange at a time, this limits the number of concurrent exchange processing amongst all outgoing connection	6	No

Logging

The traces of the BPMN 2.0 engine "Activiti" are activated through the logging configuration file of Petals ESB. The root logger for Activiti is org.activiti:

...
org.activiti.level=INFO
org.activiti.engine.impl.level=FINE
...

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.

Wiki

All versions of Petals ESB

Helpful links

Petals-BC-JBI-Gateway 1.0.0

Introduction

CDK parameters