Metricbeat
services.metricbeat.enable
Whether to enable metricbeat.
Type: boolean
Default
false
Example
true
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/metricbeat.nix
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.
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 = [".*"];};}
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/metricbeat.nix
services.metricbeat.modules.<name>.module
The name of the module.
Look for the value after module: on the individual
module pages linked from https://www.elastic.co/guide/en/beats/metricbeat/current/metricbeat-modules.html.
Type: string
Default
"‹name›"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/metricbeat.nix
services.metricbeat.package
The metricbeat package to use.
Type: package
Default
pkgs.metricbeat
Example
metricbeat7
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/metricbeat.nix
services.metricbeat.settings
Configuration for metricbeat. See https://www.elastic.co/guide/en/beats/metricbeat/current/configuring-howto-metricbeat.html for supported values.
Type: YAML value
Default
{ }
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/metricbeat.nix
services.metricbeat.settings.name
Name of the beat. Defaults to the hostname. See https://www.elastic.co/guide/en/beats/metricbeat/current/configuration-general-options.html#_name.
Type: string
Default
""
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/metricbeat.nix
services.metricbeat.settings.tags
Tags to place on the shipped metrics. See https://www.elastic.co/guide/en/beats/metricbeat/current/configuration-general-options.html#_tags_2.
Type: list of string
Default
[ ]
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/metricbeat.nix