Get Corrade Heartbeat Data

7 October 2016

Release 9.134 - added.

getheartbeatdata (Commands)
Type	Corrade progressive command
Command	`getheartbeatdata`
Description	The `getheartbeatdata` command can query Corrade's heartbeat data.
Permissions	`grooming`
Parameters	`group`, `password`, `data`
Last Changes	Release 9.134 - added.

The getheartbeatdata command can query Corrade's heartbeat data.

Command Required Parameters Required Corrade Permissions Example

getheartbeatdata

group, password, data

grooming

llInstantMessage(CORRADE,
    wasKeyValueEncode(
        [
            // get the average CPU and RAM usage
            "command", "getheartbeatdata",
            "group", wasURLEscape(GROUP),
            "password", wasURLEscape(PASSWORD),
            "data", wasListToCSV(
                [
                    "AverageCPUUsage",
                    "AverageRAMUsage"
                ]
            ),
            "callback", wasURLEscape(URL)
        ]
    )
);

Corrade heartbeats have a one minute periodicity meaning that the averages are computed cumulatively over 1 minute intervals.

Structure

The data that can be queried is the following:

Parameter	Description
`HistoryLength`	The heartbeat history length maintained by Corrade for RAM and CPU.
`StartTime`	The date and time when Corrade was started.
`AverageCPUUsage`	The average CPU usage across all heartbeats.
`AverageRAMUsage`	The average RAM usage across all heartbeats (in bytes).
`AverageThreadsUsage`	The average threads usage across all heartbeats.
`CPUAverageUsageHistory`	A list of CPU usage snapshots of length `HistoryLength`.
`RAMAverageUsageHistory`	A list of RAM usage snapshots of length `HistoryLength`.
`ThreadsAverageUsageHistory`	A list of thread usage snapshots of length `HistoryLength`.
`NETAverageUsageHistory`	A list of network usage snapshots of length `HistoryLength`.
`Uptime`	The Corrade uptime (in format `[-][d.]hh:mm:ss[.fffffff]`).
`Version`	The Corrade version.
`ExecutingCommands`	The number of currently executing commands.
`ManifestingRLVBehaviours`	The number of currently manifesting RLV behaviours.
`ProcessedCommands`	The number of processed commands.
`ProcessedRLVBehaviours`	The number of processed RLV behaviours.

Notes

HistoryLength is set to 100

Table of Contents

Get Corrade Heartbeat Data

Structure

Notes