Entity Object
Every 10 minutes, the extractor sends JSON data to Kafka for individual entities. Each entity object has two top-level fields:
timestamp
: When the entity was broadcastentity
: The object that describes the given entity.
Sample Entity Object
Click to Show/Hide:
{ "timestamp": "2021-01-15T19:17:13", "entity": { "environment": "ON_PREM", "name": "test-rdm-shared2", "attrs": { "guest_os_type": "WINDOWS", "connected_networks": [ "VM Network" ], "num_cpus": 1 }, "state": "POWERED_OFF", "oid": 73754533904736, "type": "VIRTUAL_MACHINE", "related": { "PHYSICAL_MACHINE": [ { "name": "hp-esx46.corp.vmturbo.com", "oid": 73754533901584 } ], "COMPUTE_CLUSTER": [ { "name": "Datacenter DC7/Cluster01", "oid": 284907641559697 } ], "DATACENTER": [ { "name": "Datacenter DC7", "oid": 73754533900625 } ], "VIRTUAL_DATACENTER": [ { "name": "Resources-Cluster01", "oid": 73754533901777 } ], "VIRTUAL_VOLUME": [ { "name": "Vol-test-rdm-shared2-QSGRID01:DC7DS2", "oid": 73754533909440 }, { "name": "Vol-test-rdm-shared2-test-rdm-shared1 : [QSGRID01:DC7DS2] test-rdm-shared1/test-rdm-shared1_1.vmdk", "oid": 73754533909439 } ], "STORAGE": [ { "name": "test-rdm-shared1 : [QSGRID01:DC7DS2] test-rdm-shared1/test-rdm-shared1_1.vmdk", "oid": 73754533901780 }, { "name": "QSGRID01:DC7DS2", "oid": 73754533900756 } ], "DISK_ARRAY": [ { "name": "test-rdm-shared1", "oid": 73754533901786 }, { "name": "DiskArray-QSGRID01:DC7DS2", "oid": 73754533900667 } ] }, "metric": { "STORAGE_AMOUNT": { "consumed": 3 }, "MEM_ALLOCATION": { "consumed": 0 }, "CPU_PROVISIONED": { "consumed": 2600 }, "VCPU": { "current": 0, "capacity": 2600, "utilization": 0 }, "BALLOONING": { "consumed": 0 }, "STORAGE_PROVISIONED": { "consumed": 15367.5751953125 }, "SWAPPING": { "consumed": 0 }, "IO_THROUGHPUT": { "consumed": 0 }, "MEM": { "consumed": 0 }, "NET_THROUGHPUT": { "consumed": 0 }, "MEM_PROVISIONED": { "consumed": 4194304 }, "VMEM": { "current": 0, "capacity": 4194304, "utilization": 0 }, "STORAGE_ACCESS": { "consumed": 0 }, "CPU_ALLOCATION": { "consumed": 0 }, "STORAGE_LATENCY": { "consumed": 0 }, "CPU": { "consumed": 0 } } } }
Common Entity Object Fields
Every entity
object includes the following fields:
JSON Object | Description | Type | Repeated | MapKeyType | Reference |
---|---|---|---|---|---|
accountExpenses |
False |
||||
attrs |
Additional descriptions for a given entity. The values of this are different for different entity types. |
False |
|||
cost |
False |
||||
environment |
The environment type - Hybrid, Cloud, On-prem, etc. |
False |
|||
metric |
For the given metric type, the utilization and capacity of the commodity. |
False |
|||
name |
The entity name. |
String |
False |
||
oid |
The entity ID. |
Long |
False |
||
related |
For the current entity, another entity that is connected to it in the supply chain. |
True |
|||
state |
The current state of the entity - POWERED_ON, SUSPENDED, MAINTENANCE, etc. |
False |
|||
type |
The entity type. |
False |
Entity Types:
Turbonomic can export data for the following types of entities.
Click to Show/Hide:
ACTION_MANAGER
:APPLICATION
:APPLICATION_COMPONENT
:APPLICATION_SERVER
:AVAILABILITY_ZONE
:BILLING_FAMILY
:BUSINESS
:BUSINESS_ACCOUNT
:BUSINESS_APPLICATION
:BUSINESS_ENTITY
:BUSINESS_TRANSACTION
:BUSINESS_USER
:CHASSIS
:CLOUD_COMMITMENT
:CLOUD_SERVICE
:COMPUTE_CLUSTER
:COMPUTE_RESOURCE
:COMPUTE_TIER
:CONTAINER
:CONTAINER_PLATFORM_CLUSTER
:CONTAINER_POD
:CONTAINER_SPEC
:DATABASE
:DATABASE_SERVER
:DATABASE_SERVER_TIER
:DATABASE_TIER
:DATACENTER
:DESIRED_RESERVED_INSTANCE
:DESKTOP_POOL
:DISK_ARRAY
:DISTRIBUTED_VIRTUAL_PORTGROUP
:DPOD
:GROUP
:HCI_PHYSICAL_MACHINE
:HYPERVISOR_SERVER
:INFRASTRUCTURE
:INTERNET
:IO_MODULE
:IP
:K8S_CLUSTER
:LICENSING_SERVICE
:LOAD_BALANCER
:LOGICAL_POOL
:MAC
:MOVER
:NAMESPACE
:NETWORK
:NETWORKING_ENDPOINT
:NODE_POOL
:OPERATOR
:PHYSICAL_MACHINE
:PORT
:PROCESSOR_POOL
:REGION
:RESERVED_INSTANCE
:RESERVED_INSTANCE_SPECIFICATION
:RESOURCE_GROUP
:RIGHT_SIZER
:SAVINGS
:SERVICE
:SERVICE_ENTITY_TEMPLATE
:SERVICE_PROVIDER
:STORAGE
:STORAGE_CLUSTER
:STORAGE_CONTROLLER
:STORAGE_TIER
:STORAGE_VOLUME
:SWITCH
:TARGET
:THIS_ENTITY
:THREE_TIER_APPLICATION
:VIEW_POD
:VIRTUAL_APPLICATION
:VIRTUAL_DATACENTER
:VIRTUAL_MACHINE
:VIRTUAL_VOLUME
:VLAN
:VM_SPEC
:VPOD
:WEB_SERVER
:WORKLOAD_CONTROLLER
:_NONE_
:
Metric Types:
Turbonomic tracks different metrics for different types of entities. For a given entity object, you will get the metric data that is appropriate for that entity. This list is all the metric types that the Data Exporter supports.
Click to Show/Hide:
ACTIVE_SESSIONS
:Count of the number of actively logged in sessions
Units: Count
BALLOONING
:Number of kb the host is dedicated for ballooning
Units: kilobytes
BUFFER_COMMODITY
:Utilization of a port buffer (fabric, UCS specific)
Units: megabytes
CONNECTION
:Number of connections onto the application
Units: Count
COOLING
:CPU
:For Physical machine - usage of CPU (current column). For VM - consumed CPU on the host (consumed column).
Units: MHz
CPU_ALLOCATION
:For VMs (consumed column) - VM buys from VDC or from desktop pool (VDI). For PMs - PMs sells to VDCs.
Units: MHz
CPU_HEADROOM
:Number of VMs that can fit in all of the available CPU (on a cluster)
Units: Count
CPU_PROVISIONED
:Capacity is based on the over-provisioned value in policy
Units: MHz
CPU_READY
:Ready queue
Units: ms
DB_CACHE_HIT_RATE
:The percentage of accesses that result in cache hits.
Units: Percentage
DB_MEM
:DB mem utilization or DM capacity
Units: kilobytes
DTU
:Capacity defined in the cloud
Units: Count
EXTENT
:Internal
Units: NA
FLOW
:Amount of network traffic per second between two nodes
Units: kilobytes/sec
FLOW_ALLOCATION
:Units: bytes
HEAP
:Amount of heap configured for an application
Units: kilobytes
IMAGE_CPU
:For VDI, usage of the business user
Units: MHz
IMAGE_MEM
:For VDI, usage of the business user
Units: kilobytes
IMAGE_STORAGE
:For VDI, usage of the business user
Units: megabytes
IO_THROUGHPUT
:Amount of traffic through the IO adapter
Units: kilobytes/sec
MEM
:Physical machine - usage of memory. VM - consumed memory.
Units: kilobytes
MEM_ALLOCATION
:Physical machine - what the host provides to VDCs. VM (consumed column) - what the VM buys from VDC or desktop pool.
Units: kilobytes
MEM_HEADROOM
:Number of VMs that can fit in the available memory on the cluster
Units: Count
MEM_PROVISIONED
:Capacity, based on the over-provisioned value in policy
Units: kilobytes
NET_THROUGHPUT
:Amount of traffic through the Network adapter
Units: kilobytes/sec
POOL_CPU
:For VDI, usage of the desktop pool
Units: MHz
POOL_MEM
:For VDI, usage of the desktop pool
Units: kilobytes
POOL_STORAGE
:For VDI, usage of the desktop pool
Units: megabytes
PORT_CHANEL
:Traffic on ports for UCS Mgr/HPE1
Units: kilobytes/sec
POWER
:Q16_VCPU
:VM - Sum of the Ready Queue usage of all of the CPU on the VM. To normalize the value, divide it by the number of vCPU. Host - Average of the underlying Ready Queue values from all of the corresponding VMs with the same number of vCPUs.
Units: ms
Q1_VCPU
:VM - Sum of the Ready Queue usage of all of the CPU on the VM. To normalize the value, divide it by the number of vCPU. Host - Average of the underlying Ready Queue values from all of the corresponding VMs with the same number of vCPUs.
Units: ms
Q2_VCPU
:VM - Sum of the Ready Queue usage of all of the CPU on the VM. To normalize the value, divide it by the number of vCPU. Host - Average of the underlying Ready Queue values from all of the corresponding VMs with the same number of vCPUs.
Units: ms
Q32_VCPU
:VM - Sum of the Ready Queue usage of all of the CPU on the VM. To normalize the value, divide it by the number of vCPU. Host - Average of the underlying Ready Queue values from all of the corresponding VMs with the same number of vCPUs.
Units: ms
Q3_VCPU
:VM - Sum of the Ready Queue usage of all of the CPU on the VM. To normalize the value, divide it by the number of vCPU. Host - Average of the underlying Ready Queue values from all of the corresponding VMs with the same number of vCPUs.
Units: ms
Q4_VCPU
:VM - Sum of the Ready Queue usage of all of the CPU on the VM. To normalize the value, divide it by the number of vCPU. Host - Average of the underlying Ready Queue values from all of the corresponding VMs with the same number of vCPUs.
Units: ms
Q5_VCPU
:VM - Sum of the Ready Queue usage of all of the CPU on the VM. To normalize the value, divide it by the number of vCPU. Host - Average of the underlying Ready Queue values from all of the corresponding VMs with the same number of vCPUs.
Units: ms
Q64_VCPU
:VM - Sum of the Ready Queue usage of all of the CPU on the VM. To normalize the value, divide it by the number of vCPU. Host - Average of the underlying Ready Queue values from all of the corresponding VMs with the same number of vCPUs.
Units: ms
Q6_VCPU
:VM - Sum of the Ready Queue usage of all of the CPU on the VM. To normalize the value, divide it by the number of vCPU. Host - Average of the underlying Ready Queue values from all of the corresponding VMs with the same number of vCPUs.
Units: ms
Q7_VCPU
:VM - Sum of the Ready Queue usage of all of the CPU on the VM. To normalize the value, divide it by the number of vCPU. Host - Average of the underlying Ready Queue values from all of the corresponding VMs with the same number of vCPUs.
Units: ms
Q8_VCPU
:VM - Sum of the Ready Queue usage of all of the CPU on the VM. To normalize the value, divide it by the number of vCPU. Host - Average of the underlying Ready Queue values from all of the corresponding VMs with the same number of vCPUs.
Units: ms
QN_VCPU
:VM - Sum of the Ready Queue usage of all of the CPU on the VM. To normalize the value, divide it by the number of vCPU. Host - Average of the underlying Ready Queue values from all of the corresponding VMs with the same number of vCPUs.
Units: ms
REMAINING_GC_CAPACITY
:Percentage of time not spent on garbage collection
Units: Percentage
RESPONSE_TIME
:Application response
Units: ms
SLA_COMMODITY
:User-defined value
Units: Number
STORAGE_ACCESS
:Count of the number of I/O (read + write) within two discovery cycles
Units: count
STORAGE_ALLOCATION
:Allocated storage
Units: megabytes
STORAGE_AMOUNT
:Used storage
Units: megabytes
STORAGE_HEADROOM
:Count of VM that can fit for the storage in a cluster in terms of storage
Units: Count
STORAGE_LATENCY
:Acceptable latency. User can set capacity for most storage, is discovered for NetApp.
Units: ms
STORAGE_PROVISIONED
:Capacity, based on the over-provisioned value in policy
Units: megabytes
SWAPPING
:Memory swapping
Units: bytes/sec
THREADS
:Threads in use
Units: Count
TOTAL_HEADROOM
:Min value of CPU, Mem, IO, of the headrooms
Units: Count
TOTAL_SESSIONS
:Total number of possible sessions
Units: Count
TRANSACTION
:Transactions for the application
Units: transactions/sec
TRANSACTION_LOG
:Size of the transaction log
Units: megabytes
VCPU
:CPU for the VM
Units: MHz
VCPU_LIMIT_QUOTA
:Units: millicores
VCPU_REQUEST
:Units: millicores
VCPU_REQUEST_QUOTA
:Units: millicores
VMEM
:Memory sold by a VM. Memory sold and bought for a container
Units: kilobytes
VMEM_LIMIT_QUOTA
:Units: kilobytes
VMEM_REQUEST
:Units: kilobytes
VMEM_REQUEST_QUOTA
:Units: kilobytes
VSTORAGE
:Units: megabytes
Related Entity Types:
Related entities are entities that are connected to the given entity in the supply chain. For example, a VM entity can have containers and applications running on it, while it uses disk space from related storage. For a given object, the data includes all the related entities. The supported related types can be any of the supported entities, or any of the group types listed here.
Click to Show/Hide:
JSON Object | Description | Type |
---|---|---|
name |
String |
|
oid |
Long |