Queries

Queries in Fleet allow you to ask questions to help you manage, monitor, and identify threats on your devices. This guide will walk you through how to create, schedule, and run a query.

Note: Unless a logging infrastructure is configured on your Fleet server, osquery-related logs will be stored locally on each device. Read more here

New users may find it helpful to start with Fleet's policies. You can find policies and queries from the community in Fleet's query library. To learn more about policies, see What are Fleet policies? and Understanding the intricacies of Fleet policies.

In this guide:

• Create a query
• Run a query
• Schedule a query

Create a query

How to create a query:

1. In the top navigation, select Queries.

2. Select Create new query to navigate to the query console.

3. In the Query field, enter your query. Remember, you can find common queries in Fleet's library.

   

   Avoid using dot notation (".") for column names in your queries as it can cause results to render incorrectly in Fleet UI. Please see issue #15446 for more details.

4. Select Save, enter a name and description for your query, select the frequency that the query should run at, and select Save query.

Run a query

Run a live query to get answers for all of your online hosts.

Offline hosts won’t respond to a live query because they may be shut down, asleep, or not connected to the internet.

How to run a query:

1. In the top navigation, select Queries.

2. In the Queries table, find the query you'd like to run and select the query's name to navigate to the query console.

3. Select Run query to navigate to the target picker. Select All hosts and select Run. This will run the query against all your hosts.

The query may take several seconds to complete because Fleet has to wait for the hosts to respond with results.

Fleet's query response time is inherently variable because of osquery's heartbeat response time. This helps prevent performance issues on hosts.

Schedule a query

In Fleet 4.35.0, the "Schedule" page was removed, and query automations are now configured on the "Queries" page. Instructions for scheduling queries in earlier versions of Fleet can be found here.

Fleet allows you to schedule queries to run at a set frequency. Scheduled queries will send data to Fleet and/or your log destination automatically.

By default, queries that run on a schedule will only target platforms compatible with that query. This behavior can be overridden by setting the platforms in Advanced options when saving a query.

How to send data to your log destination:

Only users with the admin role can manage query automations.

1. In the top navigation, select Queries.

2. Select Manage automations.

3. Check the box next to the queries you want to send data to your log destination, and select Save. (The frequency that queries run at is set when a query is created.)

Note: When viewing a specific team in Fleet Premium, only queries that belong to the selected team will be listed. When configuring query automations for all hosts, only global queries will be listed.

Further reading

• Import and export queries in Fleet
• Osquery: Consider joining against the users table