Supported Metrics
This page lists the metrics collected by the Cisco Meraki integration and describes the default monitoring configuration applied when the integration is installed.Use this information to understand what is monitored out-of-the-box and how to customize thresholds, templates, and alert behaviour for your environment
The following tabs represent the Metric Category of Cisco Meraki.
Availability
Performance
Usage
| Native Type | Metric Name | Display Name | Units | Version | Description | Metric Group |
|---|---|---|---|---|---|---|
| Cisco Meraki Organization | cisco_meraki_org_DevicesOfflineCount | Cisco Meraki Organization Devices Offline Count | count | 3.0.0 | Total number of offline devices | |
| cisco_meraki_org_DevicesAlertingCount | Cisco Meraki Organization Devices Alerting Count | count | 3.0.0 | Total number of alerting devices | ||
| cisco_meraki_org_DevicesDormantCount | Cisco Meraki Organization Devices Dormant Count | count | 3.0.0 | Total number of dormant devices | ||
| Cisco Meraki Wireless Access Point | cisco_meraki_wireless_DeviceStatus | Cisco Meraki Wireless Device Status | 3.0.0 | Provides the availability status of the Meraki wireless access point as reported by the Meraki dashboard. Possible values are Offline(0) - device is offline or its status is unknown/not reported (default), Online(1) - device is connected to the Meraki cloud and operating normally, Dormant(2) - device is connected to the Meraki cloud but idle/not passing traffic, Alerting(3) - device is online but reporting an alert condition. | ||
| Cisco Meraki Switch | cisco_meraki_switch_DeviceStatus | Cisco Meraki Switch Device Status | 3.0.0 | Provides the availability status of the Meraki switch as reported by the Meraki dashboard. Possible values are Offline(0) - device is offline or its status is unknown/not reported (default), Online(1) - device is connected to the Meraki cloud and operating normally, Dormant(2) - device is connected to the Meraki cloud but idle/not passing traffic, Alerting(3) - device is online but reporting an alert condition. | ||
| Cisco Meraki Firewall | cisco_meraki_firewall_DeviceStatus | Cisco Meraki Firewall Device Status | 3.0.0 | Provides the availability status of the Meraki security appliance (MX/Z firewall) as reported by the Meraki dashboard. Possible values are Offline(0) - device is offline or its status is unknown/not reported (default), Online(1) - device is connected to the Meraki cloud and operating normally, Dormant(2) - device is connected to the Meraki cloud but idle/not passing traffic, Alerting(3) - device is online but reporting an alert condition. | ||
| cisco_meraki_firewall_WanFailoverStatus | Cisco Meraki Firewall WAN Failover Status | 3.0.0 | Provides whether the security appliance is carrying traffic on the WAN uplink its network is configured to prefer, or has failed over; failed-over values name the uplink now carrying traffic. Possible values are On Configured Primary(0) - traffic is on the configured default uplink (normal, whichever uplink that is), Failed Over - WAN 1(1), Failed Over - WAN 2(2), Failed Over - WAN 3(3), Failed Over - Cellular(4), Failed Over - Other(5) - traffic has shifted to the named backup uplink, Standby - Spare(6) - a healthy passive warm spare holding its uplinks in standby, All Uplinks Down(7) - no uplink is active. | |||
| cisco_meraki_firewall_HaStatus | Cisco Meraki Firewall HA Status | 3.0.0 | Provides the warm-spare high-availability pair state of the security appliance; the label carries the appliance's own role. Possible values are Not Configured(0) - the appliance is not part of a warm-spare pair, Primary - Healthy(1) - this primary and its spare are both online, Spare - Healthy(2) - this spare and its primary are both online, Primary - Spare Down(3) - the spare is down and redundancy is lost, Spare - Active Primary Down(4) - the primary is down and this spare has taken over, Unknown(5) - HA is enabled but the role or peer state cannot be determined. | |||
| Cisco Meraki Router | cisco_meraki_router_DeviceStatus | Cisco Meraki Router Device Status | 3.0.0 | Provides the availability status of the Meraki router (MG cellular gateway or campus gateway) as reported by the Meraki dashboard. Possible values are Offline(0) - device is offline or its status is unknown/not reported (default), Online(1) - device is connected to the Meraki cloud and operating normally, Dormant(2) - device is connected to the Meraki cloud but idle/not passing traffic, Alerting(3) - device is online but reporting an alert condition. | ||
| Cisco Meraki IP Camera | cisco_meraki_ipCamera_DeviceStatus | Cisco Meraki IP Camera Device Status | 3.0.0 | Provides the availability status of the Meraki MV IP camera as reported by the Meraki dashboard. Possible values are Offline(0) - device is offline or its status is unknown/not reported (default), Online(1) - device is connected to the Meraki cloud and operating normally, Dormant(2) - device is connected to the Meraki cloud but idle/not passing traffic, Alerting(3) - device is online but reporting an alert condition. | ||
| Cisco Meraki Environmental Sensor | cisco_meraki_sensor_DeviceStatus | Cisco Meraki Environmental Sensor Device Status | 3.0.0 | Provides the availability status of the Meraki MT environmental sensor as reported by the Meraki dashboard. Possible values are Offline(0) - device is offline or its status is unknown/not reported (default), Online(1) - device is connected to the Meraki cloud and operating normally, Dormant(2) - device is connected to the Meraki cloud but idle/not passing traffic, Alerting(3) - device is online but reporting an alert condition. | ||
| Cisco Meraki Device | cisco_meraki_otherDevice_DeviceStatus | Cisco Meraki Other Device Status | 3.0.0 | Provides the availability status of the Meraki device of any other product type as reported by the Meraki dashboard. Possible values are Offline(0) - device is offline or its status is unknown/not reported (default), Online(1) - device is connected to the Meraki cloud and operating normally, Dormant(2) - device is connected to the Meraki cloud but idle/not passing traffic, Alerting(3) - device is online but reporting an alert condition. | ||
| Cisco Meraki Switch Port | cisco_meraki_switch_port_EnableStatus | Cisco Meraki Switch Port Enable Status | 3.0.0 | Provides the administrative state of the switch port. Possible values are Enabled(1) - the port is administratively enabled, Disabled(0) - the port is administratively disabled or the enabled flag is not reported (default). | ||
| cisco_meraki_switch_port_ConnectionStatus | Cisco Meraki Switch Port Connection Status | 3.0.0 | Provides the operational connection state of the switch port. Possible values are Connected(1) - Meraki reports the port status as Connected, Disconnected(0) - Meraki reports any other port status (such as Disconnected or Disabled) or does not report a status (default). | |||
| Cisco Meraki Uplink | cisco_meraki_uplink_Status | Cisco Meraki Uplink Status | 3.0.0 | Provides the status of the WAN uplink of the Meraki appliance (MX/Z) or cellular gateway (MG) as reported by the Meraki dashboard. A configured-but-unwired uplink reports Not Connected(0) permanently, so only Failed(4) is treated as critical. Possible values are Not Connected(0) - uplink is not connected or its status is unknown/not reported (default), Active(1) - uplink is up and actively carrying traffic, Ready(2) - uplink is up and standing by as a failover path, Connecting(3) - uplink is establishing its connection, Failed(4) - uplink connection has failed. |
| Native Type | Metric Name | Display Name | Units | Version | Description | Metric Group |
|---|---|---|---|---|---|---|
| Cisco Meraki Network | cisco_meraki_network_wireless_LatencyBackgroundAvg | Cisco Meraki Network Wireless Latency Background Avg | ms | 3.0.0 | Average background traffic latency | |
| cisco_meraki_network_wireless_LatencyBesteffortAvg | Cisco Meraki Network Wireless Latency Besteffort Avg | ms | 3.0.0 | Average best-effort traffic latency | ||
| cisco_meraki_network_wireless_LatencyVideoAvg | Cisco Meraki Network Wireless Latency Video Avg | ms | 3.0.0 | Average video traffic latency | ||
| cisco_meraki_network_wireless_LatencyVoiceAvg | Cisco Meraki Network Wireless Latency Voice Avg | ms | 3.0.0 | Average voice traffic latency | ||
| cisco_meraki_network_VpnLatency | Cisco Meraki Network Vpn Latency | ms | 3.0.0 | Site-to-site VPN peer average latency | ||
| cisco_meraki_network_VpnLossPercent | Cisco Meraki Network Vpn Loss Percent | % | 3.0.0 | Site-to-site VPN peer average loss percentage | ||
| cisco_meraki_network_VpnJitter | Cisco Meraki Network Vpn Jitter | ms | 3.0.0 | Site-to-site VPN peer average jitter | ||
| cisco_meraki_network_VpnMos | Cisco Meraki Network Vpn Mos | 3.0.0 | Site-to-site VPN peer average MOS (Mean Opinion Score, 1-5) | |||
| Cisco Meraki Wireless Access Point | cisco_meraki_wireless_LatencyBackgroundAvg | Cisco Meraki Wireless Latency Background Avg | ms | 3.0.0 | AP background traffic latency | |
| cisco_meraki_wireless_LatencyBesteffortAvg | Cisco Meraki Wireless Latency Besteffort Avg | ms | 3.0.0 | AP best-effort traffic latency | ||
| cisco_meraki_wireless_LatencyVideoAvg | Cisco Meraki Wireless Latency Video Avg | ms | 3.0.0 | AP video traffic latency | ||
| cisco_meraki_wireless_LatencyVoiceAvg | Cisco Meraki Wireless Latency Voice Avg | ms | 3.0.0 | AP voice traffic latency | ||
| Cisco Meraki Switch | cisco_meraki_switch_TotalTrafficKbps | Cisco Meraki Switch Total Traffic | Kbps | 3.0.0 | Average total traffic rate across all of the switch's ports in Kbps over the Meraki statuses endpoint's default 1-day lookback (sum of per-port trafficInKbps.total). A 24-hour average, not an instantaneous rate. | |
| cisco_meraki_switch_PortsUpPercent | Cisco Meraki Switch Ports Up Percent | % | 3.0.0 | Percentage of the switch's reported ports with an established link (Connected ports divided by total reported ports x 100). | ||
| cisco_meraki_switch_PoePowerUsage | Cisco Meraki Switch PoE Power Usage | W | 3.0.0 | Average PoE power delivered by the switch's ports in watts, derived from the per-port energy Meraki reports over the statuses endpoint's default 1-day lookback (sum of powerUsageInWh divided by 24 hours). Reported only when at least one port reports PoE data. | ||
| Cisco Meraki Firewall | cisco_meraki_firewall_PerformanceScore | Cisco Meraki Firewall Performance Score | 3.0.0 | Device utilization (load) score of the MX security appliance, from the perfScore field of GET /devices/{serial}/appliance/performance, on a 0-100 scale where higher values mean heavier load; sustained values above 75 indicate the appliance is under-sized for its traffic. Higher is worse, not better. A value of 0 may indicate no performance data was available from the API rather than an idle appliance. | ||
| Cisco Meraki Router | cisco_meraki_router_SignalRSRQ | Cisco Meraki Router Signal RSRQ | dB | 3.0.0 | Cellular signal quality (RSRQ) of the gateway's active cellular uplink in dB, from the organization-wide cellular uplink statuses. Around -10 dB indicates good quality; below -15 dB poor quality. | |
| cisco_meraki_router_SignalRSRP | Cisco Meraki Router Signal RSRP | dBm | 3.0.0 | Cellular signal strength (RSRP) of the gateway's active cellular uplink in dBm, from the organization-wide cellular uplink statuses. Around -80 dBm indicates good signal; below -100 dBm poor signal. | ||
| Cisco Meraki Switch Port | cisco_meraki_switch_port_TrafficTotal | Cisco Meraki Switch Port Traffic Total | Kbps | 3.0.0 | Average total traffic rate (sent + received) on the switch port in Kbps over the Meraki statuses endpoint's default 1-day lookback (trafficInKbps.total). A 24-hour average, not an instantaneous rate. | |
| cisco_meraki_switch_port_TrafficSent | Cisco Meraki Switch Port Traffic Sent | Kbps | 3.0.0 | Average sent traffic rate on the switch port in Kbps over the Meraki statuses endpoint's default 1-day lookback (trafficInKbps.sent). A 24-hour average, not an instantaneous rate. | ||
| cisco_meraki_switch_port_TrafficReceived | Cisco Meraki Switch Port Traffic Received | Kbps | 3.0.0 | Average received traffic rate on the switch port in Kbps over the Meraki statuses endpoint's default 1-day lookback (trafficInKbps.recv). A 24-hour average, not an instantaneous rate. | ||
| Cisco Meraki Uplink | cisco_meraki_uplink_LossPercent | Cisco Meraki Uplink Loss Percent | % | 3.0.0 | WAN uplink packet loss percentage for MX/Z security appliances and MG cellular gateways, measured by Meraki connectivity probes to 8.8.8.8 (Google DNS); the most recent sample from the last 5 minutes is published. | |
| cisco_meraki_uplink_Latency | Cisco Meraki Uplink Latency | ms | 3.0.0 | WAN uplink latency in milliseconds for MX/Z security appliances and MG cellular gateways, measured by Meraki connectivity probes to 8.8.8.8 (Google DNS); the most recent sample from the last 5 minutes is published. | ||
| cisco_meraki_uplink_Jitter | Cisco Meraki Uplink Jitter | ms | 3.0.0 | WAN uplink jitter in milliseconds for MX/Z security appliances and MG cellular gateways, measured by Meraki connectivity probes to 8.8.8.8 (Google DNS); the most recent sample from the last 5 minutes is published. |
| Native Type | Metric Name | Display Name | Units | Version | Description | Metric Group |
|---|---|---|---|---|---|---|
| Cisco Meraki Organization | cisco_meraki_org_APIStats | Cisco Meraki Organization API Statistics | count | 3.0.0 | Number of API calls made by the integration within the polling frequency, per API and resource | |
| cisco_meraki_org_DevicesTotalCount | Cisco Meraki Organization Devices Total Count | count | 3.0.0 | Total number of devices in the organization | ||
| cisco_meraki_org_DevicesOnlineCount | Cisco Meraki Organization Devices Online Count | count | 3.0.0 | Total number of online devices | ||
| Cisco Meraki Network | cisco_meraki_network_TotalNumOfClientsConnected | Cisco Meraki Network Total Number Of Clients Connected | count | 3.0.0 | Total number of unique clients seen on the network in the last 24 hours (Meraki /networks/{networkId}/clients, timespan=86400). Includes clients that are currently offline; this is not a count of currently connected clients. The currently online subset is reported by cisco_meraki_network_ClientsOnlineCount. | |
| cisco_meraki_network_ClientsOnlineCount | Cisco Meraki Network Clients Online Count | count | 3.0.0 | Provides the number of clients currently reported Online on the network. A value of 0 means no clients are online or the client list was not returned for the poll. | ||
| cisco_meraki_network_wireless_ConnectionSuccess | Cisco Meraki Network Wireless Connection Success | count | 3.0.0 | Number of successful wireless client connection attempts (association, authentication, DHCP and DNS all completed) across the network during the last 5 minutes (Meraki connectionStats, timespan=300). | ||
| Cisco Meraki Wireless Access Point | cisco_meraki_wireless_ConnectionSuccess | Cisco Meraki Wireless Connection Success | count | 3.0.0 | Number of successful wireless client connection attempts (association, authentication, DHCP and DNS all completed) on this access point during the last 5 minutes (Meraki connectionStats, timespan=300). | |
| cisco_meraki_wireless_CpuUsagePercent | Cisco Meraki Wireless CPU Usage Percent | % | 3.0.0 | AP CPU utilization percent derived from the 5-minute CPU load average divided by CPU core count (values above 100 indicate an overloaded AP) | ||
| cisco_meraki_wireless_MemoryUsagePercent | Cisco Meraki Wireless Memory Usage Percent | % | 3.0.0 | Peak memory utilization percentage of the access point during the most recent reported five-minute interval from Meraki's device memory usage history. | ||
| Cisco Meraki Switch | cisco_meraki_switch_MemoryUsagePercent | Cisco Meraki Switch Memory Usage Percent | % | 3.0.0 | Peak memory utilization percentage of the switch during the most recent reported five-minute interval from Meraki's device memory usage history. | |
| cisco_meraki_switch_PortsConnectedCount | Cisco Meraki Switch Ports Connected Count | count | 3.0.0 | Number of the switch's ports with an established link (Meraki port status Connected), out of all ports reported for the switch. | ||
| Cisco Meraki Firewall | cisco_meraki_firewall_MemoryUsagePercent | Cisco Meraki Firewall Memory Usage Percent | % | 3.0.0 | Peak memory utilization percentage of the firewall during the most recent reported five-minute interval from Meraki's device memory usage history. | |
| Cisco Meraki Switch Port | cisco_meraki_switch_port_SecureConnectEnabled | Cisco Meraki Switch Port Secure Connect Enabled | 3.0.0 | Provides whether Secure Connect (802.1X) is enabled on the switch port. Possible values are Enabled(1) - Secure Connect is enabled on the port, Disabled(0) - Secure Connect is disabled or the flag is not reported (default). Reported only for ports that return Secure Connect (securePort) data. | ||
| cisco_meraki_switch_port_SecureConnectActive | Cisco Meraki Switch Port Secure Connect Active | 3.0.0 | Provides whether Secure Connect is currently active on the switch port. Possible values are Active(1) - Secure Connect is active on the port, Inactive(0) - Secure Connect is not active or the flag is not reported (default). Reported only for ports that return Secure Connect (securePort) data. | |||
| cisco_meraki_switch_port_SecureConnectAuthStatus | Cisco Meraki Switch Port Secure Connect Auth Status | 3.0.0 | Secure Connect (MACsec) authentication state of the switch port. Possible values are Disabled(0), Enabled(1), Authentication In Progress(2), Authentication Successful(3), Authentication Failure(4), Authentication Timed Out(5). | |||
| cisco_meraki_switch_port_UsageTotal | Cisco Meraki Switch Port Usage Total | KB | 3.0.0 | Total data transferred (sent + received) on the switch port in KB over the Meraki statuses endpoint's default 1-day lookback (usageInKb.total). | ||
| cisco_meraki_switch_port_UsageSent | Cisco Meraki Switch Port Usage Sent | KB | 3.0.0 | Data sent from the switch port in KB over the Meraki statuses endpoint's default 1-day lookback (usageInKb.sent). | ||
| cisco_meraki_switch_port_UsageReceived | Cisco Meraki Switch Port Usage Received | KB | 3.0.0 | Data received on the switch port in KB over the Meraki statuses endpoint's default 1-day lookback (usageInKb.recv). | ||
| Cisco Meraki Uplink | cisco_meraki_uplink_BandwidthUtilization | Cisco Meraki Uplink Bandwidth Utilization | % | 3.0.0 | Appliance WAN uplink bandwidth utilization percentage - the busier direction of sent/received throughput over the poll window, each measured against its own traffic shaping limit, or the MX model rated maximum throughput when no limit is configured |
Default monitoring configurations
Cisco Meraki provides default monitoring components that include:
- Global Device Management Policies
- Global Templates
- Global Monitors
These configurations are applied automatically upon installation. Customize them for your environment by cloning the global versions and modifying thresholds or alerting behaviour.
It is recommended to apply this customization prior to installing the application to prevent unnecessary alerts and reduce noise
Default Global Device Management Policies available
OpsRamp will have a Global Device Management Policy for each Native Type of Cisco Meraki. Find those Device Management Policies at Setup -> Resources -> Device Management Policies -> Search with suggested names in global scope. Each Device Management Policy follows below naming convention.{appName nativeType - version}Ex : cisco-meraki Cisco Meraki Organization - 1 (i.e, appName = cisco-meraki, nativeType =Cisco Meraki Organization, version = 1)
Default Global Templates available
OpsRamp will have a Global template for each Native Type of Cisco Meraki. Find those templates at Setup -> Monitoring -> Templates -> Search with suggested names in global scope. Each template follows below naming convention.{appName nativeType 'Template' - version}Ex : cisco-meraki Cisco Meraki Organization Template - 1 (i.e, appName = cisco-meraki , nativeType = Cisco Meraki Organization, version = 1)
Default Global Monitors available
OpsRamp will have a Global Monitors for each Native Type which has monitoring support. Find those monitors at Setup -> Monitoring -> Monitors -> Search with suggested names in global scope. Each Monitors follows below naming convention.
{monitorKey appName nativeType - version}Ex : Cisco Meraki Organization Monitor cisco-meraki Cisco Meraki Organization 1 (i.e, monitorKey = Cisco Meraki Organization Monitor, appName = cisco-meraki , nativeType = Cisco Meraki Organization, version= 1)