Petals-BC-Gateway 1.0.1+

This version must be installed on Petals ESB 5.1.0+

Features

The component BC Gateway enables to create secured (encrypted and authenticated) bridges between Petals domains governed by separate entities.
This bridge will mirror a set of endpoints from one domain to another according to a configuration describing which service must be propagated.

See also the documentation for Topologies and Domains to better understand domains.

From the point of view of this BC, one (or several in case of HA) container in each Petals domain will either play the role of provider domain or consumer domain:

  • A provider domain, materialised with Consumes Service Units, propagates services of its domain to a consumer domain that connects to it via one or several links.
  • A consumer domain, materialised with Provides Service Units, connects to a provider domain and create endpoints for the propagated services in its domain.

By default the Gateway BC takes care of reconnecting in case of disconnection, polling for changes in the activated endpoints to keep the consumer domain a mirror of the provider domain and it is possible to rewrite propagated services names in the consumer domain if needed.

By service, we mean one as defined in a WSDL: it is specified by an interface name and a service name.
Thus, endpoints are not propagated as such and if multiple endpoints of a given service are available in the provider domain, then there will be only one activated service in the consumer domain for all these endpoints.

Usually, an interface name characterises a generic functionality while a service name characterises an implementation of that functionality. On the other hand, an endpoint name is simply a technical mean to locate a given instance of this service in the bus.
Full Size
A Gliffy Diagram named: example-multi-domains

Service Units Configuration

In terms of configuration (i.e., definition of Service Units), this results in two different artefacts: Consumes and Provides SUs.
The Consumes SUs (deployed in a provider domains) declares a list of consumer domains that are allowed to connect to them and to which a selection of services (also defined in the Consumes SU) will be propagated.
The Provides SU (deployed in a consumer domain) declares a list of provider domains (usually only one) to which they will connect and propagate services from.

The particularity of the Gateway BC is that, while Consumes SUs explicitly define which are the consumed services that are going to be propagated from their domain, Provides SUs do not have to (but can) define the services that are going to be propagated to their domain: these are inferred based on the services actually propagated by the provider domain.
Furthermore, only the services that are actually activated on the provider domain are actually propagated: in this way, the consumer domain will constantly mirror the current reality of the provider domain.

Component Transport Listeners

Technically, the component onto which the Consumes SUs are deployed must define how to listen to incoming connections (on a host and TCP port currently) from Provides SUs.
These are called transport listeners and can be shared between multiple Consumes SUs if needed (to avoid duplicating open ports) or not (to isolate certain consumer domains).

This version of the component is based on Apache Netty 4.0.36.
Contributors
No contributors found for: authors on selected page(s)

Setting up a simple domain-to-domain propagation

Let's consider two domains A and B.
The number of containers in each of the domain is not important here: we must only select for each one container onto which the Gateway BC and its SU will deployed.

The domain A will act as the provider domain and will thus declare in its SU a set of Consumes as well as information needed to identify the consumer domain.

The domain B will act as the consumer domain and will thus declare in its SU the information needed to connect to the provider domain.

Let's consider that A will propagate several services:

  • One denoted only by its interface name Interface1 (hence it will matches all endpoints of that interface, potentially with different service name and of course with different endpoint names).
  • One denoted by its interface name Interface2 and service name Service2 (hence it will matches all endpoints of that interface and service name).
  • One denoted by its interface name Interface3, service name Service3 and endpoint name endpoint3 (hence it will match exactly one endpoint).

Provider Domain A

For the provider domain, it is necessary to both define a Consumes SU and a transport listener at the component level.

Consumes SU

The Consumes SU deployed on the Domain A is as follow:

<?xml version="1.0" encoding="UTF-8"?>
<jbi:jbi version="1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:jbi="http://java.sun.com/xml/ns/jbi"
   xmlns:cdk="http://petals.ow2.org/components/extensions/version-5" xmlns:g="http://petals.ow2.org/components/petals-bc-gateway/version-1.0"
   xmlns:test="http://test/">

   <jbi:services binding-component="true">

      <jbi:consumes interface-name="test:Interface1">
         
         <!-- CDK specific elements -->
         <cdk:mep xsi:nil="true" />

         <!-- Component specific elements -->
         <g:consumer domain="domainB" />

      </jbi:consumes>

      <jbi:consumes interface-name="test:Interface2" service-name="test:Service2">
         
         <!-- CDK specific elements -->
         <cdk:mep xsi:nil="true" />

         <!-- Component specific elements -->
         <g:consumer domain="domainB" />

      </jbi:consumes>

      <jbi:consumes interface-name="test:Interface3" service-name="test:Service3" endpoint-name="endpoint3">
         
         <!-- CDK specific elements -->
         <cdk:mep xsi:nil="true" />

         <!-- Component specific elements -->
         <g:consumer domain="domainB" />

      </jbi:consumes>

      <g:consumer-domain id="domainB" transport="transport1">
         <g:auth-name>UniquelySharedBetweenA&B</g:auth-name>
      </g:consumer-domain>

   </jbi:services>
</jbi:jbi>

Here we see we chose to use the authentication name UniquelySharedBetweenA&B and the consumer domain will need to know this information.

The authentication name is NOT meant to introduce security in the use of the Gateway BC: for that it is necessary to use SSL!

Component's Transport Listener

As we can see the Consumes SU relies on the existence of a transport called transport1.
By default there is no pre-configured transport listener on the Gateway BC but there is multiple ways to define them statically (see component-configuration below) or dynamically with Petals CLI (see Petals BC Gateway tooling).

For example, we can use the following CLI command to create the transport listener before deploying the Consumes SU:

> bc-gateway.add-transport-listener -i transport1 -p 7500

Here we chose the port 7500 and the consumer domain will need to know this information.

Consumer Domain B

For the consumer domain, it is only necessary to define a Provides SU based on the previously gathered information (authentication name, port) and hostname of the provider domain BC Gateway.
The Provides SU deployed on the Domain B is as follow:

<?xml version="1.0" encoding="UTF-8"?>
<jbi:jbi version="1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:jbi="http://java.sun.com/xml/ns/jbi"
   xmlns:cdk="http://petals.ow2.org/components/extensions/version-5" xmlns:g="http://petals.ow2.org/components/petals-bc-gateway/version-1.0">

   <jbi:services binding-component="true">
      
      <g:provider-domain id="domainA">
         <g:remote-ip>domainA-hostname</g:remote-ip>
         <g:remote-port>7500</g:remote-port>
         <g:remote-auth-name>UniquelySharedBetweenA&B</g:remote-auth-name>
      </g:provider-domain>

   </jbi:services>
</jbi:jbi>

Examples of Service Propagations

If we start with one container for A and one container for B without anything on them and after:

  • deploying the Gateway BC on each of the container of A and B.
  • adding the transport listener on the Gateway BC of A.
  • deploying the Consumes SU on the Gateway BC of A and the Provides SU on the Gateway BC of B.
The order of deployment is not very important as by default, the Provides SU will try to reconnect until it succeeds.

We can see that no endpoints have been deployed on B: this is expected because A will only propagate existing endpoints.

Now if we deploy some endpoints on domain A:

  • InterfaceX:ServiceX:endpointX, then no endpoint will be activated on B.
  • Interface1:Service1a:endpoint1a, then Interface1:Service1a:xxx will be activated on B.
  • Interface1:Service1a:endpoint1a and Interface1:Service1a:endpoint1b, then Interface1:Service1a:xxx will be activated on B.
  • Interface1:Service1a:endpoint1a and Interface1:Service1b:endpoint1b, then Interface1:Service1a:xxx and Interface1:Service1b:xxx will be activated on B.
  • Interface2:Service2:endpoint2a and Interface1:Service2b:endpoint2b, then only Interface1:Service2:xxx will be activated on B.
  • Interface3:Service3:endpoint3, then Interface3:Service3:xxx will be activated on B.
  • Etc.

We can notice that the endpoint name is never propagated because it is considered that the endpoint is only a technical information to locate an endpoint in a domain.

We can also notice that what matters is always the pair interface and service name, and in case no service name is specified in the Consumes SU, then each existing service in the provider domain will be propagated as its own service.

Using SSL to authenticate and encrypt exchanges between domains

In order to secure connections between provider and consumer domain, it is possible to rely on SSL.
SSL itself takes care of the encryption, but it is necessary for the provider domain, and optionally for the consumer domain, to have a certificate shared between parties to authenticate them.
There can't thus be encryption without authentication of at least the provider domain and ideally also of the consumer domain!

Authenticating only the Provider Domain

For a provider domain, using SSL means to define a certificate that consumer domains that connect to it can use to authenticate it.
The certificate is a public information and the provider domain owns also a private key that it can use to answers authentication challenges from the consumer domain.

Provider Domain A

On the provider side, the consumer-domain element must be updated with the following parameters:

<?xml version="1.0" encoding="UTF-8"?>
<jbi:jbi ...>

   <jbi:services binding-component="true">
      ...

      <g:consumer-domain id="domainB" transport="transport1">
         <g:auth-name>UniquelySharedBetweenA&B</g:auth-name>
         <g:certificate>path/to/a/certificate+provider.crt</g:certificate>
         <g:key>path/to/the/key.pem</g:key>
         <g:passphrase>secret-to-unlock-the-key<g:passphrase>
      </g:consumer-domain>

   </jbi:services>
</jbi:jbi>

Note that this means that setting up SSL is done per consumer domain that will connect to this SU, but nothing prevent us to configure the same certificate for multiple consumer domains of course!

Consumer Domain B

On the consumer side, the consumer-domain element must be updated with the following parameters:

<?xml version="1.0" encoding="UTF-8"?>
<jbi:jbi ...">

   <jbi:services binding-component="true">
      
      <g:provider-domain id="domainA">
         <g:remote-ip>domainA-hostname</g:remote-ip>
         <g:remote-port>7500</g:remote-port>
         <g:remote-auth-name>UniquelySharedBetweenA&B</g:remote-auth-name>
         <g:remote-certificate>path/to/the/certificate-provider.crt</g:remote-certificate>
      </g:provider-domain>

   </jbi:services>
</jbi:jbi>

Authenticating both the Provider and Consumer domains

Optionally, it is also possible to superpose on this basic SSL setup the use of a certificate that the provider domain will use to authenticate the consumer domain.
The later will also own a private key then.

Provider Domain A

On the provider side, the consumer-domain element must be updated with the following parameters:

<?xml version="1.0" encoding="UTF-8"?>
<jbi:jbi ...>

   <jbi:services binding-component="true">
      ...

      <g:consumer-domain id="domainB" transport="transport1">
         <g:auth-name>UniquelySharedBetweenA&B</g:auth-name>
         <g:certificate>path/to/a/certificate-provider.crt</g:certificate>
         <g:key>path/to/the/key.pem</g:key>
         <g:passphrase>secret-to-unlock-the-key<g:passphrase>
         <g:remote-certificate>path/to/the/certificate-consumer.crt
      </g:consumer-domain>

   </jbi:services>
</jbi:jbi>

This means that even if multiple Provides SUs connects to this provider domain, they all must use the same certificate as it is a mean to authenticate a consumer domain and not an individual node of this domain.

Consumer Domain B

On the consumer side, the consumer-domain element must be updated with the following parameters:

<?xml version="1.0" encoding="UTF-8"?>
<jbi:jbi ...">

   <jbi:services binding-component="true">
      
      <g:provider-domain id="domainA">
         <g:remote-ip>domainA-hostname</g:remote-ip>
         <g:remote-port>7500</g:remote-port>
         <g:remote-auth-name>UniquelySharedBetweenA&B</g:remote-auth-name>
         <g:remote-certificate>path/to/the/certificate-provider.crt</g:remote-certificate>
         <g:certificate>path/to/a/certificate-consumer.crt</g:certificate>
         <g:key>path/to/the/key.pem</g:key>
         <g:passphrase>secret-to-unlock-the-key<g:passphrase>
      </g:provider-domain>

   </jbi:services>
</jbi:jbi>

Service Rewriting

Service Unit Configuration

Consumes SU

In a Consumes SU, one must declare at least one consumer-domain and some consumes element to determine the services to be propagated to one or several of these consumer domains.

The consumes element can't override each other for the same consumer-domain:

  • If there is a consumes of type Interface:Service:endpoint, then there can't be another consumes of type Interface:Service:endpoint, Interface:Service: or Interface:: defined for the same consumer-domain.
  • If there is a consumes of type Interface:Service:, then there can't be another consumes of type Interface:Service: or Interface:: defined for the same consumer-domain.
  • If there is a consumes of type Interface::, then there can't be another consumes of type Interface:: defined for the same consumer-domain.

Consumer Domain Element

{*}Configuration of a consumer-domain element *

Parameter or Attribute Description Default Required
id A unique name (in the SU) to identify this consumer domain configuration - Yes
transport The identifier of a transport listener configured in the component - Yes
auth-name A unique name (in the transport listener) to be shared with the consumer domain that will connect to this SU - Yes
remote-certificate The path to a shared SSL certificate used to authenticate the consumer domain that will connect to this SU (relative path means in the SU, absolute path means on the filesystem) - No
certificate The path to a shared SSL certificate used to secure the connections (relative path means in the SU, absolute path means on the filesystem) - Yes if remote-certificate is specified
key The path to a private SSL key for the SSL certificate specified with certificate (relative path means in the SU, absolute path means on the filesystem) - Yes if certificate is specified, else ignored
passphrase The passphrase to unlock the SSL key specified with key - Only if key is specified and needs a passphrase, else ignored
propagation-polling-max-delay The maximum delay between polling done by this SU to check new or removed endpoints in the domain (a 0 or negative value means no polling) in milliseconds 5000 Yes
propagation-polling-acceleration The polling starts at 5sec and is multiplied by this factor after each polling until the maximum delay is attained (a value equals to 1 or less means no acceleration, i.e., the delay is always at the configured maximum) 2.0 Yes

The elements defined inside consumer-domain in an SU accept placeholder values.

Consumes Element

Note that in consumes elements for the Gateway BC, it has no meaning to specify a mep or an operation: they will be ignored, thus it is recommended to always set the mep to nil (because it is required to specify it):

<cdk:mep xsi:nil="true" />
Configuration of a Service Unit to consume a service (JBI)

Parameter Description Default Required
consumes Refer JBI service to invoke into the JBI bus.
You can define an explicit endpoint: interface (QName) / Service (QName) / Endpoint (String) attributes.
Or define implicit endpoint, to let the container routing according to QOS configurations (HA...):
-by Interface attribute (QName)
-by Service attribute (QName)
- Yes


Configuration of a Service Unit to consume a service (CDK)

Parameter Description Default Required
mep Message exchange pattern abbreviation. This parameter can be used in conjunction with the method of the CDK Listeners: createMessageExchange(Extensions extensions).
This method returns a CDK Exchange corresponding to the type of the specified pattern.
- Yes
operation Operation to call on a service. This parameter can be used in conjunction with the sending methods of the Listeners. If no operation is specified in the Message Exchange to send, this parameter will be used. - No
timeout Timeout in milliseconds of a synchronous send. This parameter can be used in conjunction with the sendSync(Exchange exchange) method of the Listeners. Set 0 for an infinite timeout. 30000 No

BC Gateway configuration of a consumes element

Parameter Description Default Required
consumer The identifier of a consumer-domain element specified in the SU Yes (and more than once)

Provides SU

In a Provides SU, one must declare at least one provider-domain and optionally some provides element to determine how the services are being propagated from one of the provider domain.

The provides element must have a provider element and these can't override each other for the same provider-domain:

  • If there is a provides with a provider of type Interface:Service:endpoint, then there can't be another provides with a provider of type Interface:Service:endpoint or Interface:Service: defined for the same provider-domain.
  • If there is a provides with a provider of type Interface:Service:, then there can't be another provides with a provider of type Interface:Service: defined for the same provider-domain.

Provider Domain Element

Configuration of a provider-domain element

Parameter Description Default Required
id A unique name (in the SU) to identify this provider domain configuration - Yes
remote-ip The ip or hostname of the remote provider domain gateway - Yes
remote-port The port of the remote provider domain gateway 7500 Yes
remote-auth-name A name to be shared with the provider domain that this SU will connect to - Yes
certificate The path to a shared SSL certificate used to authenticate me (relative path means in the SU, absolute path means on the filesystem) - No
key The path to a private SSL key for the SSL certificate specified with certificate (relative path means in the SU, absolute path means on the filesystem) - Yes if certificate is specified, else ignored
passphrase The passphrase to unlock the SSL key specified with key - Yes if key is specified and needs a passphrase, else ignored
remote-certificate The path to a shared SSL certificate used to authenticate the provider domain that this SU will connect to (relative path means in the SU, absolute path means on the filesystem) - Yes if certificate is specified
propagate-all Set to false to propagate only the services declared as provides in the SU true Yes
retry-delay Delay between retry in case of disconnection in milliseconds 5000 Yes
retry-max Maximum retries before failing to connect (a negative value means infinite) -1 Yes

The elements defined inside provider-domain in an SU accept placeholder values.

Provides Element

Configuration of a Service Unit to provide a service (JBI)

Parameter Description
Default
Required
provides Describe the JBI service that will be exposed into the JBI bus. Interface (QName), Service (QName) and Endpoint (String) attributes are required. - Yes

Configuration of a Service Unit to provide a service (CDK)

Parameter Description
Default
Required
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
exchange-properties This sections defines the list of properties to set to the JBI exchange when processing a service. - No
message-properties This sections defines the list of properties to set to the JBI message when processing a service. - No
validate-wsdl Activate the validation of the WSDL when deploying a service unit. true No
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 automaticaly provided by the CDK.
- No
forward-attachments
Defines if attachment will be forwarded from IN message to OUT message.
false No
forward-message-properties
Defines if the message properties will be forwarded from IN message to OUT message. false No
forward-security-subject
Defines if the security subject will be forwarded from IN message to OUT message. false No

BC Gateway configuration of a provides element

Parameter Description Default Required
provider See below - Yes

Configuration of the provides's provider element

Parameter or Attribute Description Default Required
domain The identifier of a provider-domain element specified in the SU - Yes
provider-interface-name The interface name of a service propagated by the provider domain that this SU will connect to (can be the same as the provides's) - Yes
provider-service-name The service name of a service propagated by the provider domain that this SU will connect to (can be the same as the provides's) - Yes
provider-endpoint-name The endpoint name of a service propagated by the provider domain that this SU will connect to - No

Component Configuration

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

Configuration of the component, CDK part

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

Note that the parameters processor-pool-size and processor-max-pool-size defaults respectively to 1 and 6 in the Gateway BC.
Configuration of the component, Gateway part

Parameter Description Default Required Scope
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 Installation
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 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.

Logging

The traces of Apache Netty itself can be activated through the logging configuration file of Petals ESB. The root logger for Netty is io.netty:

...
io.netty.level=INFO
...

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.

Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.