Command 'monitoring'

Key
This line was removed.
This word was removed. This word was added.
This line was added.

Changes (189)

View Page History
...
{code}

{column}
{column:width=35%}
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.
{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].


{anchor:monitored-objects}

h1. Monitored objects for Cacti

Available monitored objects are the following:
|| Object || Metric || Command line ||
| CDK-based component | [Message exchange acceptor thread pool|#message-exchange-acceptor-thread-pool] | {{\-o generic \-f mex-acceptor-thread-pool}} |
| CDK-based component | [Working message exchange acceptors|#working-message-exchange-acceptors] | {{\-o generic \-f mex-acceptor-working}} |
| CDK-based component | [Message exchange processor thread pool|#message-exchange-processor-thread-pool] | {{\-o generic \-f mex-processor-thread-pool}} |
| CDK-based component | [Service provider invocation number|#service-provider-invocations-count] | {{\-o generic \-f service-provider-invocations-count}} |
| CDK-based component | [Service provider invocation response times|#service-provider-invocations-response-times] | {{\-o generic \-f service-provider-invocations-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 HTTP service contract request counters|#petals-bc-soap-incoming-service-contract-requests-count] | {{\-o petals-bc-soap \-f incoming-service-contract-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}} |
| Petals SE Flowable | [Asynchronous job executor thread pool|#petals-se-flowable-async-executor-thread-pool] | {{\-o petals-se-flowable \-f async-job-executor-thread-pool}} |
| Petals SE Flowable | [Database connection pool|#petals-se-flowable-database-connection-pool] | {{\-o petals-se-flowable \-f database-connection-pool}} |
| Petals SE Flowable | [Process definition counters|#petals-se-flowable-process-definition-counters] | {{\-o petals-se-flowable \-f process-definitions-count}} |
| Local transporter | [Delivered messages|#local-transporter-delivered-messages] | {{\-o local-transporter \-f delivered-messages}} |
| Remote transporter | [Outgoing connection pools|#remote-transporter-outgoing-connection-pool] | {{\-o tcp-transporter \-f outgoing-connections}} |
| Remote transporter | [Delivered outgoing messages|#remote-transporter-delivered-outgoing-messages] | {{\-o tcp-transporter \-f delivered-outgoing-messages}} |
| Remote transporter | [Incoming connection pools|#remote-transporter-incoming-connection-pool] | {{\-o tcp-transporter \-f incoming-connections}} |
| Remote transporter | [Delivered incoming messages|#remote-transporter-delivered-incoming-messages] | {{\-o tcp-transporter \-f delivered-incoming-messages}} |

h2. Petals Components

\\
'{{\--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,
{code}

{note}The counter values add up the values of all endpoints matching '{{<operation>@<sp-service-name>@<sp-interface-name>}}'. We choose this because we think that in the most cases only one endpoint will be deployed at once on the given component of the given container. If you need to separate values by endpoint, please fill an issue: [http://jira.petalslink.com].{note}

\\
'{{\--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 invocations 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 invocations 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-invocations-count -- -n petals-bc-soap --query-operations SUCCEEDED

\\
'{{\-t}}' displays a human readable table of all values about service provider invocations:
{code}
> ./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o generic -f service-provider-invocations-count -- -n petals-bc-soap -t

\\
'{{\--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,
{code}

{note}The counter values add up the values of all endpoints matching '{{<operation>@<sp-service-name>@<sp-interface-name>}}'. We choose this because we think that in the most cases only one endpoint will be deployed at once on the given component of the given container. If you need to separate values by endpoint, please fill an issue: [http://jira.petalslink.com].{note}

\\
'{{\--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-invocations-response-times -- -n petals-bc-soap --query-operations SUCCEEDED_50P

\\
'{{\-t}}' displays a human readable table of all values about service provider invocation response times:
{code}
> ./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o generic -f service-provider-invocations-response-times -- -n petals-bc-soap -t

\\
'{{\--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

\\
'{{\--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

\\
'{{\-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

\\
'{{\--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

\\
'{{\--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

\\
'{{\-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

\\
'{{\-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-services,

\\
'{{\--list-services}}' returns the list of all web-services for which the service contract was asked since the last start of the component.
{code}
>./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o petals-bc-soap -f incoming-service-contract-requests-count -- -n petals-bc-soap --list-services

\\
'{{\--query-services}}' returns query result about web-service:
|| Query argument || Description ||
| {{NAME}} | returns web-service names by index. It is used to known which web-service is associated to index. The output format is: {{<index>\!<service>}}, one service per line. |
| {{COUNT}} | returns the number of service contract asking per web-service. The operation is expressed by its index. The output format is: {{<index>\!<value>}}, one service 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-service-contract-requests-count -- -n petals-bc-soap --query-services COUNT

\\
'{{\-t}}' displays a human readable table of all values about incoming web-service contract requests:
{code}
> ./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o petals-bc-soap -f archiveService -- -n petals-bc-soap -t

\\
'{{\--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

\\
'{{\--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

\\
'{{\-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

\\
'{{\--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

\\
'{{\--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

\\
'{{\-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

\\
'{{\--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

\\
'{{\--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

\\
'{{\-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

\\
'{{\--list-process-definitions}}' returns the list of all process definitions that are deployed on the Flowable engine in a logical point of view.
{code}
>./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o petals-se-flowable -f process-definitions-count -- -n petals-se-flowable --list-process-definitions

\\
'{{\--query-process-definitions}}' returns query result about process definition:
|| Query argument || Description ||
| {{NAME}} | returns process-definition names by index. It is used to known which process definition is associated to index. The output format is: {{<index>\!<process-definition>}}, one operation per line. |
| {{ACTIVE}} | returns the number of *active* process instances per process definition. The process definition is expressed by its index. The output format is: {{<index>\!<value>}}, one process definition per line. If an index value is set on the command line, the output is limited to the provided index. |
| {{SUSPENDED}} | returns the number of *suspended* process instances per process definition. The process definition is expressed by its index. The output format is: {{<index>\!<value>}}, one process definition per line. If an index value is set on the command line, the output is limited to the provided index. |
| {{ENDED}} | returns the number of *ended* process instances per process definition. The process definition is expressed by its index. The output format is: {{<index>\!<value>}}, one process definition per line. If an index value is set on the command line, the output is limited to the provided index. |

{code}

\\
'{{\-t}}' displays a human readable table of all values about process definition counters:
{code}
> ./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o petals-se-flowable -f process-definitions-count -- -n petals-se-flowable -t

\\
'{{\--list-containers}}' returns the list of all remote-containers for which connections was established, since the last start of the transporter.
{code}
>./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o tcp-transporter -f outgoing-connections -- --list-containers

\\
'{{\--query-containers}}' returns query result about remote container:
|| Query argument || Description ||
| {{NAME}} | returns remote container names by index. It is used to known which remote container name is associated to index. The output format is: {{<index>\!<remote-container>}}, one remote container per line. |
| {{MAX_ACTIVE}} | returns the *max number of active* connections per remote container. The remote container is expressed by its index. The output format is: {{<index>\!<value>}}, one remote container per line. If an index value is set on the command line, the output is limited to the provided index, and only the value is displayed. |
| {{ACTIVE}} | returns the *current number of active* connections per remote container. The remote container is expressed by its index. The output format is: {{<index>\!<value>}}, one remote container per line. If an index value is set on the command line, the output is limited to the provided index, and only the value is displayed. |
| {{MAX_IDLE}} | returns the \*max number of idle connections per remote container. The remote container is expressed by its index. The output format is: {{<index>\!<value>}}, one remote container per line. If an index value is set on the command line, the output is limited to the provided index, and only the value is displayed. |
| {{IDLE}} | returns the *current number of idle* connections per remote container. The remote container is expressed by its index. The output format is: {{<index>\!<value>}}, one remote container per line. If an index value is set on the command line, the output is limited to the provided index, and only the value is displayed. |
| {{MAX_SIZE}} | returns the *max size* of the connection pool per remote container. The remote container is expressed by its index. The output format is: {{<index>\!<value>}}, one remote container per line. If an index value is set on the command line, the output is limited to the provided index, and only the value is displayed. |
| {{MIN_SIZE}} | returns the *min size* of the connection pool per remote container. The remote container is expressed by its index. The output format is: {{<index>\!<value>}}, one remote container per line. If an index value is set on the command line, the output is limited to the provided index, and only the value is displayed. |
| {{ESTABLISHED}} | returns the *number of connections established* per remote-container since the last startup of the remote transporter. The remote-container is expressed by its index. The output format is: {{<index>\!<value>}}, one remote container per line. If an index value is set on the command line, the output is limited to the provided index, and only the value is displayed. |
{code}
>./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o tcp-transporter -f outgoing-connections -- --query-containers ACTIVE

\\
'{{\-t}}' displays a human readable table of all values about delivered messages:
{code}
> ./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o tcp-transporter -f outgoing-connections -- t
| RemoteContainer || ActiveConnectionsMax | ActiveConnectionsCurrent | IdleConnectionsMax | IdleConnectionsCurrent | MaxSize | MinSize | EstablishedConnections |
-----------------------------------------------------------------------------------------------------------------------------------------------------------------

\\
'{{\--list-containers}}' returns the list of all remote-containers for which messages was sent, since the last start of the transporter.
{code}
>./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o tcp-transporter -f delivered-outgoing-messages -- --list-containers

\\
'{{\--query-containers}}' returns query result about remote container:
|| Query argument || Description ||
| {{NAME}} | returns remote container names by index. It is used to known which remote container name is associated to index. The output format is: {{<index>\!<remote-container>}}, one remote container per line. |
| {{SUCCEEDED}} | returns the number of succeeded delivered messages per remote container. The remote container is expressed by its index. The output format is: {{<index>\!<value>}}, one remote container per line. If an index value is set on the command line, the output is limited to the provided index, and only the value is displayed. |
| {{PENDING}} | returns the number of pending message delivery per remote container. The remote container is expressed by its index. The output format is: {{<index>\!<value>}}, one remote container per line. If an index value is set on the command line, the output is limited to the provided index, and only the value is displayed. |
| {{ERROR}} | returns the number of delivered messages with error per remote-container. The remote-container is expressed by its index. The output format is: {{<index>\!<value>}}, one remote container per line. If an index value is set on the command line, the output is limited to the provided index, and only the value is displayed. |
{code}
>./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o tcp-transporter -f delivered-outgoing-messages -- --query-containers SUCCEEDED

\\
'{{\-t}}' displays a human readable table of all values about delivered messages:
{code}
> ./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o tcp-transporter -f delivered-outgoing-messages -- -t

\\
'{{\--list-containers}}' returns the list of all remote-containers for which connections was established, since the last start of the transporter.
{code}
>./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o tcp-transporter -f incoming-connections -- --list-containers

\\
'{{\--query-containers}}' returns query result about remote container:
|| Query argument || Description ||
| {{NAME}} | returns remote container names by index. It is used to known which remote container name is associated to index. The output format is: {{<index>\!<remote-container>}}, one remote container per line. |
| {{MAX_ACTIVE}} | returns the *max number of active* connections per remote container. The remote container is expressed by its index. The output format is: {{<index>\!<value>}}, one remote container per line. If an index value is set on the command line, the output is limited to the provided index, and only the value is displayed. |
| {{ACTIVE}} | returns the *current number of active* connections per remote container. The remote container is expressed by its index. The output format is: {{<index>\!<value>}}, one remote container per line. If an index value is set on the command line, the output is limited to the provided index, and only the value is displayed. |
| {{MAX_IDLE}} | returns the \*max number of idle connections per remote container. The remote container is expressed by its index. The output format is: {{<index>\!<value>}}, one remote container per line. If an index value is set on the command line, the output is limited to the provided index, and only the value is displayed. |
| {{IDLE}} | returns the *current number of idle* connections per remote container. The remote container is expressed by its index. The output format is: {{<index>\!<value>}}, one remote container per line. If an index value is set on the command line, the output is limited to the provided index, and only the value is displayed. |
| {{ESTABLISHED}} | returns the *number of connections established* per remote-container since the last startup of the remote transporter. The remote-container is expressed by its index. The output format is: {{<index>\!<value>}}, one remote container per line. If an index value is set on the command line, the output is limited to the provided index, and only the value is displayed. |
{code}
>./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o tcp-transporter -f incoming-connections -- --query-containers ACTIVE

\\
'{{\-t}}' displays a human readable table of all values about delivered messages:
{code}
> ./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o tcp-transporter -f incoming-connections

\\
'{{\--list-containers}}' returns the list of all remote-containers for which messages was received, since the last start of the transporter.
{code}
>./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o tcp-transporter -f delivered-incoming-messages -- --list-containers

\\
'{{\--query-containers}}' returns query result about remote container:
|| Query argument || Description ||
| {{NAME}} | returns remote container names by index. It is used to known which remote container name is associated to index. The output format is: {{<index>\!<remote-container>}}, one remote container per line. |
| {{SUCCEEDED}} | returns the number of succeeded delivered messages per remote container. The remote container is expressed by its index. The output format is: {{<index>\!<value>}}, one remote container per line. If an index value is set on the command line, the output is limited to the provided index, and only the value is displayed. |
| {{PENDING}} | returns the number of pending message delivery per remote container. The remote container is expressed by its index. The output format is: {{<index>\!<value>}}, one remote container per line. If an index value is set on the command line, the output is limited to the provided index, and only the value is displayed. |
| {{ERROR}} | returns the number of delivered messages with error per remote-container. The remote-container is expressed by its index. The output format is: {{<index>\!<value>}}, one remote container per line. If an index value is set on the command line, the output is limited to the provided index, and only the value is displayed. |
{code}
>./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o tcp-transporter -f delivered-incoming-messages -- --query-containers SUCCEEDED

\\
'{{\-t}}' displays a human readable table of all values about delivered messages:
{code}
> ./petals-cli.sh -h localhost -n 7700 -u petals -p petals -c -- monitoring -o tcp-transporter -f delivered-incoming-messages -- -t

{anchor:subscription-objects}

h1. Subscription objects for Nagios

* {{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.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.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 ! \! |
* {{petals-se-flowable}}, associated to the Petals SE Flowable, detects:
|| Defect || Description ||
| {{org.ow2.petals.se.flowable.engine.async.executor.thread.pool.exhausted}} | No more thread is available in the asynchronous job executor thread pool to process tasks ! \! |

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: