The blueworx.status topic contains status events. The type field details the underlying type of the event which can be either call or module 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.
The blueworx.status topic supports the following headers.
| Header | Value |
|---|---|
| Type | Call, BVR, BRM or BAM |
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.
| Name | Type | Optional | Description |
|---|---|---|---|
| type | string | No | Always contains "call" |
| active | number | No | Number of active calls |
| cumulative | number | No | Cumulative number of calls |
| accounts | array | No | List of Account Status |
Account Status
Overall call status for a specific account. This further broken down by application and app mapping.
| Name | Type | Optional | Description |
|---|---|---|---|
| id | string | No | ID of the account |
| name | string | No | Name of the account |
| active | number | No | Number of active calls |
| cumulative | number | No | Cumulative number of calls |
| highWaterMarkHour | number | No | Highest number of active calls in the last hour |
| highWaterMarkDay | number | No | Highest number of active calls in the last day |
| highWaterMarkWeek | number | No | Highest number of active calls in the last week |
| applications | array | No | List of Application Status |
| appMappings | array | No | List of App Mapping Status |
Application status
Overall call status for a specific application.
| Name | Type | Optional | Description |
|---|---|---|---|
| id | string | No | Application ID |
| name | string | No | Name of the application |
| uri | string | No | Application URI |
| active | number | No | Number of active calls |
| cumulative | number | No | Cumulative number of calls |
| highWaterMarkHour | number | No | Highest number of active calls in the last hour |
| highWaterMarkDay | number | No | Highest number of active calls in the last day |
| highWaterMarkWeek | number | No | Highest number of active calls in the last week |
App Mapping Status
Overall call status for a specific app mapping.
| Name | Type | Optional | Description |
|---|---|---|---|
| id | string | No | Application mapping ID |
| mapping | string | No | Application mapping SIP user |
| active | number | No | Number of active calls |
| cumulative | number | No | Cumulative number of calls |
| highWaterMarkHour | number | No | Highest number of active calls in the last hour |
| highWaterMarkDay | number | No | Highest number of active calls in the last day |
| highWaterMarkWeek | number | No | Highest number of active calls in the last week |
Example
{
"type": "call",
"customer": 0,
"active": 0,
"cumulative": 18,
"accounts": [
{
"id": "0x00000000",
"name": "Admin Account",
"active": 0,
"cumulative": 1,
"highWaterMarkHour": 1,
"highWaterMarkDay": 1,
"highWaterMarkWeek": 1,
"applications": [
{
"id": "0x10000000",
"name": "Sample Application",
"uri": "file:///opt/blueworx/vr/sample/Welcome.vxml",
"active": 0,
"cumulative": 0,
"highWaterMarkHour": 0,
"highWaterMarkDay": 0,
"highWaterMarkWeek": 0
},
{
"id": "0x00000001",
"name": "1000Welcomes",
"uri": "file:///opt/blueworx/vr/sample/1000Welcomes.vxml",
"active": 0,
"cumulative": 0,
"highWaterMarkHour": 0,
"highWaterMarkDay": 0,
"highWaterMarkWeek": 0
},
{
"id": "0x00000022",
"name": "DF Blueworx_dev",
"uri": "file:///bvr_apps/DialogFlow_bwdev.ccxml",
"active": 0,
"cumulative": 0,
"highWaterMarkHour": 0,
"highWaterMarkDay": 0,
"highWaterMarkWeek": 0
},
{
"id": "0x00000003",
"name": "WatsonCCXML",
"uri": "file:///bvr_apps/WatsonSample.ccxml",
"active": 0,
"cumulative": 0,
"highWaterMarkHour": 0,
"highWaterMarkDay": 0,
"highWaterMarkWeek": 0
},
{
"id": "0x00000028",
"name": "BlueworxIDEIVRAppStart_IVR",
"uri": "file:///bvr_apps/router.ccxml",
"active": 0,
"cumulative": 0,
"highWaterMarkHour": 0,
"highWaterMarkDay": 0,
"highWaterMarkWeek": 0
},
{
"id": "0x00000009",
"name": "DialogFlow Virtual Assistant",
"uri": "file:///bvr_apps/VirtualAssistantSample.vxml",
"active": 0,
"cumulative": 0,
"highWaterMarkHour": 0,
"highWaterMarkDay": 0,
"highWaterMarkWeek": 0
},
{
"id": "0x0000000A",
"name": "weather",
"uri": "file:///bvr_apps/Lumenvox/en_US/Weather.vxml",
"active": 0,
"cumulative": 0,
"highWaterMarkHour": 0,
"highWaterMarkDay": 0,
"highWaterMarkWeek": 0
},
{
"id": "0x0000000B",
"name": "RecordUtterance",
"uri": "file:///bvr_apps/nocache/pdb/test_dtmf_menu_saveaudio.vxml",
"active": 0,
"cumulative": 0,
"highWaterMarkHour": 0,
"highWaterMarkDay": 0,
"highWaterMarkWeek": 0
},
{
"id": "0x0000002F",
"name": "ccxml_nocache_maxage1",
"uri": "file:///bvr_apps/cache_tests/nocache_maxage1/Welcome.ccxml?callId=CCXID-CCXML_btele_0007",
"active": 0,
"cumulative": 0,
"highWaterMarkHour": 0,
"highWaterMarkDay": 0,
"highWaterMarkWeek": 0
},
{
"id": "0x00000011",
"name": "RecordUtterance_DTMF_Submit",
"uri": "file:///bvr_apps/nocache/record_tests/test_dtmf_menu_saveaudio.vxml",
"active": 0,
"cumulative": 0,
"highWaterMarkHour": 0,
"highWaterMarkDay": 0,
"highWaterMarkWeek": 0
},
{
"id": "0x00000031",
"name": "lex",
"uri": "file:///bvr_apps/regression_tests/dialogueLex.ccxml",
"active": 0,
"cumulative": 0,
"highWaterMarkHour": 0,
"highWaterMarkDay": 0,
"highWaterMarkWeek": 0
},
{
"id": "0x00000013",
"name": "DialogFlow_Own_STT_TTS",
"uri": "file:///bvr_apps/DialogFlowSample.ccxml",
"active": 0,
"cumulative": 1,
"highWaterMarkHour": 1,
"highWaterMarkDay": 1,
"highWaterMarkWeek": 1
},
{
"id": "0x00000014",
"name": "DialogFlow_External_TTS_STT",
"uri": "file:///bvr_apps/DialogFlowSample.ccxml",
"active": 0,
"cumulative": 0,
"highWaterMarkHour": 0,
"highWaterMarkDay": 0,
"highWaterMarkWeek": 0
},
{
"id": "0x0000001F",
"name": "Watson Virtual Assistant",
"uri": "file:///bvr_apps/VirtualAssistantSample_Watson.vxml",
"active": 0,
"cumulative": 0,
"highWaterMarkHour": 0,
"highWaterMarkDay": 0,
"highWaterMarkWeek": 0
},
{
"id": "0x1000FFFF",
"name": "outbound",
"uri": "N/A",
"active": 0,
"cumulative": 0,
"highWaterMarkHour": 0,
"highWaterMarkDay": 0,
"highWaterMarkWeek": 0
}
],
"appMappings": [
{
"id": "0x20000000",
"mapping": "1001",
"active": 0,
"cumulative": 0,
"highWaterMarkHour": 0,
"highWaterMarkDay": 0,
"highWaterMarkWeek": 0
},
{
"id": "0x00000020",
"mapping": "watson_virtualassistant",
"active": 0,
"cumulative": 0,
"highWaterMarkHour": 0,
"highWaterMarkDay": 0,
"highWaterMarkWeek": 0
},
{
"id": "0x00000002",
"mapping": "1000Welcomes",
"active": 0,
"cumulative": 0,
"highWaterMarkHour": 0,
"highWaterMarkDay": 0,
"highWaterMarkWeek": 0
},
{
"id": "0x00000023",
"mapping": "bwdevdf",
"active": 0,
"cumulative": 0,
"highWaterMarkHour": 0,
"highWaterMarkDay": 0,
"highWaterMarkWeek": 0
},
{
"id": "0x00000029",
"mapping": "ddv",
"active": 0,
"cumulative": 0,
"highWaterMarkHour": 0,
"highWaterMarkDay": 0,
"highWaterMarkWeek": 0
},
{
"id": "0x0000000C",
"mapping": "recordutterance",
"active": 0,
"cumulative": 0,
"highWaterMarkHour": 0,
"highWaterMarkDay": 0,
"highWaterMarkWeek": 0
},
{
"id": "0x0000000D",
"mapping": "df_virtualassistant",
"active": 0,
"cumulative": 0,
"highWaterMarkHour": 0,
"highWaterMarkDay": 0,
"highWaterMarkWeek": 0
},
{
"id": "0x0000000E",
"mapping": "watson",
"active": 0,
"cumulative": 0,
"highWaterMarkHour": 0,
"highWaterMarkDay": 0,
"highWaterMarkWeek": 0
},
{
"id": "0x0000000F",
"mapping": "weather",
"active": 0,
"cumulative": 0,
"highWaterMarkHour": 0,
"highWaterMarkDay": 0,
"highWaterMarkWeek": 0
},
{
"id": "0x00000030",
"mapping": "ccxml_nocache_maxage1",
"active": 0,
"cumulative": 0,
"highWaterMarkHour": 0,
"highWaterMarkDay": 0,
"highWaterMarkWeek": 0
},
{
"id": "0x00000012",
"mapping": "rudtmf",
"active": 0,
"cumulative": 0,
"highWaterMarkHour": 0,
"highWaterMarkDay": 0,
"highWaterMarkWeek": 0
},
{
"id": "0x00000032",
"mapping": "4444",
"active": 0,
"cumulative": 0,
"highWaterMarkHour": 0,
"highWaterMarkDay": 0,
"highWaterMarkWeek": 0
},
{
"id": "0x00000015",
"mapping": "dialogflow_ext",
"active": 0,
"cumulative": 0,
"highWaterMarkHour": 0,
"highWaterMarkDay": 0,
"highWaterMarkWeek": 0
},
{
"id": "0x00000016",
"mapping": "dialogflow",
"active": 0,
"cumulative": 1,
"highWaterMarkHour": 1,
"highWaterMarkDay": 1,
"highWaterMarkWeek": 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.
| 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.
| 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.
| 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
}
BSM status
Status of a BSM component. All memory, threads and uptime information concerns the specific JVM/BSM and not the machine.
| Name | Type | Optional | Description |
|---|---|---|---|
| type | string | No | Always contains "bsm" |
| name | string | No | Name of the BSM |
| 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 |
| Uptime | number | No | How long BSM has been running in days, hours, minutes and seconds |
| System Load | number | No | System load average for the last minute, the sum of the number of runnable entities queued to the available processors and the number of runnable entities running on the available processors averaged over a period of time. |
| Free Memory | number | No | Available Java heap space in MB |
| Used Memory | number | No | Java heap memory used in MB - once the system is running a while this should reach a peak and be less than Max Memory |
| Max Memory | number | No | Maximum Java heap memory available in MB |
| Percent Memory Used | number | No | Used Memory as a percentage of Max Memory |
| Thread Count | number | No | Total number of threads running on this BSM instance |
| Warnings | number | No | Number of warning messages triggered since BSM was started |
| Errors | number | No | Number of error messages triggered since BSM was started |
| Active Registrars | number | No | The number of registrars that are both enabled and currently have at least one currently valid registration |
| Enabled Registrars | number | No | The number of registrar definitions that are defined in our database and are set to be enabled. Whilst BVRs are running this should be the same as Active Registrars - if not there may be an issue connecting to one or more of the registrars. |
| Cumulative Registrations | number | No | The number of successful registrations that have occured since BSM started, across all registrars. |
| Active Registrations | number | No | The current number of registrations that are yet to time out across BSM's target registrars |
| Failed Registrations | number | No | The number of registration attempts that have failed to contact or authenticate with their target registrar since BSM started |
Example
{
"type": "bsm",
"name": "BSM 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,
"activeRegistrars":1,
"enabledRegistrars":1,
"successfulRegistrations" : 10,
"activeRegistrations": 2,
"failedRegistrations": 0
}