This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
« Add Osquery Response Actions Run Osquery from alerts »
Elastic Docs ›Elastic Security Solution [8.x] ›Investigation tools ›Osquery

Run Osquery from investigation guides

edit

Run Osquery from investigation guides

edit

Detection rule investigation guides suggest steps for triaging, analyzing, and responding to potential security issues. When you build a custom rule, you can also set up an investigation guide that incorporates Osquery. This allows you to run live queries from a rule’s investigation guide as you analyze alerts produced by the rule.

Requirements

Shows a live query in an investigation guide

Add live queries to an investigation guide

edit

You can only add Osquery to investigation guides for custom rules because prebuilt rules cannot be edited.

  1. Go to the Rules page. To access it, find Detection rules (SIEM) in the main menu or by using the global search field.
  2. Select a rule to open the its details, then click Edit rule settings.
  3. Select the About tab, then expand the rule’s advanced settings.

  4. Scroll down to the Investigation guide section. In the toolbar, click the Osquery button (Click the Osquery button).

    1. Add a descriptive label for the query; for example, Search for executables.

    2. Select a saved query or enter a new one.

      Use placeholder fields to dynamically add existing alert data to your query.

    3. Expand the Advanced section to set a timeout period for the query, and view or set mapped ECS fields included in the results from the live query (optional).

      Overwriting the query’s default timeout period allows you to support queries that take longer to run. The default and minimum supported value for the Timeout field is 60. The maximum supported value is 900.

      setup osquery investigation guide
  5. Click Save changes to add the query to the rule’s investigation guide.

Run live queries from an investigation guide

edit
  1. Go to the Rules page. To access it, find Detection rules (SIEM) in the main menu or by using the global search field.
  2. Select a rule to open the its details.
  3. Go to Rules → Detection rules (SIEM), then select a rule to open its details.
  4. Go to the About section of the rule details page and click Investigation guide.

  5. Click the query. The Run Osquery pane displays with the Query field autofilled. Do the following:

    1. Select one or more Elastic Agents or groups to query. Start typing in the search field to get suggestions for Elastic Agents by name, ID, platform, and policy.

    2. Expand the Advanced section to set a timeout period for the query, and view or set mapped ECS fields included in the results from the live query (optional).

      Overwriting the query’s default timeout period allows you to support queries that take longer to run. The default and minimum supported value for the Timeout field is 60. The maximum supported value is 900.

  6. Click Submit to run the query. Query results display in the flyout.

    Refer to Examine Osquery results for more information about query results.

  7. Click Save for later to save the query for future use (optional).

    run query investigation guide
« Add Osquery Response Actions Run Osquery from alerts »