empayre/fleet
14
0
Fork 0
mirror of https://github.com/empayre/fleet.git synced 2024-11-06 17:05:18 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
24c0dfa603
fleet/docs/Using-Fleet/Fleet-UI.md
Noah Talerman 24c0dfa603
Update using-fleet/fleet-ui doc page (#7599) 
- Add "Create a query" and "Run a query" sections
- Update "Schedule a query" section
- Remove unused images from `docs/images/`.
2022-09-09 10:14:40 -04:00

3.7 KiB
Raw Blame History

Fleet UI

Create a query

Queries in Fleet allow you to ask a multitude of questions to help you manage, monitor, and identify threats on your devices.

If you're unsure of what to ask, head to Fleet's query library. There you'll find common queries that have been tested by members of our community.

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.

  4. Select Save, enter a name and description for your query, 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

Fleet allows you to schedule queries. Scheduled queries will run and send results to your log destination automatically.

The default log destination, filesystem, is good to start. With this set, results are sent to the /var/log/osquery/osqueryd.snapshots.log file on each host’s filesystem. To see which log destinations are available in Fleet, head to the osquery logs guide.

How to schedule a query:

  1. In the top navigation, select Schedule.

  2. Select Schedule a query.

  3. Select the Select query dropdown and choose the query that you'd like to run on a schedule.

  4. Select the Frequency dropdown and choose how often you'd like the query to run and send results to your log destination. Every hour is a good frequency to start. You can change this later.

  5. Select Schedule.

Update agent options

Fleet allows you to update the settings of the agent installed on all your hosts at once. In Fleet, these settings are called "agent options."

The default agent options are good to start.

How to update agent options:

  1. In the top navigation, select your avatar and select Settings. Only users with the admin role can access the pages in Settings.

  2. On the Organization settings page, select Agent options on the left side of the page.

  3. To see all agent options, head to the agent options documentation.

  4. Place your new setting one level below the options key. The new setting's key should be below and one tab to the right of options.

  5. Select Save.

The agents may take several seconds to update because Fleet has to wait for the hosts to check in.