Entity Type Reference

These attributes and metrics are used by Observium's Alerting, Grouping and Scheduled Maintenance systems, please refer to their sections for more details on how to make use of this reference.

Device

Metrics

Metric Name Type Description Examples
device_status Boolean 0 = down, 1 = up 1 0
device_status_type Text Reason for being marked down snmp ping
device_ping Milliseconds PING response time in ms 521
device_snmp Milliseconds SNMP response time in ms 600
device_uptime Seconds Device uptime in seconds 23492849
device_rebooted Boolean Is the device recently rebooted: 0 = not rebooted, 1 = rebooted 0 1
device_duration_poll Seconds Device poll duration in seconds 349

Attributes

Attribute Type Description Examples
hostname Text Device's hostname as known by Observium omega.memetic.org device.domain.com
os Text Device's Observium OS type linux ios catos f5
type Text Automatically assigned type based on OS network server workstation storage wireless
sysName Text The sysName reported by the device omega
sysDescr Text The sysDescr reported by the device Linux omega.memetic.org 3.13.0-63-generic #103-Ubuntu SMP Fri Aug 14 21:42:59 UTC 2015 x86_64
sysObjectID OID The sysObjectID returned by the device .1.3.6.1.4.1.890.1.5.11.6 .1.3.6.1.4.1.9.1.620
sysContact Text The sysContact reported by the device foo@bar.com Acme Devops <support@acme.com>
hardware Text The hardware string of the device CISCO1841 Generic x86 [64bit] Aruba6000
serial Text The serial number of the device SN0128390182
purpose Text User-defined description field Mail server
location Text The sysLocation returned by the device Telehouse North, London, UK
group Text A group name the device must belong to group includes Servers
group_id Numeric A group id the device must belong to group_id includes 5

Entity match should be * for devices, as they are already matched in the device association.

Device attributes can be seen by checking the 'data' tab on the device page in the web interface.

Port

Metrics

Metric Name Type Description Examples
ifInOctets_rate Bps Incoming data rate 136421
ifOutOctets_rate Bps Outgoing data rate 513461
ifInOctets_perc Percent Incoming data rate as a percentage 15
ifOutOctets_perc Percent Outgoing data rate as a percentage 7
ifInUcastPkts_rate Packets/sec Incoming unicast packets per second
ifOutUcastPkts_rate Packets/sec Outgoing unicast packets per second
ifInNUcastPkts_rate Packets/sec Incoming non-unicast packets per second
ifOutNUcastPkts_rate Packets/sec Outgoing non-unicast packets per second
ifInBroadcastPkts_rate Packets/sec Incoming broadcast packets per second. Only available on ports with port_mcbc = 1
ifOutBroadcastPkts_rate Packets/sec Outgoing broadcast packets per second Only available on ports with port_mcbc = 1
ifInMulticastPkts_rate Packets/sec Incoming multicast packets per second. Only available on ports with port_mcbc = 1
ifOutMulticastPkts_rate Packets/sec Outgoing multicast packets per second. Only available on ports with port_mcbc = 1
ifInErrors_rate Errors/sec Input errors per second 0 98
ifOutErrors_rate Errors/sec Output errors per second 0 10
ifInDiscards_rate Discards/sec Input discards per second 0 54
ifOutDiscards_rate Discards/sec Output discards per second 0 42
ifErrors_rate Errors/sec Aggregate errors per second 0 10
ifDiscards_rate Discards/sec Aggregate discards per second 0 42
ifBroadcastPkts_rate Packets/sec Aggregate broadcast packets per second. Only available on ports with port_mcbc = 1
ifMulticastPkts_rate Packets/sec Aggregate multicast packets per second. Only available on ports with port_mcbc = 1
ifUcastPkts_rate Packets/sec Aggregate unicast packets per second
ifNUcastPkts_rate Packets/sec Aggregate non-unicast packets per second
ifErrors_rate Errors/sec Aggregate errors per second 0 98
rx_ave_pktsize Bytes Incoming average packet size 652
tx_ave_pktsize Bytes Outgoing average packet size 546
ifOperStatus Text Port operational status up down testing lowerLayerDown
ifAdminStatus Text Port administrative status up admindown
ifSpeed bps Port speed in bits. Generated from ifHighSpeed where available 1000000000
ifMtu Bytes Port MTU 1500 567
ifDuplex Text Port duplex status fullDuplex halfDuplex

Attributes

Port attributes can be seen by checking the 'data' tab on the port page in the web interface.

Attribute Type Description Examples
ifSpeed bps Port speed in bits 100000000 1000000000 2048000
ifAlias Text Port description from SNMP Transit: OVH Peering: LINX Cust: Acme Widgets (Scunthorpe) [10M] {CIR1231}
ifDescr Text Port name from SNMP FastEthernet0/1 eth0 TenGigabitEthernet1/0/1 adsl1
ifName Text Port 'short' name from SNMP Fa0/1 eth0 Te1/0/1 adsl1
ifType Text Port type from SNMP definied by IANA, see IANAIFTYPE-MIB ethernetCsmacd propVirtual
ifPhyAddress MAC Port MAC address without punctuation 6c9ced2e14db e6b6bec1dd4a
port_label Text Processed port label used in UI FastEthernet0/1 eth0 TenGigabitEthernet1/0/1 adsl1
port_short_label Text Processed short port label used in UI Fa0/1 eth0 Te1/0/1 adsl1
port_label_base Text Processed port label base FastEthernet eth TenGigabitEthernet adsl
port_label_num Text Processed port label numberic 0/1 0 1/0/1 1
port_descr_type Text Port type parsed from ifAlias. See Port Description Parser cust transit peering
port_descr_descr Text Port description parsed from ifAlias. See Port Description Parser Acme Widgets OVH
port_descr_speed Text Port speed parsed from ifAlias. See Port Description Parser 10M
port_descr_circuit Text Port circuit id parsed from ifAlias. See Port Description Parser CIR1231
port_descr_notes Text Port notes parsed from ifAlias. See Port Description Parser Scunthorpe
port_mcbc Boolean Specifies wether the port provides separate Multicast/Broadcast counters 0 1

Memory

Metrics

Metric Name Type Description
mempool_free bytes Free space in bytes
mempool_used bytes Used space in bytes
mempool_perc percent Percentage used

Attributes

Attribute Type Description Examples
mempool_descr Text Memory pool description module 0/0/CPU0 (processor) TMM 0.1 Memory
mempool_mib Text Memory pool source MIB host-resources-mib cisco-entity-qfp-mib

Special Situations

On UNIX/Linux systems we generate a special "Physical Memory" memory pool entity by calculating memory usage minus buffers and cache. Use this for alerting on UNIX/Linux.

Processor

Metrics

Metric Name Type Description
processor_usage percent Percentage used

Attributes

Attribute Type Description Examples
processor_descr Text Processor description Intel Core i7-3770 @ 3.40GHz Processor 1 module 0/7/CPU0
processor_type Text Processor type set by the module hr hr-average cpm WLSX-SWITCH-MIB
processor_oid Text Processor OID .1.3.6.1.4.1.9.9.109.1.1.1.1.8.66 .1.3.6.1.2.1.25.3.3.1.2.768

Special Situations

On UNIX/Linux systems we generate a special "Average" processor entity by calculating the average cpu load for all processors. Use this for alerting on UNIX/Linux.

Storage

Metrics

Metric Name Type Description
storage_free bytes Free space in bytes
storage_used bytes Used space in bytes
storage_perc percent Percentage used

Attributes

Attribute Type Description Examples
storage_descr Text Storage description /home Standby Flash Disk 0 - /disk0:
storage_type Text Storage type set by discovery module hrStorageFixedDisk ciscoFlash
storage_mib Text Storage source MIB host-resources-mib cisco-flash-mib
storage_index Text Storage index 1.1

BGP Peer

Metrics

Metric Name Type Description Examples
bgpPeerState Text Peer state idle connect active opensent openconfirm established
bgpPeerAdminStatus Text Peer administrative state start stop
bgpPeerFsmEstablishedTime Numeric Length of time session has been up in seconds 239482034

Attributes

Attribute Type Description Examples
as_text Text descriptin of peer's AS H3G-AS , IT GLOBUS-AS , RU
bgpPeerRemoteAs Peer's ASN 6067 8086 52065
bgpPeerRemoteAddr Peer's address 10.0.1.1
bgpPeerLocalAddr Session local address 10.0.1.2
bgpPeerIdentifier Peer's BGP ID 10.0.0.1
peer_device_id device_id of peer if known 231 NULL

Sensors

Metrics

Metric Name Type Description Examples
sensor_value Numeric The sensor value 100 -20 12131.212
sensor_event Text Sensor status based on thresholds ok, warning, alert, down

Attributes

Attribute Type Description Examples
sensor_descr Text Sensor description/name as used in the UI Unit 1 Outlet C14 (iecC13) Cisco ASR1001 AC Power Supply - PEM Iout - PEM Iout P0/0
sensor_class Text Sensor class airflow apower crestfactor current dbm fanspeed frequency impedence percent powerfactor power pressure resistance rpower runtime snr temperature voltage waterflow
sensor_type Text String identifying the source MIB/Table cisco-entity-sensor zyxel-ies eaton-epdu-mib
sensor_index Text String identifying the source OID/Index outletCurrentCrestFactor.1.42 7010
sensor_oid OID The sensor's OID .1.3.6.1.4.1.9.9.91.1.1.1.1.4.7011
poller_type Text String identifying the source protocol snmp agent ipmi

Thresholds

Thresholds for the sensor entity type are often provided by the device itself. Where they aren't provided, Observium will autogenerate them by providing estimated upper/lower limits based on the current value. These thresholds can be customised on the sensor tab of the device settings page.

It is recommended that the majority of users use these thresholds for sensor alerts.

Metric Name Type Description Examples
sensor_limit Numeric Device-provided, calculated or custom upper limit sensor_value ge @sensor_limit
sensor_limit_low Numeric Device-provided, calculated or custom lower limit sensor_value le @sensor_limit_low
sensor_warn Numeric Device-provided, calculated or custom upper warning sensor_value ge @sensor_warn
sensor_warn_low Numeric Device-provided, calculated or custom lower warning sensor_value le @sensor_warn_low

Status

Metrics

Metric Name Type Description Examples
status_name Text The textual representation of the status value ok fail normal on true outOfBounds
status_name_uptime Text The length of time since the status value last changed
status_event Text Interpreted status ok warning alert down

Attributes

Attribute Type Description Examples
status_descr Text The description/name Fan Tray 2 fan-fail VTT-E FRU 2 OK Sensor - VTT 2 OK Sensor
status_type Text A string describing the source MIB/Table cisco-envmon-state cisco-entity-state outletCurrentThStatus
status_index Text A string describing the source OID/Index outletCurrentThStatus.1.15 sysChassisPowerSupplyStatus.1 32
poller_type Text Source protocol snmp, agent, ipmi
entPhysicalClass Text A string describing the physical class measured where available power other device sensor fan

Printer supplies

Metrics

Metric Name Type Description
supply_value % Current supply level in %

Attributes

Attribute Type Description Examples
supply_descr Text Supply description Waste Toner Box
supply_mib Text Source MIB jetdirect
supply_colour Text Supply colour black cyan magenta yellow
supply_type Text Supply type toner wastebox fuser
supply_oid OID Supply value OID .1.3.6.1.2.1.43.11.1.1.8.1.2

Pseudowires

Metrics

Metric Name Type Description Examples
pwOperStatus Text Operational Status up down unknown
pwRemoteStatus Text Remote Status up down unknown
pwLocalStatus Text Local Status up down unknown
event Text Observium-generated status ok alert warn
pwUptime Seconds Pseudowire uptime 2321
last_change Unixtime Pseudowire last changed 1467781928

Attributes

Attribute Type Description Examples
mib MIB Source MIB CISCO-IETF-PW-MIB
pwOutboundLabel Numeric Outbound label 16007
pwInboundLabel Numeric Inbound label 16007
peer_addr IP Peer's address 10.0.0.1
peer_device_id Numeric Peer's device_id if known 271 NULL
pwType Text Pseudowire type ethernet ethernetVPLS
pwPsnType Text Pseudowire PSN type mpls l2tp mplsOverGre other
pwDescr Text Pseudowire description SYSLOG_VPLS
pwRemoteIfString Text Remote port name if known Bundle-Ether101.1756

Netscaler vServers

Metrics

Metric Name Type Description Examples
vsvr_state Text The vServer's state from SNMP up down outOfService
vsvr_conn_client Numeric Current client connections 12631
vsvr_conn_server Numeric Current server connections 832
vsvr_bps_in Numeric Incoming traffic in bits/sec 23498273
vsvr_bps_out Numeric Outgoing traffic in bits/sec 3478291
vsvr_health Numeric The percentage of UP services 100

Attributes

Attribute Type Description Examples
vsvr_name Text The unique name from SNMP often not human readable INg14cqudoilplsc2ocbxua4lnmgudt VS-SharePoint-2016-SSLRedirect
vsvr_fullname Text The configured name from SNMP VS-Citrix-XenMobile10_10.3.60.26_8443 VS-SharePoint-2016-SSLRedirect
vsvr_label Text The name used in the UI VS-Citrix-XenMobile10_10.3.60.26_8443 VS-SharePoint-2016-SSLRedirect
vsvr_ip IP The configured IP address 10.3.60.26
vsvr_ipv6 IPv6 The configured IPv6 address 2a02:c28:0:0:0:1:e3:12e
vsvr_port Numeric The configured port 443 80 8080
vsvr_type Text The configured type http ssl sslBridge any ftp
vsvr_entitytype Text The configured entity type loadbalancing contextswitching sslvpn loadbalancinggroup

Netscaler Services

Metrics

Metric Name Type Description Examples
svc_state Text The service's state from SNMP up down outOfService
svc_bps_in Numeric Incoming traffic in bits/sec 23498273
svc_bps_out Numeric Outgoing traffic in bits/sec 3478291
svc_conn_active Numeric Currently active connections 344
svc_trans_active Numeric Currently active transactions 502
svc_trans_avgtime Microseconds Average transaction time in microseconds between netscaler and the service behind it. 172361723
svc_svr_avgttfb Milliseconds Average TTFB between the NetScaler appliance and the server. TTFB is the time interval between sending the request packet to a service and receiving the first response from the service 31
svc_conn_client Numeric Current client connections 342

Attributes

Attribute Type Description Examples
svc_name Text The unique name from SNMP often not human readable INg14cqudosc2ocbxua4lnmgudt VS-SharePoint
svc_fullname Text The configured name from SNMP VS-Citrix-10_10.3.60.26_8443 VS-SharePoint
svc_label Text The name used in the UI VS-Citrix-10_10.3.60.26_8443 VS-SharePoint
svc_ip IP The configured IP address 10.3.60.26
svc_port Numeric The configured port 443 80 8080
svc_type Text The configured type dns any http ftp tftp udp tcp

Netscaler Service Group Members

Metrics

Metric Name Type Description Examples
svc_state Text The service's state from SNMP up down outOfService
svc_conn_active Numeric Active connections 234
svc_trans_active Numeric Currently active transactions 502
svc_trans_avgtime Microseconds Average transaction time in microseconds between netscaler and the service behind it. 172361723
svc_svr_avgttfb Milliseconds Average TTFB between the NetScaler appliance and the server. TTFB is the time interval between sending the request packet to a service and receiving the first response from the service 31
svc_conn_client Numeric Client connections 134
svc_bps_in Numeric Incoming traffic in bits/sec 23498273
svc_bps_out Numeric Outgoing traffic in bits/sec 3478291

Attributes

Attribute Type Description Examples
svc_name Text The unique name from SNMP often not human readable INm0fxszba5iepmdm2mheycrx4o31a0
svc_fullname Text The configured name from SNMP SVG-WEB-DERP?INTERWEB04?80
svc_label Text The name used in the UI INTERWEB04
svc_ip IP The configured IP address 10.3.60.26
svc_port Numeric The configured port 443 80 8080
svc_type Text The configured type dns any http ftp tftp udp tcp

IP-SLA / RTT

SLAs are supported on Cisco via CISCO-RTTMON-MIB, on Juniper via JUNIPER-PING-MIB and on some other vendors via the standardised DISMAN-PING-MIB.

Metrics

Metric Name Type Description Examples
rtt_value Milliseconds The completion time of the latest RTT operation successfully completed 254
rtt_sense Text A sense code for the completion status of the latest RTT operation. Note: sense codes are vendor/mib specific, we recommend using rtt_event instead. ok (Cisco) responseReceived (Juniper)
rtt_sense_uptime Seconds Uptime in seconds for current/last sense code, how long sense not changed 21314
rtt_event Text Status event for current sense code ok warning alert
rtt_minimum Milliseconds Jitter Only The minimum of RTT's that were successfully measured 20
rtt_maximum Milliseconds Jitter Only The maximum of RTT's that were successfully measured 3454
rtt_success Numeric Jitter Only The number of RTT's that were successfully measured 5
rtt_loss Numeric Jitter Only The number of packets lost 3

Attributes

Metric Name Type Description
sla_index
sla_owner
sla_tag
sla_graph echo or jitter
sla_status always 'active', all other not polled, mostly not used
rtt_type Vendor specific, mostl known types: echo, jitter, icmpjitter, dns, http, ftp