JMX metrics reference list

With Open Liberty, you can access Java Management Extensions (JMX) metrics. JMX metrics are provided by MXBeans and can be used with JConsole or other JMX-based tools.

Enable the Perfomance Monitoring feature to monitor JMX metrics for your Open Liberty runtime environment. The following sections list the JMX metrics that are available for different monitoring capabilities:

JVM monitoring: JvmStats MXBean

You can use the JvmStats MXBean to monitor the JVM in Open Liberty. Each Open Liberty instance has one JvmStats MXBean.

The following attributes are available for the JvmStats MXBean. The object name of the MXBean for these attributes is WebSphere:type=JvmStats:

JvmStats MXBean attributes
MXBean attributeUnitsDescription

FreeMemory

Bytes

The free heap that’s available for the current JVM.

Heap

Bytes

The heap size that’s used for the current JVM.

GcCount

Not applicable

The number of times that garbage collection occurred since the JVM started.

GcTime

Milliseconds

The total accumulated value of garbage collection time.

ProcessCPU

Not applicable

The percentage of CPU that’s being used by the JVM process.

UpTime

Milliseconds

The time since the JVM started.

UsedMemory

Bytes

The used heap for the current JVM.

Request monitoring: RequestTimingStats MXBean

You can use the RequestTimingStats MXBean to collect request data to see how the Open Liberty server is performing in comparison with set goals. Servlet requests that are identified by the name of Servlet are tracked.

The following attributes are available for the RequestTimingStats MXBean. The object name of the MXBean for these attributes is WebSphere:type=RequestTimingStats,name=*:

RequestTimingStats MXBean attributes
MXBean attributeUnitsDescription

ActiveRequestCount

Not applicable

The total requests that are currently running.

HungRequestCount

Not applicable

The total requests in flight that are deemed hung.

RequestCount

Not applicable

The total requests since the server started.

SlowRequestCount

Not applicable

The total requests that are running and are deemed slow.

Servlet monitoring: ServletStats MXBean

You can use the ServletStats MXBean to monitor web applications in Open Liberty. Performance data is available for each servlet in a web application. Each servlet has its own MXBean.

The following attributes are available for the ServletStats MXBean. The object name of the MXBean for these attributes is WebSphere:type=ServletStats,name=<AppName>.<ServletName>:

ServletStats MXBean attributes
MXBean attributeUnitsDescription

AppName

Not applicable

The name of the application.

Description

Not applicable

The description of the counter.

RequestCount

Not applicable

The total requests to the servlet.

RequestCountDetails

Not applicable

Details about the RequestCount attribute value, including the last time stamp.

ResponseTime

Nanoseconds

The average response time.

ResponseTimeDetails

Nanoseconds

Details about the ResponseTime attribute value, including the number of snapshots that are taken, minimum values, and maximum values.

ServletName

Not applicable

The name of the servlet.

Thread pool monitoring: ThreadPoolStats MXBean

You can use the ThreadPoolStats MXBean to monitor the thread pool in Open Liberty. All web requests run in the Default Executor thread pool, and you can monitor the usage of this thread pool with the ThreadPoolStats MXBean.

The following attributes are available for the ThreadPoolStats MXBean. The object name of the MXBean for these attributes is WebSphere:type=ThreadPoolStats,name=Default Executor:

ThreadPoolStats MXBean attributes
MXBean attributeUnitsDescription

ActiveThreads

Not applicable

The number of threads that are active.

PoolName

Not applicable

The name of the thread pool.

PoolSize

Not applicable

The size of the thread pool.

JAX-WS monitoring: WebServiceStats MXBean

You can use the WebServiceStats MXBean for JAX-WS monitoring of Open Liberty. Performance data is available for each endpoint and operation in a JAX-WS application, and each web service endpoint has its own MXBean.

The following attributes are available for the WebServiceStats MXBean. The object name of the MXBean for these attributes is org.apache.cxf:bus.id=<bus.name>,type=Performance.Counter.Server,service="<NameSpace><ServiceName>",port="<PortName>" or org.apache.cxf:bus.id=<bus.name>,type=Performance.Counter.Client,service="<NameSpace><ServiceName>",port="<PortName>":

WebServiceStats MXBean attributes
MXBean attributeUnitsDescription

AvgResponseTime

Milliseconds

The average response time.

MaxResponseTime

Milliseconds

The maximum response time.

MinResponseTime

Milliseconds

The minimum response time.

NumInvocations

Not applicable

The number of invocations to the endpoint or operation.

NumCheckedApplicationFaults

Not applicable

The number of checked application faults.

NumLogicalRuntimeFaluts

Not applicable

The number of logical runtime faults.

NumRuntimeFaults

Not applicable

The number of runtime faults.

NumUnCheckedApplicationFaults

Not applicable

The number of unchecked application faults.

TotalHandlingTime

Milliseconds

The total response handling time.

Session monitoring: SessionStats MXBean

You can use the SessionStats MXBean to monitor performance data of sessions for each application in Open Liberty. The sessions that are associated with a single web application have their own SessionStats MXBean, meaning that one SessionStats MXBean exists for each web application.

The following attributes are available for the SessionStats MXBean. The object name of the MXBean for these attributes is WebSphere:type=SessionStats,name=*:

SessionStats MXBean attributes
MXBean attributeUnitsDescription

ActiveCount

Not applicable

The total number of concurrently active sessions. A session is active if Open Liberty is processing a request that uses that session.

CreateCount

Not applicable

The total number of sessions created.

InvalidatedCount

Not applicable

The total number of sessions that are invalidated.

InvalidatedCountbyTimeout

Not applicable

The total number of sessions that are invalidated by a timeout.

LiveCount

Not applicable

The total number of sessions that are currently cached in memory.

Connection pool monitoring: ConnectionPool MXBean

You can use the ConnectionPool MXBean to monitor connection pools in Open Liberty. Connection pools manage connections from data sources and connection factories, and performance data is made available for each connection pool. The ConnectionPool MXBean is responsible for reporting metrics for a single connection pool.

The following attributes are available for the ConnectionPool MXBean. The object name of the MXBean for these attributes is WebSphere:type=ConnectionPoolStats,name=<IDENTIFIER_OF_CONNECTION_MANAGER>:

ConnectionPool MXBean attributes
MXBean attributeUnitsDescription

CreateCount

Not applicable

The total number of managed connections that have been created since pool creation.

ConnectionHandleCount

Not applicable

The number of connections that are in use. This number might include multiple connections that are shared from a single managed connection.

DestroyCount

Not applicable

The total number of managed connections that were destroyed since pool creation.

FreeConnectionCount

Not applicable

The number of managed connections in the free pool.

InUseTime

Milliseconds

The average time that a connection is in use.

InUseTimeDetails

Milliseconds

In-use time details that include minimum in-use time, maximum in-use time, and the total number of granted connections, excluding the connections that are currently in use.

ManagedConnectionCount

Not applicable

The total number of managed connections in the free, shared, and unshared pools.

WaitTime

Milliseconds

The average wait time until a connection is granted if a connection is not currently available.

WaitTimeDetails

Milliseconds

Wait-time details that include minimum wait time, maximum wait time, and the total number of queued requests.

RESTful resource method monitoring: RestStats MXBean

You can use the RestStats MXBean to monitor RESTful resource methods in Open Liberty. Performance data is available for each RESTful resource method in the web application, and each method has its own MXBean.

The following attributes are available for the RestStats MXBean. The object name of the MXBean for these attributes is WebSphere:type=RestStats,name=*:

RestStats MXBean attributes
MXBean attributeUnitsDescription

AppName

Not applicable

The name of the application.

Description

Not applicable

A general description of these attributes.

MethodName

Not applicable

The name of the RESTful resource method.

MinuteLatest

Minute

The most recent minute in which an update was made to this MXBean. For example, if updates were most recently made at 12:00 and 12:05, the value of the MinuteLatest attribute is 12:05. The most recent minute can be the current minute.

MinuteLatestMaximumDuration

Nanoseconds

The longest recorded ResponseTime attribute within the most recent minute in which an update was made to this MXBean. For example, if updates were most recently made at 12:00 and 12:05, the value of the MinuteLatestMaximumDuration attribute is the longest recorded ResponseTime attribute within the minute of 12:05. For this attribute, being within a minute is defined as 0:00:00 to 0:59:999. The most recent minute can be the current minute.

MinuteLatestMinimumDuration

Nanoseconds

The shortest recorded ResponseTime attribute within the most recent minute in which an update was made to this MXBean. For example, if updates were most recently made at 12:00 and 12:05, the value of the MinuteLatestMinimumDuration attribute is the shortest recorded ResponseTime attribute within the minute of 12:05. For this attribute, being within a minute is defined as 0:00:00 to 0:59:999. The most recent minute can be the current minute.

MinutePrevious

Minute

The second-most recent minute in which an update was made to this MXBean. For example, if updates were most recently made at 12:00 and 12:05, the value of the MinutePrevious attribute is 12:00.

MinutePreviousMaximumDuration

Nanoseconds

The longest recorded ResponseTime attribute within the second-most recent minute in which an update was made to this MXBean. For example, if updates were most recently made at 12:00 and 12:05, the value of the MinutePreviousMaximumDuration attribute is the longest recorded ResponseTime attribute within the minute of 12:00. For this attribute, being within a minute is defined as 0:00:00 to 0:59:999.

MinutePreviousMinimumDuration

Nanoseconds

The shortest recorded ResponseTime attribute within the second-most recent minute in which an update was made to this MXBean. For example, if updates were most recently made at 12:00 and 12:05, the value of the MinutePreviousMinimumDuration attribute is the shortest recorded ResponseTime attribute within the minute of 12:00. For this attribute, being within a minute is defined as 0:00:00 to 0:59:999.

RequestCount

Not applicable

The number of hits to this RESTful resource method.

RequestCountDetails

Not applicable

Details about the RequestCount attribute value, including the request count.

ResponseTime

Nanoseconds

The total response time.

ResponseTimeDetails

Not applicable

Details about the ResponseTime attribute value, including the number of snapshots that are taken, minimum values, and maximum values.

gRPC server monitoring: GrpcServerStats MXBean

You can use the GrpcServerStats MXBean to monitor gRPC services. Performance data is available for each service.

The following attributes are available for the GrpcServerStats MXBean. The object name of the MXBean for these attributes is WebSphere:type=GrpcServerStats,name=*":

GrpcServerStats MXBean attributes
MXBean attributeUnitsDescription

AppName

Not applicable

The application name.

ReceivedMessagesCount

Not applicable

The number of stream messages received from the client.

ResponseTime

Milliseconds

The response time of completed RPCs.

RpcCompletedCount

Not applicable

The number of RPCs completed on the server, regardless of success or failure.

RpcStartedCount

Not applicable

The number of RPCs started on the server.

SentMessagesCount

Not applicable

The number of stream messages sent by the server.

ServiceName

Not applicable

The gRPC service name.

gRPC client monitoring: GrpcClientStats MXBean

You can use the GrpcClientStats MXBean to monitor gRPC services. Performance data is available for each service.

The following attributes are available for the GrpcClientStats MXBean. The object name of the MXBean for these attributes is WebSphere:type=GrpcClientStats,name=*":

GrpcClientStats MXBean attributes
MXBean attributeUnitsDescription

ReceivedMessagesCount

Not applicable

The number of stream messages received from the server.

ResponseTime

Milliseconds

The response time of completed RPCs.

RpcCompletedCount

Not applicable

The number of RPCs completed on the client, regardless of success or failure.

RpcStartedCount

Not applicable

The number of RPCs started on the client.

SentMessagesCount

Not applicable

The number of stream messages sent by the client.

ServiceName

Not applicable

The gRPC service name.

SIP application monitoring: SIP application MXBeans

Session Initiation Protocol (SIP) Performance Monitoring Infrastructure (PMI) is a component that collects SIP performance metrics from a running application server. With Open Liberty, the following types of SIP metrics are available:

Basic counters

The following table lists the SIP container basic counters. The object name of the MXBean for these counters is WebSphere:type=SipContainerBasicCounters,name=SipContainer.Basic. Because all the metrics that are listed in the following table are counters, no units are associated with them:

SIP container basic counter metrics
NameMXBean attribute or methodGranularityDescription

Incoming traffic

ReceivedSipMsgs

Server

The average number of messages that are handled by the container and calculated over a configurable period.

New SIP application sessions

NewSipApplications

Server

The average number of new SIP application sessions that are created in the container and calculated over a configurable period.

Number of active SIP application sessions

SipAppSessions

Server

The number of SIP application sessions that belong to each application.

Number of active SIP sessions

SipSessions

Server

The number of SIP sessions that belong to each application.

Queue size

InvokerSize

Server

The size of the invoke queue in the SIP container.

Rejected SIP messages

RejectedMessages

Server

The number of rejected SIP messages.

Response time

SipRequestProcessing

Server

The average amount of time between when a message gets into the container and when a response is sent from the container.

SIP timer invocations

SipTimersInvocations

Server

The number of invocations of the SIP timers.

Inbound requests

The following table lists the SIP container inbound requests. The object name of the MXBean for these requests is WebSphere:type=InboundRequestCounters,name=SipContainer.InboundRequest. Because all the metrics that are listed in the following table are counters, no units are associated with them:

SIP container inbound request metrics
NameMXBean attribute or methodGranularityDescription

Number of inbound ACK requests

getTotalInboundRequests(appName, “ACK”);

Application

The number of inbound ACK requests that belong to each application.

Number of inbound BYE requests

getTotalInboundRequests(appName, “BYE”);

Application

The number of inbound BYE requests that belong to each application.

Number of inbound CANCEL requests

getTotalInboundRequests(appName, “CANCEL”);

Application

The number of inbound CANCEL requests that belong to each application.

Number of inbound INFO requests

getTotalInboundRequests(appName, “INFO”);

Application

The number of inbound INFO requests that belong to each application.

Number of inbound INVITE requests

getTotalInboundRequests(appName, “INVITE”);

Application

The number of inbound INVITE requests that belong to each application.

Number of inbound MESSAGE requests

getTotalInboundRequests(appName, “MESSAGE”);

Application

The number of inbound MESSAGE requests that belong to each application.

Number of inbound NOT SIP STANDARD requests

getTotalInboundRequests(appName, “NOTSIPSTANDARD”);

Application

The number of inbound NOT SIP STANDARD requests that belong to each application.

Number of inbound NOTIFY requests

getTotalInboundRequests(appName, “NOTIFY”);

Application

The number of inbound NOTIFY requests that belong to each application.

Number of inbound OPTIONS requests

getTotalInboundRequests(appName, “OPTIONS”);

Application

The number of inbound OPTIONS requests that belong to each application.

Number of inbound PRACK requests

getTotalInboundRequests(appName, “PRACK”);

Application

The number of inbound PRACK requests that belong to each application.

Number of inbound PUBLISH requests

getTotalInboundRequests(appName, “PUBLISH”);

Application

The number of inbound PUBLISH requests that belong to each application.

Number of inbound REFER requests

getTotalInboundRequests(appName, “REFER”);

Application

The number of inbound REFER requests that belong to each application.

Number of inbound REGISTER requests

getTotalInboundRequests(appName, “REGISTER”);

Application

The number of inbound REGISTER requests that belong to each application.

Number of inbound SUBSCRIBE requests

getTotalInboundRequests(appName, “SUBSCRIBE”);

Application

The number of inbound SUBSCRIBE requests that belong to each application.

Number of inbound UPDATE requests

getTotalInboundRequests(appName, “UPDATE”);

Application

The number of inbound UPDATE requests that belong to each application.

Inbound responses

The following table lists the SIP container inbound responses. The object name of the MXBean for these responses is WebSphere:type=InboundResponseCounters,name=SipContainer.InboundResponse. Because all the metrics that are listed in the following table are counters, no units are associated with them:

SIP container inbound response metrics
NameMXBean attribute or methodGranularityDescription

Number of inbound 100 responses

getTotalInboundResponses(appName, “100”);

Application

The number of inbound 100 (Trying) responses that belong to each application.

Number of inbound 180 responses

getTotalInboundResponses(appName, “180”);

Application

The number of inbound 180 (Ringing) responses that belong to each application.

Number of inbound 181 responses

getTotalInboundResponses(appName, “181”);

Application

The number of inbound 181 (Call Being forwarded) responses that belong to each application.

Number of inbound 182 responses

getTotalInboundResponses(appName, “182”);

Application

The number of inbound 182 (Call Queued) responses that belong to each application.

Number of inbound 183 responses

getTotalInboundResponses(appName, “183”);

Application

The number of inbound 183 (Session Progress) responses that belong to each application.

Number of inbound 200 responses

getTotalInboundResponses(appName, “200”);

Application

The number of inbound 200 (OK) responses that belong to each application.

Number of inbound 202 responses

getTotalInboundResponses(appName, “202”);

Application

The number of inbound 202 (Accepted) responses that belong to each application.

Number of inbound 300 responses

getTotalInboundResponses(appName, “300”);

Application

The number of inbound 300 (Multiple Choices) responses that belong to each application.

Number of inbound 301 responses

getTotalInboundResponses(appName, “301”);

Application

The number of inbound 301 (Moved Permanently) responses that belong to each application.

Number of inbound 302 responses

getTotalInboundResponses(appName, “302”);

Application

The number of inbound 302 (Moved Temporarily) responses that belong to each application.

Number of inbound 305 responses

getTotalInboundResponses(appName, “305”);

Application

The number of inbound 305 (Use Proxy) responses that belong to each application.

Number of inbound 380 responses

getTotalInboundResponses(appName, “380”);

Application

The number of inbound 380 (Alternative Service) responses that belong to each application.

Number of inbound 400 responses

getTotalInboundResponses(appName, “400”);

Application

The number of inbound 400 (Bad Request) responses that belong to each application.

Number of inbound 401 responses

getTotalInboundResponses(appName, “401”);

Application

The number of inbound 401 (Unauthorized) responses that belong to each application.

Number of inbound 402 responses

getTotalInboundResponses(appName, “402”);

Application

The number of inbound 402 (Payment Required) responses that belong to each application.

Number of inbound 403 responses

getTotalInboundResponses(appName, “403”);

Application

The number of inbound 403 (Forbidden) responses that belong to each application.

Number of inbound 404 responses

getTotalInboundResponses(appName, “404”);

Application

The number of inbound 404 (Not Found) responses that belong to each application.

Number of inbound 405 responses

getTotalInboundResponses(appName, “405”);

Application

The number of inbound 405 (Method Not Allowed) responses that belong to each application.

Number of inbound 406 responses

getTotalInboundResponses(appName, “406”);

Application

The number of inbound 406 (Not Acceptable) responses that belong to each application.

Number of inbound 407 responses

getTotalInboundResponses(appName, “407”);

Application

The number of inbound 407 (Proxy Authentication Required) responses that belong to each application.

Number of inbound 408 responses

getTotalInboundResponses(appName, “408”);

Application

The number of inbound 408 (Request Timeout) responses that belong to each application.

Number of inbound 410 responses

getTotalInboundResponses(appName, “410”);

Application

The number of inbound 410 (Gone) responses that belong to each application.

Number of inbound 413 responses

getTotalInboundResponses(appName, “413”);

Application

The number of inbound 413 (Request Entity Too Large) responses that belong to each application.

Number of inbound 414 responses

getTotalInboundResponses(appName, “414”);

Application

The number of inbound 414 (Request URI Too Long) responses that belong to each application.

Number of inbound 415 responses

getTotalInboundResponses(appName, “415”);

Application

The number of inbound 415 (Unsupported Media Type) responses that belong to each application.

Number of inbound 416 responses

getTotalInboundResponses(appName, “416”);

Application

The number of inbound 416 (Unsupported URI Scheme) responses that belong to each application.

Number of inbound 420 responses

getTotalInboundResponses(appName, “420”);

Application

The number of inbound 420 (Bad Extension) responses that belong to each application.

Number of inbound 421 responses

getTotalInboundResponses(appName, “421”);

Application

The number of inbound 421 (Extension Required) responses that belong to each application.

Number of inbound 423 responses

getTotalInboundResponses(appName, “423”);

Application

The number of inbound 423 (Interval Too Brief) responses that belong to each application.

Number of inbound 480 responses

getTotalInboundResponses(appName, “480”);

Application

The number of inbound 480 (Temporarily Unavailable) responses that belong to each application.

Number of inbound 481 responses

getTotalInboundResponses(appName, “481”);

Application

The number of inbound 481 (Call Leg Done) responses that belong to each application.

Number of inbound 482 responses

getTotalInboundResponses(appName, “482”);

Application

The number of inbound 482 (Loop Detected) responses that belong to each application.

Number of inbound 483 responses

getTotalInboundResponses(appName, “483”);

Application

The number of inbound 483 (Too Many Hops) responses that belong to each application.

Number of inbound 484 responses

getTotalInboundResponses(appName, “484”);

Application

The number of inbound 484 (Address Incomplete) responses that belong to each application.

Number of inbound 485 responses

getTotalInboundResponses(appName, “485”);

Application

The number of inbound 485 (Ambiguous) responses that belong to each application.

Number of inbound 486 responses

getTotalInboundResponses(appName, “486”);

Application

The number of inbound 486 (Busy Here) responses that belong to each application.

Number of inbound 487 responses

getTotalInboundResponses(appName, “487”);

Application

The number of inbound 487 (Request Terminated) responses that belong to each application.

Number of inbound 488 responses

getTotalInboundResponses(appName, “488”);

Application

The number of inbound 488 (Not Acceptable Here) responses that belong to each application.

Number of inbound 491 responses

getTotalInboundResponses(appName, “491”);

Application

The number of inbound 491 (Request Pending) responses that belong to each application.

Number of inbound 493 responses

getTotalInboundResponses(appName, “493”);

Application

The number of inbound 493 (Undecipherable) responses that belong to each application.

Number of inbound 500 responses

getTotalInboundResponses(appName, “500”);

Application

The number of inbound 500 (Server Internal Error) responses that belong to each application.

Number of inbound 501 responses

getTotalInboundResponses(appName, “501”);

Application

The number of inbound 501 (Not Implemented) responses that belong to each application.

Number of inbound 502 responses

getTotalInboundResponses(appName, “502”);

Application

The number of inbound 502 (Bad Gateway) responses that belong to each application.

Number of inbound 503 responses

getTotalInboundResponses(appName, “503”);

Application

The number of inbound 503 (Service Unavailable) responses that belong to each application.

Number of inbound 504 responses

getTotalInboundResponses(appName, “504”);

Application

The number of inbound 504 (Server Timeout) responses that belong to each application.

Number of inbound 505 responses

getTotalInboundResponses(appName, “505”);

Application

The number of inbound 505 (Version Not Supported) responses that belong to each application.

Number of inbound 513 responses

getTotalInboundResponses(appName, “513”);

Application

The number of inbound 513 (Message Too Large) responses that belong to each application.

Number of inbound 600 responses

getTotalInboundResponses(appName, “600”);

Application

The number of inbound 600 (Busy Everywhere) responses that belong to each application.

Number of inbound 603 responses

getTotalInboundResponses(appName, “603”);

Application

The number of inbound 603 (Decline) responses that belong to each application.

Number of inbound 604 responses

etTotalInboundResponses(appName, “604”);

Application

The number of inbound 604 (Does Not Exit Anywhere) responses that belong to each application.

Number of inbound 606 responses

getTotalInboundResponses(appName, “606”);

Application

The number of inbound 606 (Not Acceptable Anywhere) responses that belong to each application.

Outbound requests

The following table lists the SIP container outbound requests. The object name of the MXBean for these requests is WebSphere:type=OutboundRequestCounters,name=SipContainer.OutboundRequest. Because all the metrics that are listed in the following table are counters, no units are associated with them:

SIP container outbound request metrics
NameMXBean attribute or methodGranularityDescription

Number of outbound ACK requests

getTotalOutboundRequests(appName, “ACK”);

Application

The number of outbound ACK requests that belong to each application.

Number of outbound BYE requests

getTotalOutboundRequests(appName, “BYE”);

Application

The number of outbound BYE requests that belong to each application.

Number of outbound CANCEL requests

getTotalOutboundRequests(appName, “CANCEL”);

Application

The number of outbound CANCEL requests that belong to each application.

Number of outbound INFO requests

getTotalOutboundRequests(appName, “INFO”);

Application

The number of outbound INFO requests that belong to each application.

Number of outbound INVITE requests

getTotalOutboundRequests(appName, “INVITE”);

Application

The number of outbound INVITE requests that belong to each application.

Number of outbound MESSAGE requests

getTotalOutboundRequests(appName, “MESSAGE”);

Application

The number of outbound MESSAGE requests that belong to each application.

Number of outbound NOT SIP STANDARD requests

getTotalOutboundRequests(appName, “NOTSIPSTANDARD”);

Application

The number of outbound NOT SIP STANDARD requests that belong to each application.

Number of outbound OPTIONS requests

getTotalOutboundRequests(appName, “OPTIONS”);

Application

The number of outbound OPTIONS requests that belong to each application.

Number of outbound NOTIFY requests

getTotalOutboundRequests(appName, “NOTIFY”);

Application

The number of outbound NOTIFY requests that belong to each application.

Number of outbound PRACK requests

getTotalOutboundRequests(appName, “PRACK”);

Application

The number of outbound PRACK requests that belong to each application.

Number of outbound PUBLISH requests

getTotalOutboundRequests(appName, “PUBLISH”);

Application

The number of outbound PUBLISH requests that belong to each application.

Number of outbound REFER requests

getTotalOutboundRequests(appName, “REFER”);

Application

The number of outbound REFER requests that belong to each application.

Number of outbound REGISTER requests

getTotalOutboundRequests(appName, “REGISTER”);

Application

The number of outbound REGISTER requests that belong to each application.

Number of outbound SUBSCRIBE requests

getTotalOutboundRequests(appName, “SUBSCRIBE”);

Application

The number of outbound SUBSCRIBE requests that belong to each application.

Number of outbound UPDATE requests

getTotalOutboundRequests(appName, “UPDATE”);

Application

The number of outbound UPDATE requests that belong to each application.

Outbound responses

The following table lists the SIP container outbound responses. The object name of the MXBean for these responses is WebSphere:type=OutboundResponseCounters,name=SipContainer.OutboundResponse. Because all the metrics that are listed in the following table are counters, no units are associated with them:

SIP container outbound response metrics
NameMXBean attribute or methodGranularityDescription

Number of outbound 100 responses

getTotalOutboundResponses(appName, “100”);

Application

The number of outbound 100 (Trying) responses that belong to each application.

Number of outbound 180 responses

getTotalOutboundResponses(appName, “180”);

Application

The number of outbound 180 (Ringing) responses that belong to each application.

Number of outbound 181 responses

getTotalOutboundResponses(appName, “181”);

Application

The number of outbound 181 (Call Being Forwarded) responses that belong to each application.

Number of outbound 182 responses

getTotalOutboundResponses(appName, “182”);

Application

The number of outbound 182 (Call Queued) responses that belong to each application.

Number of outbound 183 responses

getTotalOutboundResponses(appName, “183”);

Application

The number of outbound 183 (Session Progress) responses that belong to each application.

Number of outbound 200 responses

getTotalOutboundResponses(appName, “200”);

Application

The number of outbound 200 (OK) responses that belong to each application.

Number of outbound 202 responses

getTotalOutboundResponses(appName, “202”);

Application

The number of outbound 202 (Accepted) responses that belong to each application.

Number of outbound 300 responses

getTotalOutboundResponses(appName, “300”);

Application

The number of outbound 300 (Multiple Choices) responses that belong to each application.

Number of outbound 301 responses

getTotalOutboundResponses(appName, “301”);

Application

The number of outbound 301 (Moved Permanently) responses that belong to each application.

Number of outbound 302 responses

getTotalOutboundResponses(appName, “302”);

Application

The number of outbound 302 (Moved Temporarily) responses that belong to each application.

Number of outbound 305 responses

getTotalOutboundResponses(appName, “305”);

Application

The number of outbound 305 (Use Proxy) responses that belong to each application.

Number of outbound 380 responses

getTotalOutboundResponses(appName, “380”);

Application

The number of outbound 380 (Alternative Service) responses that belong to each application.

Number of outbound 400 responses

getTotalOutboundResponses(appName, “400”);

Application

The number of outbound 400 (Bad Request) responses that belong to each application.

Number of outbound 401 responses

getTotalOutboundResponses(appName, “401”);

Application

The number of outbound 401 (Unauthorized) responses that belong to each application.

Number of outbound 402 responses

getTotalOutboundResponses(appName, “402”);

Application

The number of outbound 402 (Payment Required) responses that belong to each application.

Number of outbound 403 responses

getTotalOutboundResponses(appName, “403”);

Application

The number of outbound 403 (Forbidden) responses that belong to each application.

Number of outbound 404 responses

getTotalOutboundResponses(appName, “404”);

Application

The number of outbound 404 (Not Found) responses that belong to each application.

Number of outbound 405 responses

getTotalOutboundResponses(appName, “405”);

Application

The number of outbound 405 (Method Not Allowed) responses that belong to each application.

Number of outbound 406 responses.

getTotalOutboundResponses(appName, “406”);

Application

The number of outbound 406 (Not Acceptable) responses that belong to each application.

Number of outbound 407 responses

getTotalOutboundResponses(appName, “407”);

Application

The number of outbound 407 (Proxy Authentication Required) responses that belong to each application.

Number of outbound 408 responses

getTotalOutboundResponses(appName, “408”);

Application

The number of outbound 408 (Request Timeout) responses that belong to each application.

Number of outbound 410 responses

getTotalOutboundResponses(appName, “410”);

Application

The number of outbound 410 (Gone) responses that belong to each application.

Number of outbound 413 responses

getTotalOutboundResponses(appName, “413”);

Application

The number of outbound 413 (Request Entity Too Large) responses that belong to each application.

Number of outbound 414 responses

getTotalOutboundResponses(appName, “414”);

Application

The number of outbound 414 (Request URI Too Long) responses that belong to each application.

Number of outbound 415 responses

getTotalOutboundResponses(appName, “415”);

Application

The number of outbound 415 (Unsupported Media Type) responses that belong to each application.

Number of outbound 416 responses

getTotalOutboundResponses(appName, “416”);

Application

The number of outbound 416 (Unsupported URI Scheme) responses that belong to each application.

Number of outbound 420 responses

getTotalOutboundResponses(appName, “420”);

Application

The number of outbound 420 (Bad Extension) responses that belong to each application.

Number of outbound 421 responses

getTotalOutboundResponses(appName, “421”);

Application

The number of outbound 421 (Extension Required) responses that belong to each application.

Number of outbound 423 responses

getTotalOutboundResponses(appName, “423”);

Application

The number of outbound 423 (Interval Too Brief) responses that belong to each application.

Number of outbound 480 responses

getTotalOutboundResponses(appName, “480”);

Application

The number of outbound 480 (Temporarily Unavailable) responses that belong to each application.

Number of outbound 481 responses

getTotalOutboundResponses(appName, “481”);

Application

The number of outbound 481 (Call Leg Done) responses that belong to each application.

Number of outbound 482 responses

getTotalOutboundResponses(appName, “482”);

Application

The number of outbound 482 (Loop Detected) responses that belong to each application.

Number of outbound 483 responses

getTotalOutboundResponses(appName, “483”);

Application

The number of outbound 483 (Too Many Hops) responses that belong to each application.

Number of outbound 484 responses

getTotalOutboundResponses(appName, “484”);

Application

The number of outbound 484 (Address Incomplete) responses that belong to each application.

Number of outbound 485 responses

getTotalOutboundResponses(appName, “485”);

Application

The number of outbound 485 (Ambiguous) responses that belong to each application.

Number of outbound 486 responses

getTotalOutboundResponses(appName, “486”);

Application

The number of outbound 486 (Busy Here) responses that belong to each application.

Number of outbound 487 responses

getTotalOutboundResponses(appName, “487”);

Application

The number of outbound 487 (Request Terminated) responses that belong to each application.

Number of outbound 488 responses

getTotalOutboundResponses(appName, “488”);

Application

The number of outbound 488 (Not Acceptable Here) responses that belong to each application.

Number of outbound 491 responses

getTotalOutboundResponses(appName, “491”);

Application

The number of outbound 491 (Request Pending) responses that belong to each application.

Number of outbound 493 responses

getTotalOutboundResponses(appName, “493”);

Application

The number of outbound 493 (Undecipherable) responses that belong to each application.

Number of outbound 500 responses

getTotalOutboundResponses(appName, “500”);

Application

The number of outbound 500 (Server Internal Error) responses that belong to each application.

Number of outbound 501 responses

getTotalOutboundResponses(appName, “501”);

Application

The number of outbound 501 (Not Implemented) responses that belong to each application.

Number of outbound 502 responses

getTotalOutboundResponses(appName, “502”);

Application

The number of outbound 502 (Bad Gateway) responses that belong to each application.

Number of outbound 503 responses

getTotalOutboundResponses(appName, “503”);

Application

The number of outbound 503 (Service Unavailable) responses that belong to each application.

Number of outbound 504 responses

getTotalOutboundResponses(appName, “504”);

Application

The number of outbound 504 (Server Timeout) responses that belong to each application.

Number of outbound 505 responses

getTotalOutboundResponses(appName, “505”);

Application

The number of outbound 505 (Version Not Supported) responses that belong to each application.

Number of outbound 513 responses

getTotalOutboundResponses(appName, “513”);

Application

The number of outbound 513 (Message Too Large) responses that belong to each application.

Number of outbound 600 responses

getTotalOutboundResponses(appName, “600”);

Application

The number of outbound 600 (Busy Everywhere) responses that belong to each application.

Number of outbound 603 responses

getTotalOutboundResponses(appName, “603”);

Application

The number of outbound 603 (Decline) responses that belong to each application.

Number of outbound 604 responses

etTotalOutboundResponses(appName, “604”);

Application

The number of outbound 604 (Does Not Exit Anywhere) responses that belong to each application.

Number of outbound 606 responses

getTotalOutboundResponses(appName, “606”);

Application

The number of outbound 606 (Not Acceptable Anywhere) responses that belong to each application.

Task duration metrics

The following table lists the SIP container task duration metrics. The object name of the MXBean for these metrics is WebSphere:type=TaskDurationCounters,name=SipContainer.TaskDuration:

SIP container task duration metrics
NameMXBean attribute or methodUnitsGranularityDescription

Average Task Duration in outbound queue

AvgTaskDurationOutBoundQueue

Milliseconds

Server

The average task duration in the SIP stack outbound queue over a configured window of time.

Maximum Task Duration in outbound queue

MaxTaskDurationOutBoundQueue

Milliseconds

Server

The maximum task duration in the SIP stack outbound queue over a configured window of time.

Minimum Task Duration in outbound queue

MinTaskDurationOutBoundQueue

Milliseconds

Server

The minimum task duration in the SIP stack outbound queue over a configured window of time.

Average Task Duration in processing queue

AvgTaskDurationInProcessingQueue

Milliseconds

Server

The average task duration in the SIP container processing queue over a configured window of time.

Maximum Task Duration in processing queue

MaxTaskDurationInProcessingQueue

Milliseconds

Server

The maximum task duration in the SIP container processing queue over a configured window of time.

Minimum Task Duration in processing queue

MinTaskDurationInProcessingQueue

Milliseconds

Server

The minimum task duration in the SIP container processing queue over a configured window of time.

Average Task Duration in application code

getAvgTaskDurationInApplication(appName)

Milliseconds

Application

The average task duration the SIP application code over a configured period.

Maximum Task Duration in application code

getMaxTaskDurationInApplication(appName)

Milliseconds

Application

The maximum task duration in the SIP application code over a configured period.

Minimum Task Duration in application code

getMinTaskDurationInApplication(appName)

Milliseconds

Application

The minimum task duration in the SIP application code over a configured period.

Queue monitoring counters

The following table lists the SIP container queue monitoring counters. The object name of the MXBean for these counters is WebSphere:type=QueueMonitoringModule,name=SipContainer.QueueMonitor. Because all the metrics that are listed in the following table are counters, no units are associated with them:

SIP container queue monitoring metrics
NameMXBean attribute or methodGranularityDescription

Total number of tasks that have flowed through the processing SIP container queue

TotalTasksCountInProcessingQueue

Server

The total number of tasks, such as messages or SIP timer events, that have flowed through the processing SIP container queue over a configured window of time.

Maximum number of tasks in the processing SIP container queue

PeakTasksCountInProcessingQueue

Server

The maximum number of tasks in the processing SIP container queue over a configured window of time.

Minimum number of tasks in the processing SIP container queue

MinTasksCountInProcessingQueue

Server

The minimum number of tasks in the processing SIP container queue over a configured window of time.

Maximum percent full of the processing SIP container queue

PercentageFullTasksCountInProcessingQueue

Server

The maximum processing SIP container queue usage percentage over a configured window of time.

Total number of tasks that have flowed through the outbound SIP stack queue

TotalTasksCountInOutboundQueue

Server

The total number of tasks that have flowed through the outbound SIP stack queue over a configured window of time.

Maximum number of tasks in the outbound SIP stack queue

PeakTasksCountInOutboundQueue

Server

The maximum number of tasks in the outbound SIP stack queue over a configured window of time.

Minimum number of tasks in the outbound SIP stack queue

MinTasksCountInOutboundQueue

Server

The minimum number of tasks in the outbound SIP stack queue over a configured window of time.

Maximum percent full of the outbound SIP stack queue

PercentageFullTasksCountInOutboundQueue

Server

The maximum outbound SIP stack queue usage percentage over a configured window of time.