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.
Two special metrics are available on all entities in the alerting system, time and weekday. time contains the time in the format HHdd like 1630. weekday contains the day of the week as a number from mon as 1 to sunday as 7.
Device
Metrics
| Metric Name |
Type |
Description / Examples |
device_status |
Boolean |
0 = down, 1 = up |
device_status_type |
Text |
Reason for being marked down
snmp ping |
device_ping |
Milliseconds |
PING response time in ms |
device_snmp |
Milliseconds |
SNMP response time in ms |
device_uptime |
Seconds |
Device uptime in seconds |
device_rebooted |
Boolean |
Is the device recently rebooted: 0 = not rebooted, 1 = rebooted |
device_duration_poll |
Seconds |
Device poll duration in seconds |
device_la |
Float |
Device 5 minute load average (duplicate of device_la_5min) UNIX/Linux only |
device_la_1min |
Float |
Device 1 minute load average UNIX/Linux only |
device_la_5min |
Float |
Device 5 minute load average UNIX/Linux only |
device_la_15min |
Float |
Device 15 minute load average UNIX/Linux only |
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 3.1.0 #103 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 |
ifOutOctets_rate |
Bps |
Outgoing data rate |
ifInOctets_perc |
Percent |
Incoming data rate as a percentage |
ifOutOctets_perc |
Percent |
Outgoing data rate as a percentage |
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 on ports with port_mcbc = 1 |
ifOutBroadcastPkts_rate |
Packets/sec |
Outgoing broadcast packets per second Only on ports with port_mcbc = 1 |
ifInMulticastPkts_rate |
Packets/sec |
Incoming multicast packets per second. Only on ports with port_mcbc = 1 |
ifOutMulticastPkts_rate |
Packets/sec |
Outgoing multicast packets per second. Only on ports with port_mcbc = 1 |
ifInErrors_rate |
Errors/sec |
Input errors per second |
ifOutErrors_rate |
Errors/sec |
Output errors per second |
ifInDiscards_rate |
Discards/sec |
Input discards per second |
ifOutDiscards_rate |
Discards/sec |
Output discards per second |
ifErrors_rate |
Errors/sec |
Aggregate errors per second |
ifDiscards_rate |
Discards/sec |
Aggregate discards per second |
ifBroadcastPkts_rate |
Packets/sec |
Aggregate broadcast packets per second. Only on ports with port_mcbc = 1 |
ifMulticastPkts_rate |
Packets/sec |
Aggregate multicast packets per second. Only 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 |
rx_ave_pktsize |
Bytes |
Incoming average packet size |
tx_ave_pktsize |
Bytes |
Outgoing average packet size |
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 |
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 |
ifAlias |
Text |
Port description from SNMP
Transit: OVH Cust: Acme Pies (Leeds) [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 |
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 |
bgpPeerInUpdates_delta |
Numeric |
Incoming Updates since last poll |
bgpPeerInUpdates_rate |
Numeric |
Incoming Updates per second |
bgpPeerOutUpdates_delta |
Numeric |
Outgoing Updates since last poll |
bgpPeerOutUpdates_rate |
Numeric |
Outgoing Updates per second |
bgpPeerInTotalMessages_delta |
Numeric |
Incoming Messages since last poll |
bgpPeerInTotalMessages_rate |
Numeric |
Incoming Messages per second |
bgpPeerOutTotalMessages_delta |
Numeric |
Ougoing Messages since last poll |
bgpPeerOutTotalMessages_rate |
Numeric |
Outgoing Messages per second |
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 |
|
BGP Peer Address Family
The BGP Peer AFI/SAFI entity type contains per-address family counters for BGP peers. Each BGP peer may have multiple AFI/SAFI entities, one for each protocol in use on the BGP session.
In addition to the attributes inherited from the parent BGP Peer entity, this type specifies AFI and SAFI.
Attributes
| Attribute |
Description / Examples |
afi |
Address Family ipv6 ipv4 |
safi |
Subaddress Family unicast multicast vpn |
Metrics
| Metric Name |
Type |
Description / Examples |
AcceptedPrefixes |
numeric |
Number of accepted prefixes |
DeniedPrefixes |
numeric |
Number of denied prefixes |
AdvertisedPrefixes |
numeric |
Number of prefixes advertised to the peer |
SuppressedPrefixes |
numeric |
Number of suppressed prefixes |
WithdrawnPrefixes |
numeric |
Number of withdrawn prefixes |
Sensors
Sensors within Observium are things that give an instantaneous numerical value of something. This includes temperature, voltage and airflow sensors. Sensors are always instantaneous gauge-type measurements and can't be counters (use the entity type counter) or boolean/enum-type indicators for these the entity type status is used.
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, ignore |
Attributes
| Attribute Name |
Type |
Description / Examples |
sensor_descr |
Text |
Sensor description/name as used in the UI, ie:
Cisco ASR1001 AC Power Supply - PEM Iout - PEM Iout P0/0 Unit 1 Outlet C14 (iecC13) |
sensor_class |
Text |
Sensor class (can be extended in newer versions):
airflow, apower, capacity, crestfactor, current, dbm, dewpoint, dust, fanspeed, frequency, humidity, illuminance, impedence, load, percent, powerfactor, power, pressure, resistance, rpower, runtime, snr, sound, temperature, velocity, voltage, volume, waterflow, wavelength |
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 numeric OID, ie:
.1.3.6.1.4.1.9.9.91.1.1.1.1.4.7011 |
sensor_mib |
OID |
The sensor's MIB, ie:
PowerNet-MIB CISCO-ENTITY-SENSOR-MIB |
sensor_object |
OID |
The sensor's text object, ie:
cmgCpuTemp |
measured_port_id |
Numeric |
Measured port IDs, if sensor linked with measured entity, ie: 10 |
measured_port_group_id |
Numeric |
Measured port group IDs, if sensor linked with measured entity, ie: 10 |
measured_printersupply_id |
Numeric |
Measured printer supply IDs, if sensor linked with measured entity, ie: 10 |
measured_printersupply_group_id |
Numeric |
Measured printer supply group IDs, if sensor linked with measured entity, ie: 10 |
poller_type |
Text |
String identifying the source protocol:
snmp, agent, ipmi |
group_id |
Numeric |
A group id, ie: 5 |
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
Status indicators within Observium are representations of boolean/enum-type indicators supplied by the end device or may sometimes be Observium-generated pseudo-indicators aggregating multiple metrics to make alerting easier.
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 |
entPhysicalClass |
Text |
A string describing the physical class measured where available
power other device sensor fan |
measured_port_id |
Numeric |
Measured port IDs, if status linked with measured entity, ie: 10 |
measured_port_group_id |
Numeric |
Measured port group IDs, if status linked with measured entity, ie: 10 |
measured_printersupply_id |
Numeric |
Measured printer supply IDs, if status linked with measured entity, ie: 10 |
measured_printersupply_group_id |
Numeric |
Measured printer supply group IDs, if status linked with measured entity, ie: 10 |
poller_type |
Text |
Source protocol
snmp agent ipmi |
group_id |
Numeric |
A group id, ie: 5 |
Counters
Minimum version
This feature available since version 19.5.9890
Counters within Observium are things that give an instantaneous numerical value of something wich have some trending in a time (grow up/down or something like pages count and lifetime). This includes some common counter classes (charge, energy and lifetime) but not limited with class. Counter have additional metrics with rates (per second, minute, 5 minutes and hour).
Metrics
| Metric Name |
Type |
Description / Examples |
counter_value |
Numeric |
The counter value, ie:
100, -20, 12131 |
counter_rate |
Numeric |
The counter value rate per second |
counter_rate_min |
Numeric |
The counter value rate per minute |
counter_rate_5min |
Numeric |
The counter value rate per 5 minutes (this is common poll period) |
counter_rate_hour |
Numeric |
The counter value rate per hour |
counter_event |
Text |
Counter status based on thresholds
ok, warning, alert, ignore |
Attributes
| Attribute Name |
Type |
Description / Examples |
counter_descr |
Text |
Counter description/name as used in the UI, ie:
Total Printed Impressions |
counter_class |
Text |
Counter class (can used any class name, but we have some common nmaes defined):
charge, energy, aenergy, renergy, lifetime, counter |
counter_index |
Text |
String identifying the source OID/Index:
outletCurrentCrestFactor.1.42, 7010 |
counter_oid |
OID |
The sensor's OID, ie:
.1.3.6.1.4.1.9.9.91.1.1.1.1.4.7011 |
measured_port_id |
Numeric |
Measured port IDs, if counter linked with measured entity, ie: 10 |
measured_port_group_id |
Numeric |
Measured port group IDs, if counter linked with measured entity, ie: 10 |
measured_printersupply_id |
Numeric |
Measured printer supply IDs, if counter linked with measured entity, ie: 10 |
measured_printersupply_group_id |
Numeric |
Measured printer supply group IDs, if counter linked with measured entity, ie: 10 |
poller_type |
Text |
String identifying the source protocol:
snmp, agent, ipmi |
group_id |
Numeric |
A group id, ie: 5 |
Thresholds
Thresholds for the counter entity type are often provided by the device itself. Counter thresholds can used for value or any of provided value rate. These thresholds can be customised on the sensor tab of the device settings page.
| Metric Name |
Type |
Description / Examples |
counter_limit |
Numeric |
Device-provided, calculated or custom upper limit
counter_value ge @counter_limit
counter_rate_5min ge @counter_limit
counter_rate_hour ge @counter_limit |
counter_limit_low |
Numeric |
Device-provided, calculated or custom lower limit
counter_value le @counter_limit_low
counter_rate_5min le @counter_limit_low
counter_rate_hour le @counter_limit_low |
counter_warn |
Numeric |
Device-provided, calculated or custom upper warning
counter_value ge @counter_warn
counter_rate_5min ge @counter_warn
counter_rate_hour ge @counter_warn |
counter_warn_low |
Numeric |
Device-provided, calculated or custom lower warning
counter_value le @counter_warn_low
counter_rate_5min le @counter_warn_low
counter_rate_hour le @counter_warn_low |
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 |
vsvr_conn_server |
Numeric |
Current server connections |
vsvr_bps_in |
Numeric |
Incoming traffic in bits/sec |
vsvr_bps_out |
Numeric |
Outgoing traffic in bits/sec |
vsvr_health |
Numeric |
The percentage of UP services |
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 RTTs that were successfully measured |
20 |
rtt_maximum |
Milliseconds |
Jitter Only The maximum of RTTs that were successfully measured |
3454 |
rtt_success |
Numeric |
Jitter Only The number of RTTs 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, known types: echo, jitter, icmpjitter, dns, http, ftp |
Cisco CBQoS
Metrics
| Metric Name |
Type |
Description |
Examples |
PrePolicyPkt_rate |
Numeric |
Pre-Policy packets/second |
254 |
PrePolicyByte_rate |
Numeric |
Pre-Policy bytes/second |
254 |
PostPolicyByte_rate |
Numeric |
Post-Policy bytes/second |
254 |
DropPkt_rate |
Numeric |
Dropped packets/second |
254 |
DropByte_rate |
Numeric |
Dropped bytes/second |
254 |
NoBufDropPkt_rate |
Numeric |
No Buffers Dropped packets/second |
254 |
Attributes
CBQOS uses Port as its parent entity, so port attributes are also usable here.
| Attribute Name |
Type |
Description |
policy_name |
Text |
Policy Name |
object_name |
Text |
Object Name |
direction |
Text |
Direction (input, output) |
Probes
Probes allow you to define custom scripts to perform host checks
Metrics
| Metric Name |
Type |
Description |
Examples |
status |
Status |
Entity status from return code |
ok, alert, warning, unknown |
message |
Message |
Message returned from probe |
|
Attributes
| Attribute Name |
Type |
Description |
probe_type |
Text |
Probe Type |
Windows Services
Windows services allow you to track the configured and operational status of services on Microsoft Windows
Metrics
| Metric Name |
Type |
Description |
Examples |
state |
Text |
Current state |
running, stopped |
startmode |
Text |
Configured start mode |
manual, auto, disabled |
Attributes
| Attribute Name |
Type |
Description |
displayname |
Text |
Service display name |
name |
Text |
Service name |
Custom OID
Custom OIDs allow you to define custom OIDs for Observium to poll which can then be alerted on.
Metrics
| Metric Name |
Type |
Description |
Examples |
value |
Numeric |
OID returned value |
254 |
Attributes
The attributes available for Custom OIDs are the settings configured by the user when creating the Custom OID
| Attribute Name |
Type |
Description |
Examples |
oid |
String |
Numerical OID |
.1.3.6.1.2.1.4.24.6.0 |
oid_name |
String |
Textual OID |
tcpInSegs.0 |
oid_descr |
String |
OID Description |
TCP Input Segments |
oid_unit |
String |
OID Unit |
Segments/sec |
oid_symbol |
String |
OID Symbol |
/s |
oid_type |
String |
OID Type |
GAUGE COUNTER |