services.filebeat.modules ‐ NixOS ‐ Searchix

services.filebeat.modules

Filebeat modules provide a quick way to get started processing common log formats. They contain default configurations, Elasticsearch ingest pipeline definitions, and Kibana dashboards to help you implement and deploy a log monitoring solution.

This is like services.filebeat.settings.filebeat.modules, but structured as an attribute set. This has the benefit that multiple NixOS modules can contribute settings to a single filebeat module.

A module can be specified multiple times by choosing a different <name> for each, but setting services.filebeat.modules._name_.module to the same value.

See https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-modules.html.

Type

attribute set of (open submodule of (JSON value))

Default

{ }

Example

{
  nginx = {
    access = {
      enabled = true;
      var.paths = [ "/path/to/log/nginx/access.log*" ];
    };
    error = {
      enabled = true;
      var.paths = [ "/path/to/log/nginx/error.log*" ];
    };
  };
};

Declared