MyNixOS website logo
option

services.metricbeat.modules

Metricbeat modules are responsible for reading metrics from the various sources.

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

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

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

Declarations
Type
attribute set of (YAML value)
Default
{ }
Example
{
  system = {
    core = {
      metrics = [
        "percentages"
      ];
    };
    cpu = {
      metrics = [
        "percentages"
        "normalized_percentages"
      ];
    };
    enabled = true;
    metricsets = [
      "cpu"
      "load"
      "memory"
      "network"
      "process"
      "process_summary"
      "uptime"
      "socket_summary"
    ];
    period = "10s";
    processes = [
      ".*"
    ];
  };
}