fetch_client_statistics

Definition

To display service time statistics for one or several connected SAP CC charging clients

Command Usage

Syntax

fetch_client_statistics <CLIENT>

Command Arguments
Name Description
<CLIENT> The charging client for which the service time statistics must be displayed. Can be specified using <dispatcherClientId>, <hostname>:<port>, or * (all clients).

Detailed Information

The fetch_client_statistics command displays service time statistics for one or all connected SAP CC charging client(s).

For each charging client, two types of information are displayed:

  • General information about the charging client itself
  • Information about the operations executed by the charging client

The general information about the charging client includes:

  • DISPATCHER_NAME, which corresponds to the instance ID of the dispatcher the charging client is connected to
  • DISPATCHER_CLIENT_ID, which corresponds to the identifier of the charging client in the dispatcher instance
  • CONNECTION_DATE, which corresponds to the last date when the charging client connected to the SAP CC system
  • NAME, which corresponds to the name of the charging client
  • START_DATE, which corresponds to the date when the charging client started
  • UPTIME, which corresponds to the duration during which the charging client was available
  • PID, which corresponds to the process identifier of the charging client
  • LOCAL_SOCKET_ADDRESS, which corresponds to the host and port the charging client is connected from
  • REMOTE_SOCKET_ADDRESS, which corresponds to the host and port the charging client is connected to (on the dispatcher instance)

The information about the operations executed by the charging client relies on a list of sensors which contain details about the executions of each operation type.

These sensors are divided in 2 categories, with 2 different formats for the names of the sensors:

  • The sensors dedicated to the operation calls which are performed by the the charging client
  • The sensors dedicated to the responses which are returned by the server and processed by the charging client

For sensors dedicated to the operation calls, the names of the sensors are made up with the following 3 elements, each element separated by the '_' character:

  • The type of the charging client
  • The type of the operation
  • The subtype of the operation

For sensors dedicated to the responses, the names of the sensors are made up with the following 4 elements, each element separated by the '_' character:

  • The type of the charging client
  • The type of the operation
  • The type of the response
  • The subtype of the response

The possible values for the charging client type are:

  • BA: batch service client
  • SF: stateful service client

The possible values for the operation type are:

  • CHARGE
  • BLANK_CHARGE
  • ESTIMATED_PRICE
  • CHECK_LIMIT
  • PRE_RATE
  • POST_RATE
  • ACTIVATE
  • CLEANUP
  • TRANSLATE
  • SESSION_START
  • SESSION_UPDATE
  • SESSION_STOP
  • MONITOR_SPENDING_STATUS
  • BATCH_CHARGE
  • LOOKUP
  • START_RERATING
  • START_COLLECTION_RERATING
  • STOP_RERATING
  • PING_RERATING
  • ACQUIRE

The possible values for the response type are:

  • R: result
  • XFC: forbidden charge exception
  • XTC: transaction clearing exception
  • XCF: communication failure exception
  • XIA: illegal argument exception
  • XSF: server failure exception
  • XII: invalid item exception
  • XCI: cannot inverse exception
  • XPR: prerate exception
  • XPO: postrate exception
  • XAC: activation exception
  • XCL: cleanup exception
  • XDN: does not exist exception
  • XSAR: start rate exception
  • XUR: update rate exception
  • XSOR: stop rate exception
  • XSO: session operation exception
  • XBC: batch charge exception
  • XRS: rerating exception

The possible values for the operation subtype are:

  • FC: Flow control (time spent on flow control)
  • NE: Network (time spent on network communications)

The possible values for the response subtype are:

  • SE: Server (time spent by the server to process the operations)
  • PR: Process (time spent to process the operations, equals to FC + NE + SE)
  • CU: Custom (time spent by listeners to process responses from the server)
  • TT: Total time (total time spent to process the operations and the responses, equals to PR + CU)

Each generated line corresponds to a sensor for a particular thread, and is displayed using a CSV format containing the following columns:

  • The name of the sensor (as described above)
  • The name of the thread. If the value is TOTAL, the information corresponds to the aggregation of all sensors with the same name for all threads. If the value is threadsRemoved, the information corresponds to the aggregation of all sensors for all removed threads.
  • The number of hits for the sensor
  • The total duration recorded by the sensor (explained in milliseconds)
  • The remaining columns distribute the number if hits over the following duration thresholds: <1ms, <2ms, <4ms, <6ms, <10ms, <15ms, <20ms, <30ms, <50ms, <80ms, <125ms, <250ms, <500ms, <1s, <2s, <4s and >=4s

Authorization

You must have a specific role in your SAP CC user profile. Refer to the SAP CC Security Guide for more information about the necessary authorizations.

See Also

list_clients - To display the list of connected SAP CC charging clients

Messages

Code Message Action
fetchClientStatistics.noClients No charging client connected.  
fetchClientStatistics.noClients No charging client connected.  
fetchClientStatistics.invalidArguments Invalid argument(s).  
fetchClientStatistics.invalidHostname Invalid hostname: {hostname}:{port}  
fetchClientStatistics.invalidPort Invalid port: {hostname}:{port}  
fetchClientStatistics.unknownClient Unknown charging client: {hostname}:{port}