Topic blueworx.status

The blueworx.status topic contains status events. The events are distinquised via the type. The events are either module or call related.

The module events contain both an index and sessionIndex. The sessionIndex represents a unique connection from a module. The index represents the current connection from a module. For example, if a BVR connects it will be index 1 and sessionIndex 1. If the BVR reconnects (due to network/BRM reconnection) the index will be 2 and the sessionIndex is 1.

Calls status

Overall call status for all accounts. Also contains call status broken down by account. Within each account this is further broken down by application and app mapping.

Table 1. JSON for Call status
Name Type Optional Description
type string No Always contains "call"
active number No Name of the active calls
cumulative number No Cumulative number of calls
accounts array No List of account status - see below Account status

Account status

Overall call status for a specific account. This further broken down by application and app mapping.

Table 2. JSON for Account status
Name Type Optional Description
id string No ID of the account
active number No Name of the active calls
cumulative number No Cumulative number of calls
applications array No List of application status - see below Application status
appMappings array No List of app mapping status - see below App mapping status

Application status

Overall call status for a specific application.

Table 3. JSON for Application status
Name Type Optional Description
id string No ID of the application
active number No Name of the active calls
cumulative number No Cumulative number of calls

App mapping status

Overall call status for a specific app mapping.

Table 4. JSON for App mapping status
Name Type Optional Description
id string No ID of the app mapping
active number No Name of the active calls
cumulative number No Cumulative number of calls

Example

{
    "type": "call",
    "active": 1,
    "cumulative": 1,
    "accounts": [
        {
            "id": "0x00000000",
            "active": 1,
            "cumulative": 1,
            "applications": [
                {
                    "id": "0x10000000",
                    "active": 0,
                    "cumulative": 0
                },
                {
                    "id": "0x00000003",
                    "active": 1,
                    "cumulative": 1
                },
                {
                    "id": "0x1000FFFF",
                    "active": 0,
                    "cumulative": 0
                }
            ],
            "appMappings": [
                {
                    "id": "0x20000000",
                    "active": 0,
                    "cumulative": 0
                },
                {
                    "id": "0x00000004",
                    "active": 1,
                    "cumulative": 1
                }
            ]
        }
    ]
}

BVR status

Status of a BVR component. All memory, threads and uptime information concerns the specific JVM/BVR and not the machine. The streaming related information details RTP related streaming of audio.

Table 5. JSON for BVR
Name Type Optional Description
type string No Always contains "bvr"
name string No Name of the BVR
hostName string No Host name
hostIP string No Host IP address
index number No Index of the BVR
sessionIndex number No Unique index of the BVR
memoryTotal number No Total memory of the JVM in MB
memoryUsed number No Used memory of the JVM in MB
memoryFree number No Free memory of the JVM in MB
memoryMax number No Max used memory of the JVM in MB
threads number No Threads running in the JVM
systemUptime number No Uptime of the JVM in seconds
warnings number No Number of warnings
error number No Number of errors
availableProcessors number No Processors
load number No System load
callActive number No Active number of calls
callActiveTTS number No Active number of TTS sessions
callActiveASR number No Active number of ASR sessions
callMaxCapacity number No Maximum call capacity
callSuccessfulInbound number No Number of successful inbound calls
callSuccessfulOutbound number No Number of successful outbound calls
callFailed number No Number of failed calls
ccxmlMultiCalls number No Number of CCXML multi call sessions
ccxmlSingleCalls number No Number of CCXML single call sessions
streamingChannels number No Number of streaming/RTP channels
streamingLockContention number No Waiting count due lock contention
streamingLastIH duration No Last interrupt handler duration
streamingMaxIH duration No Max interrupt handler duration
streamingSentPackets number No Packets sent by streaming/RTP
streamingReceivedPackets number No Packets received by streaming/RTP

Example

{
    "type": "bvr",
    "name": "BVR Linux 7.13.0-109 intel",
    "hostName": "machine",
    "hostIP": "1.2.3.4",
    "index": 5,
    "sessionIndex": 5,
    "memoryTotal": 115,
    "memoryUsed": 60,
    "memoryFree": 54,
    "memoryMax": 1301,
    "threads": 309,
    "systemUptime": 15,
    "availableProcessors": 8,
    "load": 0.14,
    "callActive": 1,
    "callMaxCapacity": 500,
    "callSuccessfulInbound": 1,
    "callSuccessfulOutbound": 0,
    "callFailed": 0,
    "callActiveTTS": 1,
    "callActiveASR": 0,
    "warnings": 1,
    "error": 0,
    "ccxmlMultiCalls": 0,
    "ccxmlSingleCalls": 0,
    "streamingChannels": 1,
    "streamingLockContention": 0,
    "streamingLastIH": 241,
    "streamingMaxIH": 4656,
    "streamingSentPackets": 165,
    "streamingReceivedPackets": 238
}

BRM status

Status of a BRM component. All memory, threads and uptime information concerns the specific JVM/BRM and not the machine.

Table 6. JSON for BRM
Name Type Optional Description
type string No Always contains "brm"
name string No Name of the BRM
hostName string No Host name
hostIP string No Host IP address
index number No Index of the BRM
sessionIndex number No Unique index of the BRM
memoryTotal number No Total memory of the JVM in MB
memoryUsed number No Used memory of the JVM in MB
memoryFree number No Free memory of the JVM in MB
memoryMax number No Max used memory of the JVM in MB
threads number No Threads running in the JVM
systemUptime number No Uptime of the JVM in seconds
warnings number No Number of warnings
error number No Number of errors
availableProcessors number No Processors
load number No System load

Example

{
    "type": "brm",
    "name": "BRM 7.13.0-109 intel",
    "hostName": "machine",
    "hostIP": "1.2.3.4",
    "index": 2,
    "sessionIndex": 2,
    "memoryTotal": 162,
    "memoryUsed": 88,
    "memoryFree": 73,
    "memoryMax": 1301,
    "threads": 21,
    "systemUptime": 120,
    "warnings": 0,
    "error": 0,
    "availableProcessors": 8,
    "load": 0.15
}

BAM status

Status of a BAM component. All memory, threads and uptime information concerns the specific JVM/BAM and not the machine.

Table 7. JSON for BAM
Name Type Optional Description
type string No Always contains "bam"
name string No Name of the BAM
hostName string No Host name
hostIP string No Host IP address
index number No Index of the BAM
sessionIndex number No Unique index of the BAM
memoryTotal number No Total memory of the JVM in MB
memoryUsed number No Used memory of the JVM in MB
memoryFree number No Free memory of the JVM in MB
memoryMax number No Max used memory of the JVM in MB
threads number No Threads running in the JVM
systemUptime number No Uptime of the JVM in seconds
warnings number No Number of warnings
error number No Number of errors
availableProcessors number No Processors
load number No System load

Example

{
    "type": "bam",
    "name": "BAM 7.13.0-109 intel",
    "hostName": "machine",
    "hostIP": "1.2.3.4",
    "index": 0,
    "sessionIndex": 0,
    "memoryTotal": 88,
    "memoryUsed": 16,
    "memoryFree": 72,
    "memoryMax": 1301,
    "threads": 22,
    "systemUptime": 10,
    "warnings": 0,
    "error": 0,
    "availableProcessors": 8,
    "load": 0.14
}