IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Okta module Palo Alto Networks module »
Elastic Docs ›Filebeat Reference [7.10] ›Modules

Osquery module

edit

Osquery module

edit

The osquery module collects and decodes the result logs written by osqueryd in the JSON format. To set up osqueryd follow the osquery installation instructions for your operating system and configure the filesystem logging driver (the default). Make sure UTC timestamps are enabled.

When you run the module, it performs a few tasks under the hood:

  • Sets the default paths to the log files (but don’t worry, you can override the defaults)
  • Makes sure each multiline log event gets sent as a single event
  • Uses ingest node to parse and process the log lines, shaping the data into a structure suitable for visualizing in Kibana
  • Deploys dashboards for visualizing the log data

Read the quick start to learn how to configure and run modules.

Compatibility

edit

The osquery module was tested with logs from osquery version 2.10.2. Since the results are written in the JSON format, it is likely that this module works with any version of osquery.

This module is available on Linux, macOS, and Windows.

Configure the module

edit

You can further refine the behavior of the osquery module by specifying variable settings in the modules.d/osquery.yml file, or overriding settings at the command line.

The following example shows how to set paths in the modules.d/osquery.yml file to override the default paths for the syslog and authorization logs:

- module: osquery
  result:
    enabled: true
    var.paths: ["/path/to/osqueryd.results.log*"]

To specify the same settings at the command line, you use:

-M "osquery.result.var.paths=[/path/to/osqueryd.results.log*]"

Variable settings

edit

Each fileset has separate variable settings for configuring the behavior of the module. If you don’t specify variable settings, the osquery module uses the defaults.

For advanced use cases, you can also override input settings. See Override input settings.

When you specify a setting at the command line, remember to prefix the setting with the module name, for example, osquery.result.var.paths instead of result.var.paths.

result fileset settings

edit
var.paths
An array of glob-based paths that specify where to look for the log files. All patterns supported by Go Glob are also supported here. For example, you can use wildcards to fetch all files from a predefined level of subdirectories: /path/to/log/*/*.log. This fetches all .log files from the subfolders of /path/to/log. It does not fetch log files from the /path/to/log folder itself. If this setting is left empty, Filebeat will choose log paths based on your operating system.
var.use_namespace
If true, all fields exported by this module are prefixed with osquery.result. Set to false to copy the fields in the root of the document. If enabled, this setting also disables the renaming of some fields (e.g. hostIdentifier to host_identifier). Note that if you set this to false, the sample dashboards coming with this module won’t work correctly. The default is true.

Example dashboard

edit

This module comes with a sample dashboard for visualizing the data collected by the "compliance" pack. To collect this data, enable the id-compliance pack in the osquery configuration file.

kibana osquery compatibility

Fields

edit

For a description of each field in the module, see the exported fields section.

« Okta module Palo Alto Networks module »