Sensors including Datastores, Physical Storage, Resource Pools

#340160

Description

Densify provides a framework that allows additional analytics to be easily added to a Densify installation as sensors. For example, sensors can be added to include the analytics of application data or network data. Currently, Densify supports three sensors, including that for datastores (i.e. type is datastores), physical storage (i.e. type is physical_storage) and resource pools (i.e. type is resource_pools). To define your own sensors, contact Densify Technical Services.

With the sensors API, the list of sensor types and sensor details are available for the Control Environments, so that Workloads can be routed appropriately. The details are provided at each defined timeframe of the timeline.

Also see Routing Requests for details on sensor considerations when creating routing requests.

Resource

/sensors

/sensors/<type>

Supported Operations

Table: Sensor Supported Operations

Operation	HTTP Method	Input	Output	Description
Read Collection	GET /sensors	None	List of sensor types defined by [name, href[[,disk_sensor_link_attribute_id],sensor_link_attribute_id], sorted by name.	List of sensor types defined by the Control Console. The disk_sensor_link_attribute_id and sensor_link_attribute_id are used to determine the sensor display names for placement, when a Booking or Workload object maps to sensors. For example, see the Workloads' disks element disks. Sort By and Common Operations are not supported. Example: Getting Sensor Types

Operation

HTTP Method

Input

Output

Description

Read Collection

GET /sensors

None

List of sensor types defined by [name, href[[,disk_sensor_link_attribute_id],sensor_link_attribute_id], sorted by name.

List of sensor types defined by the Control Console.

The disk_sensor_link_attribute_id and sensor_link_attribute_id are used to determine the sensor display names for placement, when a Booking or Workload object maps to sensors. For example, see the Workloads' disks element disks.

Sort By and Common Operations are not supported.

Example: Getting Sensor Types

Table: Sensor Type Supported Operations

Operation	HTTP Method	Input	Output	Description
Get Collection	GET /sensors/<type>	None	Sensors of specified <type> collection of [name, id, href, host_name]	The list of sensors of specified <type>, in ascending order by name. Common Operations is supported. Example: Getting a Collection of Datastore Sensors
Get Individual	GET /sensors/<type>/<id>	None	Sensors including Datastores, Physical Storage, Resource Pools: Resource Elements	The details of the specified sensor. Example: Getting an Individual Datastore Sensor

Operation

HTTP Method

Input

Output

Description

Get Collection

GET /sensors/<type>

None

Sensors of specified <type> collection of [name, id, href, host_name]

The list of sensors of specified <type>, in ascending order by name.

Common Operations is supported.

Example: Getting a Collection of Datastore Sensors

Get Individual

GET /sensors/<type>/<id>

None

Sensors including Datastores, Physical Storage, Resource Pools: Resource Elements

The details of the specified sensor.

Example: Getting an Individual Datastore Sensor

Resource Elements

Table: Sensor Type Resource Elements

Element	Type	Filter	Description
id, name, href	string	F by name	See ID, Name and Self Reference (id, name, href).
control_environment	id, name, platform, platform_category, control_type, href, icon	F by control_environment_id	The Control Environment where this sensor belongs.
data	timeline: metrics [value, name, high_limit, low_limit, full_limit]		Sensor type-specific metrics for each timeframe that has data, as follows: For each short_name of the Timeline Tags: metrics[ value−value given to the metric name−UI field label of the metric high_limit−high threshold low_limit−low threshold full_limit−full limit defining 100% capacity ] Limits of -1 signify that the limit has not been defined. See example below.
host_name	string		The entity ID of the sensor (unique).
infrastructure_groups	id, name, href	F by infrastructure_group_id	The Infrastructure Groups where this sensor belongs.
sensor_type	string		The sensor type, which is "datastore", "phystor" or "resourcepool".
start_date	number	F	The date this sensor is online in UTC. If the sensor is a booking, then this element is the expected_date of the Booking. Otherwise, for all sensors that are not bookings this date is today as defined by the timeline. When filtering on start_date_from or start_date_to, all sensors coming online that satisfy this filter are returned, including all datastore sensors that are not bookings. When both start_date_from and start_date_to are specified, only the sensors coming online that satisfy this filter are returned.

Examples

Example: Getting Sensor Types

The following example shows you how to get sensor types:

Example: Getting Sensor Types

Request:

GET /sensors

Response:

[

{

"name": "Datastores",

"href": "/sensors/datastores",

"disk_sensor_link_attribute_id": "attr_DiskDatastoreLink",

"sensor_link_attribute_id": "VE_LOCATION_DATASTORE"

{

"name": "IP Address Pools",

"href": "/sensors/ip_address_pools",

"sensor_link_attribute_id": "attr_AddressPoolLink"

{

"name": "Physical Storage",

"href": "/sensors/physical_storage",

"disk_sensor_link_attribute_id": "attr_DiskPhysicalStorageLink",

"sensor_link_attribute_id": "attr_PhysicalStorageLink"

{

"name": "Resource Pools",

"href": "/sensors/resource_pools",

"sensor_link_attribute_id": "VE_VMWARE_RESOURCEPOOL"

}

]

Example: Getting a Collection of Datastore Sensors

The following example shows you how to obtain the collection of current datastores:

Example: Getting an Individual Datastore Sensor

The following example shows you how to get an individual datastore sensor:

Example: Getting an Individual Datastore Sensor

Request:

GET /sensors/datastores/13b64d47-d641-4c91-918e-357212ce5b22

Response:

{

"id": "13b64d47-d641-4c91-918e-357212ce5b22",

"name": "esx-lun-s121",

"data": {

"90": {

"metrics": [

{

"value": 13,

"name": "Number of VMs",

"high_limit": 75,

"low_limit": -1,

"full_limit": -1

{

"value": 614144,

"name": "Capacity (MB)",

"high_limit": -1,

"low_limit": -1,

"full_limit": -1

{

"value": 282533.38,

"name": "Total Required Space (MB)",

"high_limit": 100,

"low_limit": 20,

"full_limit": -1

{

"value": 246278.88,

"name": "Total Used Space (MB)",

"high_limit": 70,

"low_limit": 20,

"full_limit": 100

{

"value": 5,

"name": "Number of Hosts",

"high_limit": -1,

"low_limit": -1,

"full_limit": -1

{

"value": 372822.72,

"name": "Total Provisioned Space (MB)",

"high_limit": 300,

"low_limit": 20,

"full_limit": -1

}

]

}

// ... *SNIP* of other timeframes ...

}

"href": "/sensors/datastores/00550cc8-b473-4804-9947-20744f35f164",

"host_name": "bac5eda7-e4b4-4c79-9e36-4b9d800a6dd2",

"control_environment": {

"id": "8db102f8-54ef-4d7c-a31d-df98315e48ce",

"name": "Toronto",

"platform": "VMWARE",

"platform_category": "Internal Virtual",

"control_type": "FULL"

"href": "/control-environments/8db102f8-54ef-4d7c-a31d-df98315e48ce"

"icon": "/control-environments/8db102f8-54ef-4d7c-a31d-df98315e48ce/icon"

"sensor_type": "datastore",

"start_date": 1403064000000,

"infrastructure_groups": [

{

"id": "6b153341-95b6-4794-acb3-9a422722bb78",

"name": "Cluster 1",

"href": "/infrastructure-groups/6b153341-95b6-4794-acb3-9a422722bb78"

{

"id": "99128443-1936-478e-bfcd-fde9243773de",

"name": "Cluster2",

"href": "/infrastructure-groups/99128443-1936-478e-bfcd-fde9243773de"

}

]

}