This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Queryables Overview

Overview

Queryables are S2AP entities that can be used with the S2 Query Language (S2QL). Queryables are generated from various sources the S2AP platform ingests and integrates through multiple pipelines in the platform. For supported integrations, see the Selector Public documentation.

Queryables can be rendered in various ways for the best visualization purpose. For more details and options for the various renderings see the Data Rendering Section in the S2QL user guide.

The Selector platform comes pre-populated with several queryables that can be used to build insightful and actionable dashboards.

Queryables follow established naming conventions:

  • _health: This prefix presents metrics on the health of a resource
  • _health_by_kpi: This prefix presents metrics on the health of a resource by KPI
  • _status prefix: This prefix presents metrics on the status of a resource
  • _rate prefix: This prefix presents metrics on the rate a resource is changing
  • _utilization: This prefix presents metrics on the utilization of a resource
  • _events: This prefix presents event tables
  • _topology : This prefix presents topology tables
  • _inventory: This prefix presents inventory tables

Listing Queryables in Your Deployment

You can list the queryables available for your S2AP deployment by doing the following:

  1. Go to the query builder on the S2AP UI.

Query Builder S2Ap UI

  1. Click on the query builder edit button.

Query Builder S2Ap UI

  1. Click on Export list to get a full CSV list of available queryables for the deployment.

Query Builder S2Ap UI

Key Queryables

There are certain Key Queryables that generate tables or metrics. These key queryables are available in the Selector system for querying a device, an interface, overall site health, the inventory, and logs.

These key queryables have been organized into two tables for Metric and Table results to make it easier to find specific queries and outputs.

Note: The queryables described in these tables are not an exhaustive list of all queryables that the platform supports out of the box. Depending on the deployment integrations and configurations, there can be additional ones. Generate the full queryables list from your deployment for all supported types.

Queryables Details

1 - Metric Queryables

Selector Queryable Metrics

These are queryables that return metrics.

Metric Queryables

Metric QueryableQueryable CategoryDescriptionKey usageTypical Render Views
availabilityDevice ReachabilityTracks the availability when devices are pinged using ICMPVerify device reachability: operators use this to monitor device ICMP reachabilityHoneycomb, line-plot
bgp_device_healthBGP StatusAggregate metric that indicates the health status of devices participating in BGP routingBGP Monitoring: Used to monitor the status of BGP devices to identify and troubleshoot issuesHoneycomb, line-plot
bgp_flap_rateBGP StatusAggregate metric that indicates the BGP flap rate in a time periodBGP Monitoring: Used to monitor the BGP link/interface flap rate to identify and troubleshoot BGP issues.Honeycomb, line-plot
bgp_peer_downtimeBGP StatusAggregate metric that tracks the BGP peer down time to monitor the health status of BGPBGP Monitoring: Used to monitor the status of BGP devices to identify and troubleshoot issuesHoneycomb, line-plot
bgp_peer_stateBGP StatusMetric that indicates the health status of a BGP peerBGP Monitoring: Used to monitor the status of BGP devices to identify and troubleshoot issues.Honeycomb, line-plot
bgp_peer_status_by_kpiBGP StatusAggregate metric that indicates the overall health status of BGP by KPIBGP Monitoring: Used to monitor the status of BGP devices by KPI to identify and troubleshoot issues.Honeycomb, line-plot
circuit_healthCircuit HealthTracks the health of Layer 2 circuitsCircuit Monitoring: Monitors circuit healthHoneycomb, line-plot
cpu_usageDevice HealthTracks the CPU usage of devices.Detailed Device Health monitoring: Allows operators to monitor device CPU usage to prevent device health degradation.Honeycomb, line-plot
device_availabilityDevice ReachabilityTracks the availability when devices are pinged using ICMPVerify device reachability: operators use this to monitor device ICMP reachabilityHoneycomb, line-plot
device_harddown_healthDevice HealthIndicates if a device is “hard down” i.e. completely unreachable. This is a critical device liveness, health check via SNMP , ICMP. indicator,Overall device Health monitoring: Operators monitor devices, and when a device is confirmed to be unreachable via SNMP and ICMP, a high severity alert is typically triggeredHoneycomb, line -plot
device_healthDevice HealthAggregate health metric showing overall health status of devices. It aggregates various health signals (such as SNMP, ICMP, CPU, memory etc.) to provide a single health status (e.g., Green/Healthy, Red/Unhealthy)Overall device Health monitoring: primary metric to monitor overall operational state of the device network fleetHoneycomb, line-plot
device_health_by_kpiDevice HealthAggregate metric that shows device health status based on specific Key Performance Indicators (KPIs) such as CPU, port, memory, power etc. The value of this metric is derived based on the health of the individual KPIs, and 0 indicates healthy (green), 1 indicates unhealthy (red)Device Health monitoring: Allows operators to identify the specific KPI (CPU, Health, Memory, Interface, Disk, BGP etc.) causing a device health degradation.Honeycomb, line -plot
device_health_rollupDevice HealthHoneycomb, line-plot
device_inventory_presenceDevice InventoryCount of number of devices present grouping devices together by model, productDevice Inventory Monitoring: Operators use it to monitor device inventory such as count of devicesHoneycomb, line-plot
device_ping_availabilityDevice ReachabilityTracks availability status of devices based on Pingmesh (ICMP ping) results. It tracks the reachability of devices from various probes. Values include: - -1: Unreachable - 0: No Loss (Healthy) - 1: Total LossVerify Network reachability: Operators monitor devices, and when a device is confirmed to be unreachable ICMP, a high severity alert is typically triggeredHoneycomb, line-plot
device_ping_healthDevice ReachabilityDerived metric that is derived from ping availability metrics and feeds into device health and KPIVerify device reachability: operators use this to monitor device ICMP reachability healthHoneycomb, line-plot
device_power_statusDevice HealthMetric that tracks the status of device powerDevice Health MonitoringHoneycomb, line-plot
device_reset_healthDevice HealthMetric that tracks if a device got reset ie device crash or device rebootedDevice Health Monitoring: Allows operators to monitor if a device got reset (crash or restart)Honeycomb, line-plot
device_snmp_availabilityDevice ReachabilityTracks the availability of devices for SNMPVerify device reachability: operators use this to monitor device SNMP reachabilityHoneycomb, line-plot
device_temperature_f_healthDevice HealthMetric that tracks the device temperature in farenheitDevice Health MonitoringHoneycomb, line-plot
disk_device_healthDevice HealthTracks the disk health of devices.Detailed Device Health monitoring: Allows operators to monitor disk health to prevent device health degradation.Honeycomb, line-plot
ec2_instance_healthEC2 instance healthMetric that tracks EC2 instance healthEC2 Monitoring: Operators monitor the health of their EC2 instances running in AWS public cloud.Honeycomb, line-plot
ec2_instance_health_by_kpiEC2 instance healthMetric that tracks EC2 instance health by KPIEC2 Monitoring: Operators monitor the health of their EC2 instances running in AWS public cloud.Honeycomb, line-plot
if_admin_oper_statusInterface HealthAggregate metric that shows agregate of the admin status and operational status of a port (up/down).Interface Health monitoring: Used to monitor the operational status of network interfaces by various KPIsHoneycomb, line-plot
if_flapInterface HealthShows the count of Interface flapsInterface Health monitoring: Used to monitor interface flapsHoneycomb, line-plot
if_host_statusInterface HealthShows the status of the host that the interface belongs to?Interface Health monitoring: Used to monitor interface flapsHoneycomb, line-plot
if_in_errorsInterface HealthShows the count of interface inbound errorsInterface Health monitoring: Used to monitor interface errorsHoneycomb, line-plot
if_in_utilizationInterface HealthShows interface inbound traffic utilization/throughputInterface Health monitoring: Used to monitor interface utilizationHoneycomb, line-plot
if_out_errorsInterface HealthShows the count of interface outbound errorsInterface Health monitoring: Used to monitor interface errorsHoneycomb, line-plot
if_out_utilizationInterface HealthShows interface outbound traffic utilization/throughputInterface Health monitoring: Used to monitor interface utilizationHoneycomb, line-plot
if_statusInterface HealthMetric that indicates the status of an interface - good (interface up) , bad (interface down/some issue). Values: 0 (Good), 1 (Bad).Interface Health monitoring: Used to monitor the operational status of network interfacesHoneycomb, line-plot
if_status_by_kpiInterface HealthInterface health status based on specific Key Performance Indicators (KPIs). Shows health of kpis for an interfaceInterface Health monitoring: Used to monitor the operational status of network interfaces by various KPIsHoneycomb, line-plot
ipsla_device_healthIPSLAMetric that monitors of IP SLA device health analysing traffic metrics like jitter, latency, packet loss etc.IP SLA monitoring: Operators monitor IP SLA traffic metrics like latency, jitter, packet loss to track the state of their devices, and network.Honeycomb, line-plot
jitterDevice ReachabilityTracks the jitter when devices are pingedVerify device reachability: operators use this to monitor device reachability health. When there is high jitter, the device connectivity has issues.Honeycomb, line-plot
l3vpn_vrf_device_statusL3vpn device statusMetric that tracks the L3VPN device statusL3VPN monitoring: Operators monitor the L3VPN VRF status of devicesHoneycomb, line-plot
l3vpn_vrf_statusMetric that trcks the L3VPN statusL3VPN monitoring: Operators monitor the L3VPN VRF status of devicesHoneycomb, line-plot
latencyDevice ReachabilityTracks the latency when devices are pingedVerify device reachability: operators use this to monitor device reachability health. When there is high latency the device connectivity has issues.Honeycomb, line-plot
link_monitor_device_health_by_kpiLink HealthMetric that tracks the state of a link based on KPIs to understand the health of the device.Link Monitoring: Operators monitor the state of links by KPIs to detect issues in their device health proactivelyHoneycomb, line-plot
link_monitor_stateLink HealthMetric that tracks the state of a linkLink Monitoring: Operators monitor the state of links to detect issues in their network, data centers proactivelyHoneycomb, line-plot
lldp_session_status_by_kpiLLDPMetric that tracks the status of LLDP sessions by KPIsLLDP Monitoring: Operators monitor LLDP session status by KPIs undestand the state of their network and devicesHoneycomb, line-plot
log_countsLogsMetric that counts the total volume of raw logsLog MonitoringHoneycomb, line-plot
memory_usageDevice HealthTracks the memory usage of devices.Detailed Device Health monitoring: Allows operators to monitor device memory usage to prevent device health degradation.Honeycomb, line-plot
ospf_device_healthOSPF statusAggregate metric that indicates the health status of devices participating in OSPFOSPF Monitoring: Used to monitor the status of OSPF devices to identify and troubleshoot issues.Honeycomb, line-plot
ospf_if_statusOSPF statusAggregate metric that indicates the health status of interfaces of devices participating in OSPFOSPF Monitoring: Used to monitor the status of OSPF device interfaces to identify and troubleshoot issues.Honeycomb, line-plot
ospf_nbr_stateOSPF statusMetric that indicates the health status of an OSPF neighborOSPF Monitoring: Used to monitor the status of OSPF devices to identify and troubleshoot issues.Honeycomb, line-plot
ospf_status_by_kpiOSPF statusAggregate metric that indicates the health status of devices participating in OSPF by KPIOSPF Monitoring: Used to monitor the status of OSPF devices by KPI to identify and troubleshoot issues.Honeycomb, line-plot
packet_loss_pctDevice ReachabilityTracks the packet loss when devices are pingedVerify device reachability: operators use this to monitor device reachability health. When there is 100% packet loss, the device is unreachableHoneycomb, line-plot
port_device_healthPort HealthMetric that monitors the health of a port to catch device health issues proactivelyDevice Port Monitoring: Operators monitor port health of devices to catch issus proactivelyHoneycomb, line-plot
power_supply_statePower Supply stateMetric that monitors the state of the power supplyPower Supply Monitoring: Operators monitor the health of power supplies to get proactive notification on issues so that they can prevent broader outages (server, devices, networks etc. )Honeycomb, line-plot
rollup_if_utilizationInterface HealthRollup metric that shows interface utilizationInterface Health monitoring: Used to monitor interface utilization , used in capacity reportsHoneycomb, line-plot
sd_wan_device_healthSdwan HealthMetric that tracks the health of Sdwan devicesSdwan monitoring: Operators can monitor the health of Sdwan devicesHoneycomb, line-plot
site_bgp_statusSite BGP StatusAggregate metric that indicates the BGP status of a site, based on the aggregate of all BGP devices in that siteBGP Monitoring: BGP Monitoring at site level to identify and troubleshoot issues.Honeycomb, line-plot
site_harddown_healthSite HealthAggregate metric that indicates if a site is “hard down” i.e. all devices in the site are completely unreachable. This is a critical device liveness, health check via SNMP , ICMPOverall Site Health monitoring: Operators monitor health of the overall site, based on the aggregate of health of all devices in that site. When an entire site is unreachable (because all devices are unreachable via SNMP and ICMP), a high severity alert is typically triggered.Honeycomb, line-plot
site_healthSite HealthAggregate health metric showing overall health status of site. It aggregates various health signals to provide a single status for site health (e.g., Green/Healthy, Red/Unhealthy)Overall Site Health monitoring: Operators monitor health of the overall site, based on the aggregate of health of all devices in that site When an entire site is unreachable (because all devices are unreachable via SNMP and ICMP), a high severity alert is typically triggered.Honeycomb, line-plot
site_health_by_kpiSite HealthAggregate health metric showing overall health status of site KPIs. It aggregates various KPI signals to provide a single status for site KPI health (e.g., Green/Healthy, Red/Unhealthy) Shows health of KPIs for a siteOverall Site Health monitoring: Operators monitor health of the overall site KPIs, based on the aggregate of health of all KPIs for that site.Honeycomb, line-plot
sys_uptimeSystem HealthMetric that tracks system uptime - time since the device has been up.Device monitoringHoneycomb, line-plot
tunnel_status_by_deviceTunnel StatusMetric that tracks IPSec tunnel up/down status for a device. Tunnel up is red, Tunnel down is greenTunnel Status:Honeycomb, line-plot
wilc_ap_failed_countWireless MonitoringMetric that tracks the failed Access Point (AP) countWireless Monitoring: Operators use this to monitor their wireles devices (AP, Wireless lan controller) . Single pane, unified view across wireless and wired with SelectorHoneycomb, line-plot
wlc_ap_connect_countWireless MonitoringMetric that tracks the cconnected Access Point (AP) countWireless Monitoring: Operators use this to monitor their wireles devices (AP, Wireless lan controller) . Single pane, unified view across wireless and wired with SelectorHoneycomb, line-plot
wlc_max_clients_countWireless MonitoringMetric that tracks the count of max clients connected to an Access Point (AP)Wireless Monitoring: Operators use this to monitor their wireles devices (AP, Wireless lan controller) . Single pane, unified view across wireless and wired with SelectorHoneycomb, line-plot

2 - Table Queryables

Selector Queryables Table

These are queryables that return tables.

Table Queryables

Table QueryableQueryable CategoryDescriptionKey usageTypical Render Views
audit_logsAudit logsTable of Audit logsAuditing and compliance Monitoring: Trackers users, and their key actions on S2AP and timestamps.Table
configs_diffConfig change monitoringTracks if a device config has changed from a previous snapshot. Ex. Ip address changed of a deviceConfiguration change monitoring: Operators can monitor configuration changes to be able to pin point causes of issues.Honeycomb, line-plot
correlation_eventsCorrelated InsightsTable that stores correlated events metadata, the records in this table are correlated and anchored by specific labels to improve event grouping.Correlated Insights: Used to monitor correlated events to get a comprehensive view of root cause of issuesTable
correlations_summaryCorrelated InsightsTable that stores the summary of correlated events used in the correlations graph and dashboardsTable
device_event_patternsDevice EventsTable that stores structured log event patterns from networking devices. Event patterns are categorized as .. to facilitate trend analysis and automated correlation.Log Pattern Analysis: Used for analysing network event patterns from logsTable
device_events_mlDevice EventsTable that stores structured log event stream from networking devices that have been processed and modeled using Machine Learning. Unlike raw logs, these events are categorized (e.g., Interface Flap, BGP Peer Down) to facilitate trend analysis and automated correlation.Log Pattern Analysis: Used for analysing network event patterns from logsTable
device_events_pattern_groupsDevice EventsTable that stores structured log event patterns and groups from networking devices. Event pattern groups are categorized to facilitate trend analysis and automated correlation.Log Pattern Analysis: Used for analysing network event patterns from logsTable
device_logsDevice LogsTable that stores the raw logs ingested from the network devices. This contains the original log messages, timestamps, and severity levels without the ML modeling layer.Raw logs analysis and troubleshootingHoneycomb, line-plot
devicediscoveryDevice DiscoveryTable that contains the raw device discovery inventoryTable
interface_database_inventoryInterface InventoryMetastore Inventory table containing detailed information about network interfaces. It provides metadata such as interface names, descriptions, speeds, types, and connected remote devices.Contextualize interface metrics with interface config metadataTable
ipsec_logsTable
ipsec_reason_events_mlIPSec stateTable that stores IPsec events informationTable
isp_inventoryISP Inventory TableTable that stores key isp information for devicesISP inventory:Table
layer2_topologyLayer 2 TopologyTable containing Layer 2 topology data.Layer 2 Topology InventoryTable, Topology map
lldp_tableLLDPTable that holds LLDP inventory (Link Layer Discovery Protocol)LLDP Monitoring: Operators use LLDP to discover device topologies, and build a topology mapTable
s2_device_inventoryDevice InventoryMetastore inventory table containing detailed metadata about all network devices. It serves as the source of truth for device attributes like Vendor, Model, Operating System, Site, Location, and Roles.Contextualize metrics and logs with device metadataTable
s2_if_metatagsInterface MetadataInterface metadata?Table
s2_query_traceQuery MetadataThis table stores query details such as S2QL or Natural Language queries, usage metrics, user who executed the query and the time to return a response.Query monitoring: Operators use this to track details around the queries being executed by users, their usage and the performance of those queriesTable
s2_snow_incidentsService Now IncidentsTable that stores the SNOW incidents dataSNOW Incident monitoringTable
s2_snow_incidents_analysisService Now IncidentsTable that has Service Now Incidents data for incident analysis dashboardsSNOW Incident monitoringTable
s2_snow_inventoryService Now IncidentsTable that stores the SNOW incidents dataSNOW Incident monitoringTable
snmptrap_default_eventSNMP TrapsLanding table for initial ingestion of SNMP trapsSNMP Trap monitoringTable
synthetics_topologySyntheticsTable that has the synthetics probe inventory.Table
sys_logsDevice LogsTable that stores the raw system log stream ingested from the network devices. This stream contains the original log messages, timestamps, and severity levels without the ML modeling layer.Raw logs analysis and troubleshootingHoneycomb, line-plot
topology_bgpTopology StateTable that stores BGP topology dataTopology State: Operators use this to get BGP Topology informationTable, Topology Map
topology_isisTopology StateTable that stores ISIS topology dataTopology State: Operators use this to get ISIS Topology information.Table, Topology Map
topology_l3vpnTopology StateTable that stores L3VPN topology dataTopology State: Operators use this to get L3VPN Topology information.Table, Topology Map
topology_ldpTopology StateTable that stores LDP topology dataTopology State: Operators use this to get LDP Topology information.Table, Topology Map
topology_ospfTopology StateTable that stores OSPF topology dataTopology State: Operators use this to get OSPF Topology information.Table, Topology Map