Resource Drilldown
Introduction
Resource Drilldown messages pass between the ManageApp and any other application (including itself) to request and return the contents of a resource vector for the purposes of run-time platform administration.
!MANAGEMENT-RESOURCE-DRILLDOWN-REQUEST
The !MANAGEMENT-RESOURCE-DRILLDOWN-REQUEST message is sent by ManageApp to any application
(including itself and the WatchdogApp) in order to drilldown into the details of a
resources type.
The request attributes are:
| Field | Type | Description |
|---|---|---|
resource_key
|
String |
[Required] A value which matches the key of a resource vector.
|
resource_row_key
|
String | An optional identifier which requests that only a single resource row is returned, along with the full content of any columns of type "extended". When this attribute is not present, then all rows of the resource vector are returned, but "extended" resource vector content is not included. |
!MANAGEMENT-RESOURCE-DRILLDOWN-RESPONSE
The !MANAGEMENT-RESOURCE-DRILLDOWN-RESPONSE message is returned to the ManageApp by the
application providing drilldown details of the requested resource.
The response fields are:
| Field | Type | Description |
|---|---|---|
success
|
0/1
|
[Required] Indicates if the resource vector drilldown request was successful. |
error
|
String |
When success = 0, describes the reason that the request was not successful,
and all subsequent fields are not present.
|
resource_key
|
String | [Required] Confirms the resource vector key which was provided in the request. |
columns
|
Array of Object |
[Required] An ordered array of resource vector column descriptors. See the documentation for this array in !MANAGEMENT-CONFIGURATION-DRILLDOWN-RESPONSE.
|
list
|
Array of Object | [Required] An ordered array of vector row entries (may be empty). |
.*
|
Scalar |
Any key value may be present which matches a column key from the columns array.
|
Resource Columns
Each object in the columns array returned in !MANAGEMENT-RESOURCE-DRILLDOWN-RESPONSE
describes a column in the resource vector. The column descriptor has the
following attributes.
Note that the first column is special. The values of this first column must be unique, and
contains the row key (resource_row_key) for drilldown requests and also for performing
resource operations.
| Field | Type | Description |
|---|---|---|
key
|
string
|
[Required] The key for this column for each object within the list array.
|
name
|
String | [Required] The human-readable name for this column. |
type
|
choice/ string/ integer/ boolean/ tv/ abort/ extended / operation
|
[Required] The type of the column for rendering purposes.
Indicates the underlying type for this scalar. This may be used to decide how to render the value visually.
Note that resource columns are never editable, although an operation type may be clickable.string entries have no special formatting, and are typically left-aligned.integer entries have no special formatting, and are typically center-aligned.boolean entries have value = 0/1/undef, displayed as "YES"/"NO"/"", center-aligned.tv entries are array [epoch, microseconds] from gettimeofday.abort is an abort string, which may be displayed in a shortened form.extended indicates a multi-line text field. The full value is only returned in single-row drilldown.operation indicates an operation which a resource vector row may support (iff the row value is 1).(Default = string)
|
description
|
String | Optional "help text" for this column header and/or column values. |