movefasta/nixpkgs
0
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-07-13 21:50:33 +03:00
Code Activity

Merge pull request #59828 from basvandijk/prometheus-refactoring

Browse source 
nixos/prometheus: refactored & added more missing options
This commit is contained in:
Bas van Dijk 2019-04-18 13:43:53 +02:00 • committed by GitHub
commit cccc7a93d2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 293 additions and 373 deletions
Download patch file Download diff file Expand all files Collapse all files

666
nixos/modules/services/monitoring/prometheus/default.nix
View file

@ -22,9 +22,6 @@ let
workingDir = stateDirBase + stateDir; workingDir = stateDirBase + stateDir;
workingDir2 = stateDirBase + cfg2.stateDir; workingDir2 = stateDirBase + cfg2.stateDir;
# Get a submodule without any embedded metadata:
_filter = x: filterAttrs (k: v: k != "_module") x;
# a wrapper that verifies that the configuration is valid # a wrapper that verifies that the configuration is valid
promtoolCheck = what: name: file: pkgs.runCommand "${name}-${what}-checked" promtoolCheck = what: name: file: pkgs.runCommand "${name}-${what}-checked"
{ buildInputs = [ cfg.package ]; } '' { buildInputs = [ cfg.package ]; } ''
@ -50,11 +47,11 @@ let
# This becomes the main config file for Prometheus 1 # This becomes the main config file for Prometheus 1
promConfig = { promConfig = {
global = cfg.globalConfig; global = filterValidPrometheus cfg.globalConfig;
rule_files = map (promtoolCheck "check-rules" "rules") (cfg.ruleFiles ++ [ rule_files = map (promtoolCheck "check-rules" "rules") (cfg.ruleFiles ++ [
(pkgs.writeText "prometheus.rules" (concatStringsSep "\n" cfg.rules)) (pkgs.writeText "prometheus.rules" (concatStringsSep "\n" cfg.rules))
]); ]);
scrape_configs = filterEmpty cfg.scrapeConfigs; scrape_configs = filterValidPrometheus cfg.scrapeConfigs;
}; };
generatedPrometheusYml = writePrettyJSON "prometheus.yml" promConfig; generatedPrometheusYml = writePrettyJSON "prometheus.yml" promConfig;
@ -77,11 +74,11 @@ let
# This becomes the main config file for Prometheus 2 # This becomes the main config file for Prometheus 2
promConfig2 = { promConfig2 = {
global = cfg2.globalConfig; global = filterValidPrometheus cfg2.globalConfig;
rule_files = map (prom2toolCheck "check rules" "rules") (cfg2.ruleFiles ++ [ rule_files = map (prom2toolCheck "check rules" "rules") (cfg2.ruleFiles ++ [
(pkgs.writeText "prometheus.rules" (concatStringsSep "\n" cfg2.rules)) (pkgs.writeText "prometheus.rules" (concatStringsSep "\n" cfg2.rules))
]); ]);
scrape_configs = filterEmpty cfg2.scrapeConfigs; scrape_configs = filterValidPrometheus cfg2.scrapeConfigs;
alerting = optionalAttrs (cfg2.alertmanagerURL != []) { alerting = optionalAttrs (cfg2.alertmanagerURL != []) {
alertmanagers = [{ alertmanagers = [{
static_configs = [{ static_configs = [{
@ -108,7 +105,7 @@ let
] ++ ] ++
optional (cfg2.webExternalUrl != null) "--web.external-url=${cfg2.webExternalUrl}"; optional (cfg2.webExternalUrl != null) "--web.external-url=${cfg2.webExternalUrl}";
filterEmpty = filterAttrsListRecursive (_n: v: !(v == null || v == [] || v == {})); filterValidPrometheus = filterAttrsListRecursive (n: v: !(n == "_module" || v == null));
filterAttrsListRecursive = pred: x: filterAttrsListRecursive = pred: x:
if isAttrs x then if isAttrs x then
listToAttrs ( listToAttrs (
@ -123,41 +120,37 @@ let
map (filterAttrsListRecursive pred) x map (filterAttrsListRecursive pred) x
else x; else x;
mkDefOpt = type : defaultStr : description : mkOpt type (description + ''
Defaults to <literal>${defaultStr}</literal> in prometheus
when set to <literal>null</literal>.
'');
mkOpt = type : description : mkOption {
type = types.nullOr type;
default = null;
inherit description;
};
promTypes.globalConfig = types.submodule { promTypes.globalConfig = types.submodule {
options = { options = {
scrape_interval = mkOption { scrape_interval = mkDefOpt types.str "1m" ''
type = types.str; How frequently to scrape targets by default.
default = "1m"; '';
description = ''
How frequently to scrape targets by default.
'';
};
scrape_timeout = mkOption { scrape_timeout = mkDefOpt types.str "10s" ''
type = types.str; How long until a scrape request times out.
default = "10s"; '';
description = ''
How long until a scrape request times out.
'';
};
evaluation_interval = mkOption { evaluation_interval = mkDefOpt types.str "1m" ''
type = types.str; How frequently to evaluate rules by default.
default = "1m"; '';
description = ''
How frequently to evaluate rules by default.
'';
};
external_labels = mkOption { external_labels = mkOpt (types.attrsOf types.str) ''
type = types.attrsOf types.str; The labels to add to any time series or alerts when
description = '' communicating with external systems (federation, remote
The labels to add to any time series or alerts when storage, Alertmanager).
communicating with external systems (federation, remote '';
storage, Alertmanager).
'';
default = {};
};
}; };
}; };
@ -169,145 +162,127 @@ let
The job name assigned to scraped metrics by default. The job name assigned to scraped metrics by default.
''; '';
}; };
scrape_interval = mkOption { scrape_interval = mkOpt types.str ''
type = types.nullOr types.str; How frequently to scrape targets from this job. Defaults to the
default = null; globally configured default.
description = '' '';
How frequently to scrape targets from this job. Defaults to the
globally configured default.
'';
};
scrape_timeout = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
Per-target timeout when scraping this job. Defaults to the
globally configured default.
'';
};
metrics_path = mkOption {
type = types.str;
default = "/metrics";
description = ''
The HTTP resource path on which to fetch metrics from targets.
'';
};
honor_labels = mkOption {
type = types.bool;
default = false;
description = ''
Controls how Prometheus handles conflicts between labels
that are already present in scraped data and labels that
Prometheus would attach server-side ("job" and "instance"
labels, manually configured target labels, and labels
generated by service discovery implementations).
If honor_labels is set to "true", label conflicts are scrape_timeout = mkOpt types.str ''
resolved by keeping label values from the scraped data and Per-target timeout when scraping this job. Defaults to the
ignoring the conflicting server-side labels. globally configured default.
'';
If honor_labels is set to "false", label conflicts are metrics_path = mkDefOpt types.str "/metrics" ''
resolved by renaming conflicting labels in the scraped data The HTTP resource path on which to fetch metrics from targets.
to "exported_&lt;original-label&gt;" (for example '';
"exported_instance", "exported_job") and then attaching
server-side labels. This is useful for use cases such as honor_labels = mkDefOpt types.bool "false" ''
federation, where all labels specified in the target should Controls how Prometheus handles conflicts between labels
be preserved. that are already present in scraped data and labels that
''; Prometheus would attach server-side ("job" and "instance"
}; labels, manually configured target labels, and labels
scheme = mkOption { generated by service discovery implementations).
type = types.enum ["http" "https"];
default = "http"; If honor_labels is set to "true", label conflicts are
description = '' resolved by keeping label values from the scraped data and
The URL scheme with which to fetch metrics from targets. ignoring the conflicting server-side labels.
'';
}; If honor_labels is set to "false", label conflicts are
params = mkOption { resolved by renaming conflicting labels in the scraped data
type = types.attrsOf (types.listOf types.str); to "exported_&lt;original-label&gt;" (for example
default = {}; "exported_instance", "exported_job") and then attaching
description = '' server-side labels. This is useful for use cases such as
Optional HTTP URL parameters. federation, where all labels specified in the target should
''; be preserved.
}; '';
basic_auth = mkOption {
type = types.nullOr (types.submodule { honor_timestamps = mkDefOpt types.bool "true" ''
options = { honor_timestamps controls whether Prometheus respects the timestamps present
username = mkOption { in scraped data.
type = types.str;
description = '' If honor_timestamps is set to <literal>true</literal>, the timestamps of the metrics exposed
HTTP username by the target will be used.
'';
}; If honor_timestamps is set to <literal>false</literal>, the timestamps of the metrics exposed
password = mkOption { by the target will be ignored.
type = types.str; '';
description = ''
HTTP password scheme = mkDefOpt (types.enum ["http" "https"]) "http" ''
''; The URL scheme with which to fetch metrics from targets.
}; '';
params = mkOpt (types.attrsOf (types.listOf types.str)) ''
Optional HTTP URL parameters.
'';
basic_auth = mkOpt (types.submodule {
options = {
username = mkOption {
type = types.str;
description = ''
HTTP username
'';
}; };
}); password = mkOption {
default = null; type = types.str;
apply = x: mapNullable _filter x; description = ''
description = '' HTTP password
Optional http login credentials for metrics scraping. '';
''; };
}; };
tls_config = mkOption { }) ''
type = types.nullOr promTypes.tls_config; Optional http login credentials for metrics scraping.
default = null; '';
apply = x: mapNullable _filter x;
description = '' bearer_token = mkOpt types.str ''
Configures the scrape request's TLS settings. Sets the `Authorization` header on every scrape request with
''; the configured bearer token. It is mutually exclusive with
}; <option>bearer_token_file</option>.
dns_sd_configs = mkOption { '';
type = types.listOf promTypes.dns_sd_config;
default = []; bearer_token_file = mkOpt types.str ''
apply = x: map _filter x; Sets the `Authorization` header on every scrape request with
description = '' the bearer token read from the configured file. It is mutually
List of DNS service discovery configurations. exclusive with <option>bearer_token</option>.
''; '';
};
consul_sd_configs = mkOption { tls_config = mkOpt promTypes.tls_config ''
type = types.listOf promTypes.consul_sd_config; Configures the scrape request's TLS settings.
default = []; '';
apply = x: map _filter x;
description = '' proxy_url = mkOpt types.str ''
List of Consul service discovery configurations. Optional proxy URL.
''; '';
};
file_sd_configs = mkOption { ec2_sd_configs = mkOpt (types.listOf promTypes.ec2_sd_config) ''
type = types.listOf promTypes.file_sd_config; List of EC2 service discovery configurations.
default = []; '';
apply = x: map _filter x;
description = '' dns_sd_configs = mkOpt (types.listOf promTypes.dns_sd_config) ''
List of file service discovery configurations. List of DNS service discovery configurations.
''; '';
};
static_configs = mkOption { consul_sd_configs = mkOpt (types.listOf promTypes.consul_sd_config) ''
type = types.listOf promTypes.static_config; List of Consul service discovery configurations.
default = []; '';
apply = x: map _filter x;
description = '' file_sd_configs = mkOpt (types.listOf promTypes.file_sd_config) ''
List of labeled target groups for this job. List of file service discovery configurations.
''; '';
};
ec2_sd_configs = mkOption { static_configs = mkOpt (types.listOf promTypes.static_config) ''
type = types.listOf promTypes.ec2_sd_config; List of labeled target groups for this job.
default = []; '';
apply = x: map _filter x;
description = '' relabel_configs = mkOpt (types.listOf promTypes.relabel_config) ''
List of EC2 service discovery configurations. List of relabel configurations.
''; '';
};
relabel_configs = mkOption { sample_limit = mkDefOpt types.int "0" ''
type = types.listOf promTypes.relabel_config; Per-scrape limit on number of scraped samples that will be accepted.
default = []; If more than this number of samples are present after metric relabelling
apply = x: map _filter x; the entire scrape will be treated as failed. 0 means no limit.
description = '' '';
List of relabel configurations.
'';
};
}; };
}; };
@ -337,66 +312,41 @@ let
The AWS Region. The AWS Region.
''; '';
}; };
endpoint = mkOption { endpoint = mkOpt types.str ''
type = types.nullOr types.str; Custom endpoint to be used.
default = null; '';
description = ''
Custom endpoint to be used. access_key = mkOpt types.str ''
''; The AWS API key id. If blank, the environment variable
}; <literal>AWS_ACCESS_KEY_ID</literal> is used.
access_key = mkOption { '';
type = types.nullOr types.str;
default = null; secret_key = mkOpt types.str ''
description = '' The AWS API key secret. If blank, the environment variable
The AWS API key id. If blank, the environment variable <literal>AWS_SECRET_ACCESS_KEY</literal> is used.
<literal>AWS_ACCESS_KEY_ID</literal> is used. '';
'';
}; profile = mkOpt types.str ''
secret_key = mkOption { Named AWS profile used to connect to the API.
type = types.nullOr types.str; '';
default = null;
description = '' role_arn = mkOpt types.str ''
The AWS API key secret. If blank, the environment variable AWS Role ARN, an alternative to using AWS API keys.
<literal>AWS_SECRET_ACCESS_KEY</literal> is used. '';
'';
}; refresh_interval = mkDefOpt types.str "60s" ''
profile = mkOption { Refresh interval to re-read the instance list.
type = types.nullOr types.str; '';
default = null;
description = '' port = mkDefOpt types.int "80" ''
Named AWS profile used to connect to the API. The port to scrape metrics from. If using the public IP
''; address, this must instead be specified in the relabeling
}; rule.
role_arn = mkOption { '';
type = types.nullOr types.str;
default = null; filters = mkOpt (types.listOf promTypes.filter) ''
description = '' Filters can be used optionally to filter the instance list by other criteria.
AWS Role ARN, an alternative to using AWS API keys. '';
'';
};
refresh_interval = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
Refresh interval to re-read the instance list.
'';
};
port = mkOption {
type = types.int;
default = 80;
description = ''
The port to scrape metrics from. If using the public IP
address, this must instead be specified in the relabeling
rule.
'';
};
filters = mkOption {
type = types.nullOr (types.listOf promTypes.filter);
default = null;
description = ''
Filters can be used optionally to filter the instance list by other criteria.
'';
};
}; };
}; };
@ -409,6 +359,7 @@ let
for the available filters. for the available filters.
''; '';
}; };
value = mkOption { value = mkOption {
type = types.listOf types.str; type = types.listOf types.str;
default = []; default = [];
@ -427,56 +378,63 @@ let
A list of DNS SRV record names to be queried. A list of DNS SRV record names to be queried.
''; '';
}; };
refresh_interval = mkOption {
type = types.str; refresh_interval = mkDefOpt types.str "30s" ''
default = "30s"; The time after which the provided names are refreshed.
description = '' '';
The time after which the provided names are refreshed.
'';
};
}; };
}; };
promTypes.consul_sd_config = types.submodule { promTypes.consul_sd_config = types.submodule {
options = { options = {
server = mkOption { server = mkDefOpt types.str "localhost:8500" ''
type = types.str; Consul server to query.
description = "Consul server to query."; '';
};
token = mkOption {
type = types.nullOr types.str;
description = "Consul token";
};
datacenter = mkOption {
type = types.nullOr types.str;
description = "Consul datacenter";
};
scheme = mkOption {
type = types.nullOr types.str;
description = "Consul scheme";
};
username = mkOption {
type = types.nullOr types.str;
description = "Consul username";
};
password = mkOption {
type = types.nullOr types.str;
description = "Consul password";
};
services = mkOption { token = mkOpt types.str "Consul token";
type = types.listOf types.str;
description = '' datacenter = mkOpt types.str "Consul datacenter";
A list of services for which targets are retrieved.
''; scheme = mkDefOpt types.str "http" "Consul scheme";
};
tag_separator = mkOption { username = mkOpt types.str "Consul username";
type = types.str;
default = ","; password = mkOpt types.str "Consul password";
description = ''
The string by which Consul tags are joined into the tag label. tls_config = mkOpt promTypes.tls_config ''
''; Configures the Consul request's TLS settings.
}; '';
services = mkOpt (types.listOf types.str) ''
A list of services for which targets are retrieved.
'';
tags = mkOpt (types.listOf types.str) ''
An optional list of tags used to filter nodes for a given
service. Services must contain all tags in the list.
'';
node_meta = mkOpt (types.attrsOf types.str) ''
Node metadata used to filter nodes for a given service.
'';
tag_separator = mkDefOpt types.str "," ''
The string by which Consul tags are joined into the tag label.
'';
allow_stale = mkOpt types.bool ''
Allow stale Consul results
(see <link xlink:href="https://www.consul.io/api/index.html#consistency-modes"/>).
Will reduce load on Consul.
'';
refresh_interval = mkDefOpt types.str "30s" ''
The time after which the provided names are refreshed.
On large setup it might be a good idea to increase this value
because the catalog will change all the time.
'';
}; };
}; };
@ -488,108 +446,74 @@ let
Patterns for files from which target groups are extracted. Refer Patterns for files from which target groups are extracted. Refer
to the Prometheus documentation for permitted filename patterns to the Prometheus documentation for permitted filename patterns
and formats. and formats.
'';
};
''; refresh_interval = mkDefOpt types.str "5m" ''
}; Refresh interval to re-read the files.
refresh_interval = mkOption { '';
type = types.str;
default = "30s";
description = ''
Refresh interval to re-read the files.
'';
};
}; };
}; };
promTypes.relabel_config = types.submodule { promTypes.relabel_config = types.submodule {
options = { options = {
source_labels = mkOption { source_labels = mkOpt (types.listOf types.str) ''
type = with types; nullOr (listOf str); The source labels select values from existing labels. Their content
default = null; is concatenated using the configured separator and matched against
description = '' the configured regular expression.
The source labels select values from existing labels. Their content '';
is concatenated using the configured separator and matched against
the configured regular expression. separator = mkDefOpt types.str ";" ''
''; Separator placed between concatenated source label values.
}; '';
separator = mkOption {
type = types.str; target_label = mkOpt types.str ''
default = ";"; Label to which the resulting value is written in a replace action.
description = '' It is mandatory for replace actions.
Separator placed between concatenated source label values. '';
'';
}; regex = mkDefOpt types.str "(.*)" ''
target_label = mkOption { Regular expression against which the extracted value is matched.
type = types.nullOr types.str; '';
default = null;
description = '' modulus = mkOpt types.int ''
Label to which the resulting value is written in a replace action. Modulus to take of the hash of the source label values.
It is mandatory for replace actions. '';
'';
}; replacement = mkDefOpt types.str "$1" ''
regex = mkOption { Replacement value against which a regex replace is performed if the
type = types.str; regular expression matches.
default = "(.*)"; '';
description = ''
Regular expression against which the extracted value is matched. action = mkDefOpt (types.enum ["replace" "keep" "drop"]) "replace" ''
''; Action to perform based on regex matching.
}; '';
replacement = mkOption {
type = types.str;
default = "$1";
description = ''
Replacement value against which a regex replace is performed if the
regular expression matches.
'';
};
action = mkOption {
type = types.enum ["replace" "keep" "drop"];
default = "replace";
description = ''
Action to perform based on regex matching.
'';
};
}; };
}; };
promTypes.tls_config = types.submodule { promTypes.tls_config = types.submodule {
options = { options = {
ca_file = mkOption { ca_file = mkOpt types.str ''
type = types.nullOr types.str; CA certificate to validate API server certificate with.
default = null; '';
description = ''
CA certificate to validate API server certificate with. cert_file = mkOpt types.str ''
''; Certificate file for client cert authentication to the server.
}; '';
cert_file = mkOption {
type = types.nullOr types.str; key_file = mkOpt types.str ''
default = null; Key file for client cert authentication to the server.
description = '' '';
Certificate file for client cert authentication to the server.
''; server_name = mkOpt types.str ''
}; ServerName extension to indicate the name of the server.
key_file = mkOption { http://tools.ietf.org/html/rfc4366#section-3.1
type = types.nullOr types.str; '';
default = null;
description = '' insecure_skip_verify = mkOpt types.bool ''
Key file for client cert authentication to the server. Disable validation of the server certificate.
''; '';
};
server_name = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
ServerName extension to indicate the name of the server.
http://tools.ietf.org/html/rfc4366#section-3.1
'';
};
insecure_skip_verify = mkOption {
type = types.bool;
default = false;
description = ''
Disable validation of the server certificate.
'';
};
}; };
}; };
@ -662,7 +586,6 @@ in {
globalConfig = mkOption { globalConfig = mkOption {
type = promTypes.globalConfig; type = promTypes.globalConfig;
default = {}; default = {};
apply = _filter;
description = '' description = ''
Parameters that are valid in all configuration contexts. They Parameters that are valid in all configuration contexts. They
also serve as defaults for other configuration sections also serve as defaults for other configuration sections
@ -688,7 +611,6 @@ in {
scrapeConfigs = mkOption { scrapeConfigs = mkOption {
type = types.listOf promTypes.scrape_config; type = types.listOf promTypes.scrape_config;
default = []; default = [];
apply = x: map _filter x;
description = '' description = ''
A list of scrape configurations. A list of scrape configurations.
''; '';
@ -786,7 +708,6 @@ in {
globalConfig = mkOption { globalConfig = mkOption {
type = promTypes.globalConfig; type = promTypes.globalConfig;
default = {}; default = {};
apply = _filter;
description = '' description = ''
Parameters that are valid in all configuration contexts. They Parameters that are valid in all configuration contexts. They
also serve as defaults for other configuration sections also serve as defaults for other configuration sections
@ -812,7 +733,6 @@ in {
scrapeConfigs = mkOption { scrapeConfigs = mkOption {
type = types.listOf promTypes.scrape_config; type = types.listOf promTypes.scrape_config;
default = []; default = [];
apply = x: map _filter x;
description = '' description = ''
A list of scrape configurations. A list of scrape configurations.
''; '';