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:
- Go to the query builder on the S2AP UI.
- Click on the query builder edit button.
- Click on Export list to get a full CSV list of available queryables for the deployment.
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.