{section}
{column}

{warning}In this documentation, the term "Allocated threads" must be understood as "Active threads", see [PETALSDISTRIB-37|https://jira.petalslink.com/browse/PETALSDISTRIB-37]. This naming error will be fixed in the next version.{warning}

h1. Installing the command 'monitoring'

[Debian packages|Installing Petals CLI using the Debian packages] or a [full ZIP archive|petalscli211:Installing Petals CLI using the ZIP archive] are available to install this Petals CLI extension. Otherwise, just put the JAR artifact '{{org.ow2.petals:petals-cli-cmd-monitoring}}' in the directory {{$PETALS_CLI_HOME/extensions}}.

To check that the installation is correct, just get the list of available commands of your Petals CLI, you should see the command '{{monitoring}}' in the list:
{code}
> ./petals-cli.sh -c -- help
...
logger-set
Set the specified level to the specified logger.
loggers Return all the loggers.
monitoring
Get monitoring information.
print Print a message.
...
{code}

Next to this previous manual installation, you must install the Cacti's implementation of monitored objects and the Nagios's implementation of subscription objects. Put the JAR artifacts '{{org.ow2.petals:petals-cli-cmd-monitoring-mo-cacti}}' and '{{org.ow2.petals:petals-cli-cmd-monitoring-so-nagios}}' in the directory {{$PETALS_CLI_HOME/extensions}}.

To check that the installation is correct, just get the list of monitored and subscription objects:
{code}
> ./petals-cli.sh -c -- help monitoring
...
- petals-bc-soap: Component BC SOAP
- service-provider-invokations-count: Counters of service provider requests

- delivered-messages: Delivered messages
- ...
- ...

SUBSCRIPTION OBJECTS & DEFECTS
- generic: Subscription to the defects of the CDK based component
- org.ow2.petals.component.framework.process.message.acceptor.pool.thread.dead: A message exchange acceptor thread is dead unexpectedly !
- org.ow2.petals.component.framework.process.message.processor.object.pool.exhausted: No more message exchange processor is available in the object pool to process message exchange !
- org.ow2.petals.component.framework.process.message.acceptor.pool.exhausted: No more thread is available to accept message exchange processor !
- org.ow2.petals.component.framework.process.message.processor.thread.pool.exhausted: No more thread is available to run a message exchange processor !
- petals-bc-soap: Subscription to the defects of the Petals BC SOAP
- org.ow2.petals.component.framework.process.message.acceptor.pool.thread.dead: A message exchange acceptor thread is dead unexpectedly !
- org.ow2.petals.component.framework.process.message.processor.object.pool.exhausted: No more message exchange processor is available in the object pool to process message exchange !
- org.ow2.petals.component.framework.process.message.acceptor.pool.exhausted: No more thread is available to accept message exchange processor !
- org.ow2.petals.component.framework.process.message.processor.thread.pool.exhausted: No more thread is available to run a message exchange processor !
- org.ow2.petals.bc.soap.httpserver.threadpool.exhausted: No more thread is available in the HTTP thread pool to process incoming requests !
- org.ow2.petals.bc.soap.serviceclientspool.exhausted: No more web-service clients is available in its pool to process outgoing requests !
- ...
- ...
...
{code}

{column}
{column:width=35%}
{panel:title=Table of contents}{toc:outline=true}{panel}
{panel:title=Contributors}{contributors:order=name|mode=list|showAnonymous=true|showCount=true|showLastTime=true}{panel}
{column}
{section}

h1. Getting metrics

Monitored objects are designed to get metrics of an internal Petals component:
{code}
> petals-cli.sh ... -c -- monitoring -o <monitoring-object> -f <sub-function> [-h]
{code}
where:
* {{monitoring-object}} and {{sub-function}} identify the metrics to get. See [Monitored objects|#monitored-objects] to get available metrics.
* {{-h}}: Get help on the specified metric.

Metrics are printed on the standard output stream.

h1. Subscribing to defect

Subscription objects are designed to get notification on defects occurring on the Petals container side.
{code}
> petals-cli.sh ... -c -- monitoring -s <subscription-object>
> petals-cli.sh ... -c -- monitoring -u <subscription-object>
{code}
where:
* {{-s}}: subscribe to the defects of the subscription object,
* {{-u}}: unsubscribe from the defects of the subscription object.
See [Subscription objects|#subscription-objects].

Once a subscription is launched, detected defects are printed on the standard output, and the Petals CLI prompt is always available to enter other commands, as other subscriptions or unsubscriptions. Ctrl-C can be used to interrupt a subscription and to exit from Petals CLI.

{anchor:monitored-objects}
h1. Monitored objects for Cacti

Available monitored objects are the following:

| CDK-based component | [Service provider invokation number|#service-provider-invokations-count] | {{-o generic -f service-provider-invokations-count}} |
| CDK-based component | [Service provider invokation response times|#service-provider-invokations-response-times] | {{-o generic -f service-provider-invokations-response-times}} |
| Petals BC SOAP | [Incoming HTTP request counters|#petals-bc-soap-incoming-http-requests-count] | {{-o petals-bc-soap -f incoming-http-requests-count}} |
| Petals BC SOAP | [Incoming WS request counters|#petals-bc-soap-incoming-ws-requests-count] | {{-o petals-bc-soap -f incoming-ws-requests-count}} |
| Petals BC SOAP | [Incoming WS request response times|#petals-bc-soap-incoming-ws-requests-response-times] | {{-o petals-bc-soap -f incoming-ws-requests-response-times}} |
| Petals BC SOAP | [HTTP thread pool|#petals-bc-soap-http-thread-pool] | {{-o petals-bc-soap -f http-thread-pool}} |
| Petals BC SOAP | [WS-client pools|#petals-bc-soap-http-thread-pool] | {{-o petals-bc-soap -f ws-clients-pools}} |
| Petals BC SOAP | [Outgoing WS request counters|#petals-bc-soap-outgoing-ws-requests-count] | {{-o petals-bc-soap -f outgoing-ws-requests-count}} |
| Petals BC SOAP | [Outgoing WS request response times|#petals-bc-soap-outgoing-ws-requests-response-times] | {{-o petals-bc-soap -f outgoing-ws-requests-response-times}} |
| Local transporter | Delivered messages | {{-o local-transporter -f delivered-messages}} |

h2. Petals CDK based components

h3. {anchor:message-exchange-acceptor-thread-pool}Message exchange acceptor thread pool

Several metrics about the message exchange acceptor thread pool of the component are available through the sub function '{{mex-acceptor-thread-pool}}' of the monitored object '{{generic}}'. It's usage is:
{code}
-n <component-name>
{code}
where '{{<component-name>}}' is the unique name of the JBI component with which it was deployed.
Returned metrics are:
* {{AllocatedThreadsMax}}, the maximum number of threads allocatable to the message exchange acceptors,
* {{AllocatedThreadsCurrent}}, the current number of threads allocated to the message exchange acceptors.

{code}
> ./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o generic -f mex-acceptor-thread-pool -- -n petals-bc-soap
AllocatedThreadsMax:5 AllocatedThreadsCurrent:2

Several metrics about the message exchange processor object pool of the component are available through the sub function '{{mex-processor-object-pool}}' of the monitored object '{{generic}}'. It's usage is:
{code}
-n <component-name>
{code}
where '{{<component-name>}}' is the unique name of the JBI component with which it was deployed.
Returned metrics are:
* {{BorrowedObjectsMax}}, the maximum number of borrowed objects,
* {{BorrowedObjectsCurrent}}, the current number of borrowed objects,
* {{IdleObjectsMax}}, the maximum number of idle objects,
* {{IdleObjectsCurrent}}, the current number of idle objects,
* {{MaxSize}}, the maximum size of the object pool,
* {{MinIdleSize}}, the minimum size of the object pool,
* {{Exhaustions}}, the number of exhaustions of the object pool.

{code}
> ./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o generic -f mex-processor-thread-pool -- -n petals-bc-soap
BorrowedObjectsMax:50 BorrowedObjectsCurrent:0 IdleObjectsMax:8 IdleObjectsCurrent:8 MaxSize:50 MinIdleSize:10 Exhaustions:25535
{code}

h3. {anchor:message-exchange-processor-thread-pool}Message exchange processor thread pool

Several metrics about the message exchange processor thread pool of the component are available through the sub function '{{mex-processor-thread-pool}}' of the monitored object '{{generic}}'. It's usage is:
{code}
-n <component-name>
{code}
where '{{<component-name>}}' is the unique name of the JBI component with which it was deployed.
Returned metrics are:
* {{AllocatedThreadsMax}}, the maximum number of allocated threads,
* {{AllocatedThreadsCurrent}}, the current number of allocated threads,
* {{IdleThreadsMax}}, the maximum number of idle threads,
* {{IdleThreadsCurrent}}, the current number of idle threads,
* {{MaxSize}}, the maximum size of the thread pool,
* {{MinSize}}, the minimum size of the thread pool,
* {{EnqueuedRequestsMax}}, the maximum number of requests that are enqueued waiting a thread to be processed,
* {{EnqueuedRequestsCurrent}}, the current number of requests that are enqueued waiting a thread to be processed.

{code}
> ./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o generic -f mex-processor-thread-pool -- -n petals-bc-soap
AllocatedThreadsMax:5 AllocatedThreadsCurrent:5 IdleThreadsMax:0 IdleThreadsCurrent:1 MaxSize:50 MinSize:2 EnqueuedRequestsMax:0 EnqueuedRequestsCurrent:0
{code}

h3. {anchor:service-provider-invokations-count}Service provider invokation number

Service provider invokation counters are available through the sub function '{{service-provider-invokations-count}}' of the monitored object '{{generic}}'. It's usage is:
{code}
-n <component-name> [--list-operations] | [--query-operations [NAME] | [SUCCEEDED|PENDING|FAULT|ERROR <index>]] | [-t]
{code}
where '{{<component-name>}}' is the unique name of the JBI component with which it was deployed.

\\
'{{--list-operations}}' returns the list of all operations of all service providers of the component that were invoked since the last start of the component. Operations are returned with the following pattern: {{<operation>@<sp-service-name>@<sp-interface-name>}}, where:
* {{<operation>}} is the qualified name of the operation,
* {{<sp-service-name>}} is the service name of the service provider,
* {{<sp-interface-name>}} is the interface name of the service provider.
{code}
>./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o generic -f service-provider-invokations-count -- -n petals-bc-soap --list-operations
{http://esb.mediation.archi.acoss.fr/services/echo/1.0}echoOperation@{http://esb.mediation.archi.acoss.fr/services/echo/1.0}EchoService@{http://esb.mediation.archi.acoss.fr/services/echo/1.0}Echo
{code}

\\
'{{--query-operations}}' returns query result about operation:
|| Query argument || Description ||
| {{NAME}} | returns operation names of service providers by index. It is used to known which operation is associated to index. The output format is: {{<index>!<operation>}}, one operation per line. |
| {{SUCCEEDED}} | returns the number of succeeded service provider invokations per operation. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index. |
| {{PENDING}} | returns the number of pending service provider invokations per operation. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index. |
| {{FAULT}} | returns the number of faulty service provider invocation per operation. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index. |
| {{ERROR}} | returns the number of failed service provider invocation per operation. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index. |
{code}
>./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o generic -f service-provider-invokations-count -- -n petals-bc-soap --query-operations SUCCEEDED
{http://esb.mediation.archi.acoss.fr/services/echo/1.0}echoOperation@{http://esb.mediation.archi.acoss.fr/services/echo/1.0}EchoService@{http://esb.mediation.archi.acoss.fr/services/echo/1.0}Echo!182830
{code}

\\
'{{-t}}' displays a human readable table of all values about service provider invokations:
{code}
> ./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o generic -f service-provider-invokations-count -- -n petals-bc-soap -t
| Interface | Service | Operation | MEP | Execution status || Value |
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
| {http://esb.mediation.archi.acoss.fr/services/echo/1.0}Echo | {http://esb.mediation.archi.acoss.fr/services/echo/1.0}EchoService | {http://esb.mediation.archi.acoss.fr/services/echo/1.0}echoOperation | http://www.w3.org/2004/08/wsdl/in-out | FAULT || 53773 |
| {http://esb.mediation.archi.acoss.fr/services/echo/1.0}Echo | {http://esb.mediation.archi.acoss.fr/services/echo/1.0}EchoService | {http://esb.mediation.archi.acoss.fr/services/echo/1.0}echoOperation | http://www.w3.org/2004/08/wsdl/in-out | ERROR || 725 |
| {http://esb.mediation.archi.acoss.fr/services/echo/1.0}Echo | {http://esb.mediation.archi.acoss.fr/services/echo/1.0}EchoService | {http://esb.mediation.archi.acoss.fr/services/echo/1.0}echoOperation | http://www.w3.org/2004/08/wsdl/in-out | SUCCEEDED || 182830 |
| {http://esb.mediation.archi.acoss.fr/services/echo/1.0}Echo | {http://esb.mediation.archi.acoss.fr/services/echo/1.0}EchoService | {http://esb.mediation.archi.acoss.fr/services/echo/1.0}echoOperation | http://www.w3.org/2004/08/wsdl/in-out | PENDING || 0 |
{code}

h3. {anchor:service-provider-invokations-response-times}Service provider invokation response times

Service provider invokation response times are available through the sub function '{{service-provider-invokations-response-times}}' of the monitored object '{{generic}}'. It's usage is:
{code}
-n <component-name> [--list-operations] | [--query-operations [NAME] | [SUCCEEDED_MIN|SUCCEEDED_AVG|SUCCEEDED_MAX|SUCCEEDED_10P|SUCCEEDED_50P|SUCCEEDED_90P|PENDING_MIN|PENDING_AVG|PENDING_MAX|PENDING_10P|PENDING_50P|PENDING_90P|FAULT_MIN|FAULT_AVG|FAULT_MAX|FAULT_10P|FAULT_50P|FAULT_90P|ERROR_MIN|ERROR_AVG|ERROR_MAX|ERROR_10P|ERROR_50P|ERROR_90P <index>]] | [-t]
{code}
where '{{<component-name>}}' is the unique name of the JBI component with which it was deployed.

\\
'{{--list-operations}}' returns the list of all operations of allservice providers of the component that were invoked since the last start of the component. Operations are returned with the following pattern: {{<operation>@<sp-service-name>@<sp-interface-name>}}, where:
* {{<operation>}} is the qualified name of the operation,
* {{<sp-service-name>}} is the service name of the service provider,
* {{<sp-interface-name>}} is the interface name of the service provider.
{code}
>./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o generic -f service-provider-invokations-response-times -- -n petals-bc-soap --list-operations
{http://esb.mediation.archi.acoss.fr/services/echo/1.0}echoOperation@{http://esb.mediation.archi.acoss.fr/services/echo/1.0}EchoService@{http://esb.mediation.archi.acoss.fr/services/echo/1.0}Echo
{code}

\\
'{{--query-operations}}' returns query result about operation:
|| Query argument || Description ||
| {{NAME}} | returns operation names by index. It is used to known which operation is associated to index. The output format is: {{<index>!<operation>}}, one operation per line. |
| {{SUCCEEDED_MIN}} | returns the minimum value (in milliseconds) of response times of succeeded invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{SUCCEEDED_AVG}} | returns the average value (in milliseconds) of response times of succeeded invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{SUCCEEDED_MAX}} | returns the maximum value (in milliseconds) of response times of succeeded invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{SUCCEEDED_10P}} | returns the 10-percentile value (in milliseconds) of response times of succeeded invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{SUCCEEDED_50P}} | returns the 50-percentile value (in milliseconds) of response times of succeeded invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{SUCCEEDED_90P}} | returns the 90-percentile value (in milliseconds) of response times of succeeded invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{PENDING_MIN}} | returns the minimum value (in milliseconds) of response times of pending invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{PENDING_AVG}} | returns the average value (in milliseconds) of response times of pending invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{PENDING_MAX}} | returns the maximum value (in milliseconds) of response times of pending invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{PENDING_10P}} | returns the 10-percentile value (in milliseconds) of response times of pending invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{PENDING_50P}} | returns the 50-percentile value (in milliseconds) of response times of pending invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{PENDING_90P}} | returns the 90-percentile value (in milliseconds) of response times of pending invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{FAULT_MIN}} | returns the minimum value (in milliseconds) of response times of faulty invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{FAULT_AVG}} | returns the average value (in milliseconds) of response times of faulty invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{FAULT_MAX}} | returns the maximum value (in milliseconds) of response times of faulty invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{FAULT_10P}} | returns the 10-percentile value (in milliseconds) of response times of faulty invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{FAULT_50P}} | returns the 50-percentile value (in milliseconds) of response times of faulty invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{FAULT_90P}} | returns the 90-percentile value (in milliseconds) of response times of faulty invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{ERROR_MIN}} | returns the minimum value (in milliseconds) of response times of failed invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{ERROR_AVG}} | returns the average value (in milliseconds) of response times of failed invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{ERROR_MAX}} | returns the maximum value (in milliseconds) of response times of failed invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{ERROR_10P}} | returns the 10-percentile value (in milliseconds) of response times of failed invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{ERROR_50P}} | returns the 50-percentile value (in milliseconds) of response times of failed invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{ERROR_90P}} | returns the 90-percentile value (in milliseconds) of response times of failed invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
{code}
>./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o generic -f service-provider-invokations-response-times -- -n petals-bc-soap --query-operations SUCCEEDED_50P
{http://esb.mediation.archi.acoss.fr/services/echo/1.0}echoOperation@{http://esb.mediation.archi.acoss.fr/services/echo/1.0}EchoService@{http://esb.mediation.archi.acoss.fr/services/echo/1.0}Echo!1100
{code}

\\
'{{-t}}' displays a human readable table of all values about service provider invokation response times:
{code}
> ./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o generic -f service-provider-invokations-response-times -- -n petals-bc-soap -t
| Interface | Service | Operation | MEP | Execution status || Min | Avg | Max | 10P | 50P | 90P |
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
| {http://esb.mediation.archi.acoss.fr/services/echo/1.0}Echo | {http://esb.mediation.archi.acoss.fr/services/echo/1.0}EchoService | {http://esb.mediation.archi.acoss.fr/services/echo/1.0}echoOperation | http://www.w3.org/2004/08/wsdl/in-out | ERROR || 9013 | 9722 | 12288 | 9015 | 9023 | 11026 |
| {http://esb.mediation.archi.acoss.fr/services/echo/1.0}Echo | {http://esb.mediation.archi.acoss.fr/services/echo/1.0}EchoService | {http://esb.mediation.archi.acoss.fr/services/echo/1.0}echoOperation | http://www.w3.org/2004/08/wsdl/in-out | FAULT || 3 | 5739 | 22793 | 6 | 6078 | 11682 |
| {http://esb.mediation.archi.acoss.fr/services/echo/1.0}Echo | {http://esb.mediation.archi.acoss.fr/services/echo/1.0}EchoService | {http://esb.mediation.archi.acoss.fr/services/echo/1.0}echoOperation | http://www.w3.org/2004/08/wsdl/in-out | PENDING || 1306 | 2975 | 11350 | 1309 | 1345 | 5103 |
| {http://esb.mediation.archi.acoss.fr/services/echo/1.0}Echo | {http://esb.mediation.archi.acoss.fr/services/echo/1.0}EchoService | {http://esb.mediation.archi.acoss.fr/services/echo/1.0}echoOperation | http://www.w3.org/2004/08/wsdl/in-out | SUCCEEDED || 2 | 1977 | 19891 | 4 | 1017 | 5621 |
{code}

h2. Petals BC SOAP

h3. {anchor:petals-bc-soap-incoming-ws-requests-count}Incoming WS request counters

Incoming WS request counters are available through the sub function '{{incoming-ws-requests-count}}' of the monitored object '{{petals-bc-soap}}'. It's usage is:
{code}
-n <component-name> [--list-operations] | [--query-operations [NAME] | [SUCCEEDED|FAULT|ERROR <index>]] | [-t]
{code}
where '{{<component-name>}}' is the unique name of the Petals BC SOAP with which it was deployed.

\\
'{{--list-operations}}' returns the list of all operations of all web-services that were invoked since the last start of the component. Operations are returned with the following pattern: {{<operation>@<ws-path>}}, where {{<operation>}} is the qualified name of the operation and {{<ws-path>}} is the URL path of the web-service.
{code}
>./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o petals-bc-soap -f incoming-ws-requests-count -- -n petals-bc-soap --list-operations
{http://esb.mediation.archi.acoss.fr/services/charge/se-diff-agreg/1.0}chargeOperation@/ChargeService
{code}

\\
'{{--query-operations}}' returns query result about operation:
|| Query argument || Description ||
| {{NAME}} | returns operation names by index. It is used to known which operation is associated to index. The output format is: {{<index>!<operation>}}, one operation per line. |
| {{SUCCEEDED}} | returns the number of succeeded invocation per operation. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index. |
| {{FAULT}} | returns the number of faulty invocation per operation. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index. |
| {{ERROR}} | returns the number of failed invocation per operation. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index. |
{code}
>./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o petals-bc-soap -f incoming-ws-requests-count -- -n petals-bc-soap --query-operations SUCCEEDED
{http://esb.mediation.archi.acoss.fr/services/charge/se-diff-agreg/1.0}chargeOperation@/ChargeService!3
{code}

\\
'{{-t}}' displays a human readable table of all values about incoming WS requests:
{code}
> ./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o petals-bc-soap -f incoming-ws-requests-count -- -n petals-bc-soap -t
| Service | Operation | WS-client | Execution status || Value |
---------------------------------------------------------------------------------------------------------------------------------------------------
| /ChargeService | {http://esb.mediation.archi.acoss.fr/services/charge/se-diff-agreg/1.0}chargeOperation | 127.0.0.1 | SUCCEEDED || 3 |
| /ChargeService | {http://esb.mediation.archi.acoss.fr/services/charge/se-diff-agreg/1.0}chargeOperation | 127.0.0.1 | PENDING || 0 |
{code}

h3. {anchor:petals-bc-soap-incoming-ws-requests-response-times}Incoming WS request response times

Incoming WS request response times are available through the sub function '{{incoming-ws-requests-count}}' of the monitored object '{{petals-bc-soap}}'. It's usage is:
{code}
-n <component-name> [--list-operations] | [--query-operations [NAME] | [SUCCEEDED_MIN|SUCCEEDED_AVG|SUCCEEDED_MAX|SUCCEEDED_10P|SUCCEEDED_50P|SUCCEEDED_90P|FAULT_MIN|FAULT_AVG|FAULT_MAX|FAULT_10P|FAULT_50P|FAULT_90P|ERROR_MIN|ERROR_AVG|ERROR_MAX|ERROR_10P|ERROR_50P|ERROR_90P <index>]] | [-t]
{code}
where '{{<component-name>}}' is the unique name of the Petals BC SOAP with which it was deployed.

\\
'{{--list-operations}}' returns the list of all operations of all web-services that were invoked since the last start of the component. Operations are returned with the following pattern: {{<operation>@<ws-path>}}, where {{<operation>}} is the qualified name of the operation and {{<ws-path>}} is the URL path of the web-service.
{code}
>./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o petals-bc-soap -f incoming-ws-requests-response-times -- -n petals-bc-soap --list-operations
{http://esb.mediation.archi.acoss.fr/services/charge/se-diff-agreg/1.0}chargeOperation@/ChargeService
{code}

\\
'{{--query-operations}}' returns query result about operation:
|| Query argument || Description ||
| {{NAME}} | returns operation names by index. It is used to known which operation is associated to index. The output format is: {{<index>!<operation>}}, one operation per line. |
| {{SUCCEEDED_MIN}} | returns the minimum value (in milliseconds) of response times of succeeded invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{SUCCEEDED_AVG}} | returns the average value (in milliseconds) of response times of succeeded invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{SUCCEEDED_MAX}} | returns the maximum value (in milliseconds) of response times of succeeded invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{SUCCEEDED_10P}} | returns the 10-percentile value (in milliseconds) of response times of succeeded invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{SUCCEEDED_50P}} | returns the 50-percentile value (in milliseconds) of response times of succeeded invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{SUCCEEDED_90P}} | returns the 90-percentile value (in milliseconds) of response times of succeeded invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{FAULT_MIN}} | returns the minimum value (in milliseconds) of response times of faulty invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{FAULT_AVG}} | returns the average value (in milliseconds) of response times of faulty invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{FAULT_MAX}} | returns the maximum value (in milliseconds) of response times of faulty invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{FAULT_10P}} | returns the 10-percentile value (in milliseconds) of response times of faulty invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{FAULT_50P}} | returns the 50-percentile value (in milliseconds) of response times of faulty invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{FAULT_90P}} | returns the 90-percentile value (in milliseconds) of response times of faulty invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{ERROR_MIN}} | returns the minimum value (in milliseconds) of response times of failed invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{ERROR_AVG}} | returns the average value (in milliseconds) of response times of failed invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{ERROR_MAX}} | returns the maximum value (in milliseconds) of response times of failed invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{ERROR_10P}} | returns the 10-percentile value (in milliseconds) of response times of failed invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{ERROR_50P}} | returns the 50-percentile value (in milliseconds) of response times of failed invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{ERROR_90P}} | returns the 90-percentile value (in milliseconds) of response times of failed invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
{code}
>./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o petals-bc-soap -f incoming-ws-requests-response-times -- -n petals-bc-soap --query-operations SUCCEEDED_50P
{http://esb.mediation.archi.acoss.fr/services/charge/se-diff-agreg/1.0}chargeOperation@/ChargeService!7021
{code}

\\
'{{-t}}' displays a human readable table of all values about incoming WS-request response times:
{code}
> ./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o petals-bc-soap -f incoming-ws-requests-response-times -- -n petals-bc-soap -t
| Service | Operation | WS-client | Execution status || Min | Avg | Max | 10P | 50P | 90P |
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
| /ChargeService | {http://esb.mediation.archi.acoss.fr/services/charge/se-diff-agreg/1.0}chargeOperation | 127.0.0.1 | SUCCEEDED || 2986 | 5901 | 8714 | 2986 | 7021 | 8714 |
| /ChargeService | {http://esb.mediation.archi.acoss.fr/services/charge/se-diff-agreg/1.0}chargeOperation | 127.0.0.1 | FAULT || 12271 | 12271 | 12271 | 12271 | 12271 | 12271 |
{code}

h3. {anchor:petals-bc-soap-incoming-http-requests-count}Incoming HTTP request counters

Incoming HTTP request counters are available through the sub function '{{incoming-http-requests-count}}' of the monitored object '{{petals-bc-soap}}'. It's usage is:
{code}
-n <component-name> [-r]
{code}
where '{{<component-name>}}' is the unique name of the Petals BC SOAP with which it was deployed.

\\
'{{-r}}' returns the number of HTTP requests processed per nature:
* {{Information}}, is associated to all information pages of the BC SOAP,
* {{WS}}, HTTP requests associated to web-service,
* {{Unknown}}, HTTP requests pointing to unknown page.
{code}
>./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o petals-bc-soap -f incoming-http-requests-count -- -n petals-bc-soap -r
Information:0 WS:7 Unknown:0
{code}

h3. {anchor:petals-bc-soap-http-thread-pool}HTTP thread pool

Several metrics about the HTTP thread pool of the HTTP server are available through the sub function '{{http-thread-pool}}' of the monitored object '{{petals-bc-soap}}'. It's usage is:
{code}
-n <component-name>
{code}
where '{{<component-name>}}' is the unique name of the Petals BC SOAP with which it was deployed.
Returned metrics are:
* {{AllocatedThreadsMax}}, the maximum number of allocated threads,
* {{AllocatedThreadsCurrent}}, the current number of allocated threads,
* {{IdleThreadsMax}}, the maximum number of idle threads,
* {{IdleThreadsCurrent}}, the current number of idle threads,
* {{MaxSize}}, the maximum size of the thread pool,
* {{MinSize}}, the minimum size of the thread pool,
* {{EnqueuedRequestsMax}}, the maximum number of requests that are enqueued waiting a thread to be processed,
* {{EnqueuedRequestsCurrent}}, the current number of requests that are enqueued waiting a thread to be processed.

{code}
> ./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o petals-bc-soap -f http-thread-pool -- -n petals-bc-soap
AllocatedThreadsMax:5 AllocatedThreadsCurrent:5 IdleThreadsMax:0 IdleThreadsCurrent:1 MaxSize:50 MinSize:2 EnqueuedRequestsMax:0 EnqueuedRequestsCurrent:0
{code}

h3. {anchor:petals-bc-soap-ws-clients-pools}WS-clients pools

WS-clients pools counters are available through the sub function '{{ws-clients-pools}}' of the monitored object '{{petals-bc-soap}}'. It's usage is:
{code}
-n <component-name> [--list-operations] | [--query-operations [URL] | [INUSE_CUR|INUSE_MAX|EXHAUSTIONS <index>]] | [-t]
{code}
where '{{<component-name>}}' is the unique name of the Petals BC SOAP with which it was deployed.

\\
'{{--list-operations}}' returns the list of all operations of all external web-services that were invoked since the last start of the component. Operations are returned with the following pattern: {{<operation>@<external-ws-url>}}, where {{<operation>}} is the qualified name of the operation and {{<external-ws-url>}} is the URL of the external web-service.
{code}
>./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o petals-bc-soap -f ws-clients-pools -- -n petals-bc-soap --list-operations
{http://esb.mediation.archi.acoss.fr/services/echo/1.0}echoOperation@http://localhost:8088/EchoService
{code}

\\
'{{--query-operations}}' returns query result about operation:
|| Query argument || Description ||
| {{URL}} | returns operation names of external web-service by index. It is used to known which operation is associated to index. The output format is: {{<index>!<operation>}}, one operation per line. |
| {{INUSE_CUR}} | returns the number of clients of the client pool that are currently used to process external web-service request, per operation. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index. |
| {{INUSE_MAX}} | returns the maximum number of clients of the client pool that was used to process external web-service request, per operation. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index. |
| {{EXHAUSTIONS}} | returns the number of exhaustions that occurs since the last start of the component, per external web-service operation. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index. |
{code}
>./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o petals-bc-soap -f ws-clients-pools -- -n petals-bc-soap --query-operations INUSE_MAX
{http://esb.mediation.archi.acoss.fr/services/echo/1.0}echoOperation@http://localhost:8088/EchoService!1
{code}

\\
'{{-t}}' displays a human readable table of all values about WS client pools:
{code}
> ./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o petals-bc-soap -f incoming-ws-requests-count -- -n petals-bc-soap -t
| Service | Operation | MEP || In-use current | In-use max | Exhaustions |
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
| http://localhost:8088/EchoService | {http://esb.mediation.archi.acoss.fr/services/echo/1.0}echoOperation | http://www.w3.org/2004/08/wsdl/in-out || 0 | 1 | 0 |
{code}

h3. {anchor:petals-bc-soap-outgoing-ws-requests-count}Outgoing WS request counters

Outgoing WS request counters are available through the sub function '{{outgoing-ws-requests-count}}' of the monitored object '{{petals-bc-soap}}'. It's usage is:
{code}
-n <component-name> [--list-operations] | [--query-operations [NAME] | [SUCCEEDED|FAULT|ERROR <index>]] | [-t]
{code}
where '{{<component-name>}}' is the unique name of the Petals BC SOAP with which it was deployed.

\\
'{{--list-operations}}' returns the list of all operations of all external web-services that were invoked since the last start of the component. Operations are returned with the following pattern: {{<operation>@<external-ws-url>}}, where {{<operation>}} is the qualified name of the operation and {{<external-ws-url>}} is the URL of the external web-service.
{code}
>./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o petals-bc-soap -f outgoing-ws-requests-count -- -n petals-bc-soap --list-operations
{http://esb.mediation.archi.acoss.fr/services/echo/1.0}echoOperation@http://localhost:8088/EchoService
{code}

\\
'{{--query-operations}}' returns query result about operation:
|| Query argument || Description ||
| {{NAME}} | returns operation names of external web service by index. It is used to known which operation is associated to index. The output format is: {{<index>!<operation>}}, one operation per line. |
| {{SUCCEEDED}} | returns the number of succeeded external invocation per operation. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index. |
| {{FAULT}} | returns the number of faulty external invocation per operation. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index. |
| {{ERROR}} | returns the number of failed external invocation per operation. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index. |
{code}
>./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o petals-bc-soap -f outgoing-ws-requests-count -- -n petals-bc-soap --query-operations SUCCEEDED
{http://esb.mediation.archi.acoss.fr/services/echo/1.0}echoOperation@http://localhost:8088/EchoService!6
{code}

\\
'{{-t}}' displays a human readable table of all values about outgoing WS requests:
{code}
> ./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o petals-bc-soap -f outgoing-ws-requests-count -- -n petals-bc-soap -t
| External WS | Operation | MEP | Execution status || Value |
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
| http://localhost:8088/EchoService | {http://esb.mediation.archi.acoss.fr/services/echo/1.0}echoOperation | http://www.w3.org/2004/08/wsdl/in-out | PENDING || 0 |
| http://localhost:8088/EchoService | {http://esb.mediation.archi.acoss.fr/services/echo/1.0}echoOperation | http://www.w3.org/2004/08/wsdl/in-out | ERROR || 1 |
| http://localhost:8088/EchoService | {http://esb.mediation.archi.acoss.fr/services/echo/1.0}echoOperation | http://www.w3.org/2004/08/wsdl/in-out | SUCCEEDED || 6 |
{code}

h3. {anchor:petals-bc-soap-outgoing-ws-requests-response-times}Outgoing WS request response times

Outgoing WS request response times are available through the sub function '{{outgoing-ws-requests-response-times}}' of the monitored object '{{petals-bc-soap}}'. It's usage is:
{code}
-n <component-name> [--list-operations] | [--query-operations [NAME] | [SUCCEEDED_MIN|SUCCEEDED_AVG|SUCCEEDED_MAX|SUCCEEDED_10P|SUCCEEDED_50P|SUCCEEDED_90P|FAULT_MIN|FAULT_AVG|FAULT_MAX|FAULT_10P|FAULT_50P|FAULT_90P|ERROR_MIN|ERROR_AVG|ERROR_MAX|ERROR_10P|ERROR_50P|ERROR_90P <index>]] | [-t]
{code}
where '{{<component-name>}}' is the unique name of the Petals BC SOAP with which it was deployed.

\\
'{{--list-operations}}' returns the list of all operations of all external web-services that were invoked since the last start of the component. Operations are returned with the following pattern: {{<operation>@<external-ws-url>}}, where {{<operation>}} is the qualified name of the operation and {{<external-ws-url>}} is the URL of the external web-service.
{code}
>./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o petals-bc-soap -f outgoing-ws-requests-response-times -- -n petals-bc-soap --list-operations
{http://esb.mediation.archi.acoss.fr/services/echo/1.0}echoOperation@http://localhost:8088/EchoService
{code}

\\
'{{--query-operations}}' returns query result about operation:
|| Query argument || Description ||
| {{NAME}} | returns external operation names by index. It is used to known which operation is associated to index. The output format is: {{<index>!<operation>}}, one operation per line. |
| {{SUCCEEDED_MIN}} | returns the minimum value (in milliseconds) of response times of succeeded external invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{SUCCEEDED_AVG}} | returns the average value (in milliseconds) of response times of succeeded external invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{SUCCEEDED_MAX}} | returns the maximum value (in milliseconds) of response times of succeeded external invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{SUCCEEDED_10P}} | returns the 10-percentile value (in milliseconds) of response times of succeeded external invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{SUCCEEDED_50P}} | returns the 50-percentile value (in milliseconds) of response times of succeeded external invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{SUCCEEDED_90P}} | returns the 90-percentile value (in milliseconds) of response times of succeeded external invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{FAULT_MIN}} | returns the minimum value (in milliseconds) of response times of faulty external invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{FAULT_AVG}} | returns the average value (in milliseconds) of response times of faulty external invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{FAULT_MAX}} | returns the maximum value (in milliseconds) of response times of faulty external invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{FAULT_10P}} | returns the 10-percentile value (in milliseconds) of response times of faulty external invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{FAULT_50P}} | returns the 50-percentile value (in milliseconds) of response times of faulty external invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{FAULT_90P}} | returns the 90-percentile value (in milliseconds) of response times of faulty external invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{ERROR_MIN}} | returns the minimum value (in milliseconds) of response times of failed external invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{ERROR_AVG}} | returns the average value (in milliseconds) of response times of failed external invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{ERROR_MAX}} | returns the maximum value (in milliseconds) of response times of failed external invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{ERROR_10P}} | returns the 10-percentile value (in milliseconds) of response times of failed external invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{ERROR_50P}} | returns the 50-percentile value (in milliseconds) of response times of failed external invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
| {{ERROR_90P}} | returns the 90-percentile value (in milliseconds) of response times of failed external invocation per operation on the current sample. The operation is expressed by its index. The output format is: {{<index>!<value>}}, one operation per line. If an index value is set on the command line, the output is limited to the provided index |
{code}
>./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o petals-bc-soap -f outgoing-ws-requests-response-times -- -n petals-bc-soap --query-operations SUCCEEDED_50P
{http://esb.mediation.archi.acoss.fr/services/echo/1.0}echoOperation@http://localhost:8088/EchoService!16
{code}

\\
'{{-t}}' displays a human readable table of all values about incoming WS-request response times:
{code}
> ./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o petals-bc-soap -f outgoing-ws-requests-response-times -- -n petals-bc-soap -t
| External WS | Operation | MEP | Execution status || Min | Avg | Max | 10P | 50P | 90P |
------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
| http://localhost:8088/EchoService | {http://esb.mediation.archi.acoss.fr/services/echo/1.0}echoOperation | http://www.w3.org/2004/08/wsdl/in-out | SUCCEEDED || 12 | 21 | 46 | 15 | 16 | 26 |
{code}

{anchor:subscription-objects}
h1. Subscription objects for Nagios

Two subscription objects are available and detect the following defects:
* {{generic}}, associated to the CDK-based components, detects:
|| Defect || Description ||
| {{org.ow2.petals.component.framework.process.message.acceptor.pool.thread.dead}} | A message exchange acceptor thread is dead unexpectedly ! |
| {{org.ow2.petals.component.framework.process.message.acceptor.pool.exhausted}} | No more thread is available to accept new message exchange ! |
| {{org.ow2.petals.component.framework.process.message.processor.object.pool.exhausted}} | No more message exchange processor is available in the object pool to process message exchange ! |
| {{org.ow2.petals.component.framework.process.message.processor.thread.pool.exhausted}} | No more thread is available to run a message exchange processor ! |
* {{petals-bc-soap}}, associated to the Petals BC SOAP, detects:
|| Defect || Description ||
| {{org.ow2.petals.component.framework.process.message.acceptor.pool.thread.dead}} | A message exchange acceptor thread is dead unexpectedly ! |
| {{org.ow2.petals.component.framework.process.message.acceptor.pool.exhausted}} | No more thread is available to accept new message exchange ! |
| {{org.ow2.petals.component.framework.process.message.processor.object.pool.exhausted}} | No more message exchange processor is available in the object pool to process message exchange ! |
| {{org.ow2.petals.component.framework.process.message.processor.thread.pool.exhausted}} | No more thread is available to run a message exchange processor ! |
| {{org.ow2.petals.bc.soap.httpserver.threadpool.exhausted}} | No more thread is available in the HTTP thread pool to process incoming requests ! |
| {{org.ow2.petals.bc.soap.serviceclientspool.exhausted}} | No more web-service clients is available in its pool to process outgoing requests ! |

Each subscriptions object for Nagios has the following parameters:
* {{-n <component-name}}, to identify the JBI component to which the (un)subscription applies,
* {{-t <mapping-file-url>}}, to define a file containing the mapping rules to map your Nagios configuration with element of received notifications.

The mapping rule file is a properties file containing:
{code}
emitter.<defect_emitter> = <nagios_host>
name.<defect_name> = <nagios_service>
{code}
The {{<defect_emitter>}} identifier is based on the template: <component-id>@<hostname>, where <component-id> is the identifier of the component (ex: JBI component identifier) sending the defect from the Petals ESB container running on <hostname>, and <defect_name> is one of the previous one.