NATS moduleedit

This is the NATS module.

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 an Elasticsearch ingest pipeline to parse and process the log lines, shaping the data into a structure suitable for visualizing in Kibana

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

Compatibilityedit

The nats module was tested with logs from version v1.4.0.

Configure the moduleedit

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

Variable settingsedit

Each fileset has separate variable settings for configuring the behavior of the module. If you don’t specify variable settings, the nats 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, nats.log.var.paths instead of log.var.paths.

log log fileset settingsedit

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.

Dashboardedit

The nats module comes with a predefined dashboard. For example:

filebeat nats dashboard

Fieldsedit

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

edit_url!: