Prometheus

`services.prometheus.alertmanager.checkConfig`

Check configuration with amtool check-config. The call to amtool is subject to sandboxing by Nix.

Whether to enable Prometheus Alertmanager. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/alertmanager.nix

`services.prometheus.alertmanager.environmentFile`

File to load as environment file. Environment variables from this file will be interpolated into the config file using envsubst with this syntax: $ENVIRONMENT ${VARIABLE}

Type: null or path

pkgs.alertmanager-irc-relay

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/alertmanager-irc-relay.nix

`services.prometheus.alertmanagerIrcRelay.settings`

Configuration for Alertmanager IRC Relay as a Nix attribute set. For a reference, check out the example configuration and the source code.

Note: The webhook's URL MUST point to the IRC channel where the message should be posted. For #mychannel from the example, this would be http://localhost:8080/mychannel.

Type: YAML value

Example

`#!nix { http_host = "localhost"; http_port = 8000;

irc_host = "irc.example.com"; irc_port = 7000; irc_nickname = "myalertbot";

irc_channels = [ { name = "#mychannel"; } ]; } `

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/alertmanager-irc-relay.nix

`services.prometheus.alertmanagerNotificationQueueCapacity`

The capacity of the queue for pending alert manager notifications.

Type: signed integer

Default

10000

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

pkgs.alertmanager-webhook-logger

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/alertmanager-webhook-logger.nix

`services.prometheus.alertmanagers`

A list of alertmanagers to send alerts to. See the official documentation for more information.

Type: list of (attribute set)

Default

[ ]

Example

[ {scheme = "https";path_prefix = "/alertmanager";static_configs = [ {targets = ["prometheus.domain.tld"];} ];} ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.checkConfig`

Check configuration with promtool check. The call to promtool is subject to sandboxing by Nix.

If you use credentials stored in external files (password_file, bearer_token_file, etc), they will not be visible to promtool and it will report errors, despite a correct configuration. To resolve this, you may set this option to "syntax-only" in order to only syntax check the Prometheus configuration.

Type: boolean or value "syntax-only" (singular enum)

Default

true

Example

"syntax-only"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.configText`

Whether to enable the prometheus apcupsd exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.apcupsd.extraFlags`

Extra commandline options to pass to the apcupsd exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.apcupsd.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.apcupsd.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9162"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.apcupsd.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.apcupsd.openFirewall is true.

Type: null or strings concatenated with "\n"

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.artifactory.artiUsername`

Username for authentication against JFrog Artifactory API.

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.artifactory.enable`

Whether to enable the prometheus artifactory exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.artifactory.extraFlags`

Extra commandline options to pass to the artifactory exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.artifactory.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.artifactory.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9531"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.artifactory.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.artifactory.openFirewall is true.

Type: null or strings concatenated with "\n"

"auto"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.bind.enable`

Whether to enable the prometheus bind exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.bind.extraFlags`

Extra commandline options to pass to the bind exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.bind.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.bind.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9119"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.bind.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.bind.openFirewall is true.

Type: null or strings concatenated with "\n"

Whether to enable the prometheus bird exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.bird.extraFlags`

Extra commandline options to pass to the bird exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.bird.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.bird.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9324"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.bird.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.bird.openFirewall is true.

Type: null or strings concatenated with "\n"

Whether to enable the prometheus bitcoin exporter. Type: boolean

Specify a filter for iptables to use when {option}services.prometheus.exporters.bitcoin.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9332"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.bitcoin.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.bitcoin.openFirewall is true.

Type: null or strings concatenated with "\n"

Path to configuration file.

Type: path

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.blackbox.enable`

Whether to enable the prometheus blackbox exporter. Type: boolean

Specify a filter for iptables to use when {option}services.prometheus.exporters.blackbox.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9115"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.blackbox.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.blackbox.openFirewall is true.

Type: null or strings concatenated with "\n"

Whether to enable the prometheus borgmatic exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.borgmatic.extraFlags`

Extra commandline options to pass to the borgmatic exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.borgmatic.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.borgmatic.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9996"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.borgmatic.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.borgmatic.openFirewall is true.

Type: null or strings concatenated with "\n"

Whether to enable the prometheus buildkite-agent exporter. Type: boolean

Specify a filter for iptables to use when {option}services.prometheus.exporters.buildkite-agent.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9876"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.buildkite-agent.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.buildkite-agent.openFirewall is true.

Type: null or strings concatenated with "\n"

Default

null

Example

iifname "eth0" tcp dport 9876 counter accept

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.buildkite-agent.group`

Group under which the buildkite-agent exporter shall be run.

Type: string

Default

"buildkite-agent-exporter"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.buildkite-agent.interval`

How often to update metrics.

Type: string

Whether to enable collectd binary protocol receiver. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.collectd.collectdBinary.listenAddress`

Address to listen on for binary network packets.

Type: string

Default

"0.0.0.0"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.collectd.collectdBinary.port`

Network address on which to accept collectd binary network packets. Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

25826

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.collectd.collectdBinary.securityLevel`

Minimum required security level for accepted packets.

Type: one of "None", "Sign", "Encrypt"

Default

"None"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.collectd.enable`

Whether to enable the prometheus collectd exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.collectd.extraFlags`

Extra commandline options to pass to the collectd exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.collectd.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.collectd.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9103"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.collectd.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.collectd.openFirewall is true.

Type: null or strings concatenated with "\n"

Set the log format.

Type: one of "logfmt", "json"

Password to connect to deluge server.

Whether to enable the prometheus deluge exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.deluge.exportPerTorrentMetrics`

Enable per-torrent metrics.

This may significantly increase the number of time series depending on the number of torrents in your Deluge instance.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.deluge.extraFlags`

Extra commandline options to pass to the deluge exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.deluge.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.deluge.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9354"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.deluge.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.deluge.openFirewall is true.

Type: null or strings concatenated with "\n"

Whether to enable the prometheus dmarc exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.dmarc.extraFlags`

Extra commandline options to pass to the dmarc exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.dmarc.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.dmarc.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9797"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.dmarc.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.dmarc.openFirewall is true.

Type: null or strings concatenated with "\n"

Whether to enable the prometheus dnsmasq exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.dnsmasq.extraFlags`

Default

"dnsmasq-exporter"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.dnsmasq.leasesPath`

Path to the dnsmasq.leases file.

Type: path

dnssec exporter configuration as nix attribute set.

See https://github.com/chrj/prometheus-dnssec-exporter/blob/master/README.md for the description of the configuration file format.

Type: null or (attribute set)

Default

null

Example

{records = [{zone = "ietf.org";record = "@";type = "SOA";}{zone = "verisigninc.com";record = "@";type = "SOA";}];}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.dnssec.enable`

Whether to enable the prometheus dnssec exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.dnssec.extraFlags`

Default

"dnssec-exporter"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.dnssec.listenAddress`

Listen address as host IP and port definition.

Type: null or string

DNSSEC capable resolver to be used for the check.

Type: list of string

Default

[ ]

Example

["0.0.0.0:53"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.dnssec.timeout`

DNS request timeout duration.

Type: null or string

Default

null

Example

"10s"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.dnssec.user`

User name under which the dnssec exporter shall be run.

Type: string

Default

"dnssec-exporter"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.domain.enable`

Whether to enable the prometheus domain exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.domain.extraFlags`

Extra commandline options to pass to the domain exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.domain.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.domain.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9222"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.domain.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.domain.openFirewall is true.

Type: null or strings concatenated with "\n"

Whether to enable the prometheus dovecot exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.dovecot.extraFlags`

Extra commandline options to pass to the dovecot exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.dovecot.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.dovecot.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9166"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.dovecot.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.dovecot.openFirewall is true.

Type: null or strings concatenated with "\n"

Stats scopes to query.

Type: list of string

Default

["user"]

Example

["user""global"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.dovecot.socketPath`

Path under which the stats socket is placed. The user/group under which the exporter runs, should be able to access the socket in order to scrape the metrics successfully.

Please keep in mind that the stats module has changed in Dovecot 2.3+ which is not compatible with this exporter.

The following extra config has to be passed to Dovecot to ensure that recent versions work with this exporter:

{
  services.prometheus.exporters.dovecot.enable = true;
  services.prometheus.exporters.dovecot.socketPath = "/var/run/dovecot2/old-stats";
  services.dovecot2.mailPlugins.globally.enable = [ "old_stats" ];
  services.dovecot2.extraConfig = ''
    service old-stats {
      unix_listener old-stats {
        user = dovecot-exporter
        group = dovecot-exporter
        mode = 0660
      }
      fifo_listener old-stats-mail {
        mode = 0660
        user = dovecot
        group = dovecot
      }
      fifo_listener old-stats-user {
        mode = 0660
        user = dovecot
        group = dovecot
      }
    }
    plugin {
      old_stats_refresh = 30 secs
      old_stats_track_cmds = yes
    }
  '';
}

Type: path

Whether to enable the prometheus exportarr-bazarr exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.exportarr-bazarr.environment`

See the configuration guide for available options.

Type: attribute set of string

Default

{ }

Example

{PROWLARR__BACKFILL = true;}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.exportarr-bazarr.extraFlags`

Extra commandline options to pass to the exportarr-bazarr exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.exportarr-bazarr.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.exportarr-bazarr.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9708"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.exportarr-bazarr.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.exportarr-bazarr.openFirewall is true.

Type: null or strings concatenated with "\n"

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.exportarr-lidarr.environment`

See the configuration guide for available options.

Type: attribute set of string

Default

{ }

Example

{PROWLARR__BACKFILL = true;}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.exportarr-lidarr.extraFlags`

Extra commandline options to pass to the exportarr-lidarr exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.exportarr-lidarr.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.exportarr-lidarr.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9708"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.exportarr-lidarr.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.exportarr-lidarr.openFirewall is true.

Type: null or strings concatenated with "\n"

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.exportarr-prowlarr.environment`

See the configuration guide for available options.

Type: attribute set of string

Default

{ }

Example

{PROWLARR__BACKFILL = true;}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.exportarr-prowlarr.extraFlags`

Extra commandline options to pass to the exportarr-prowlarr exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.exportarr-prowlarr.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.exportarr-prowlarr.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9708"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.exportarr-prowlarr.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.exportarr-prowlarr.openFirewall is true.

Type: null or strings concatenated with "\n"

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.exportarr-radarr.environment`

See the configuration guide for available options.

Type: attribute set of string

Default

{ }

Example

{PROWLARR__BACKFILL = true;}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.exportarr-radarr.extraFlags`

Extra commandline options to pass to the exportarr-radarr exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.exportarr-radarr.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.exportarr-radarr.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9708"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.exportarr-radarr.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.exportarr-radarr.openFirewall is true.

Type: null or strings concatenated with "\n"

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.exportarr-readarr.environment`

See the configuration guide for available options.

Type: attribute set of string

Default

{ }

Example

{PROWLARR__BACKFILL = true;}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.exportarr-readarr.extraFlags`

Extra commandline options to pass to the exportarr-readarr exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.exportarr-readarr.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.exportarr-readarr.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9708"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.exportarr-readarr.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.exportarr-readarr.openFirewall is true.

Type: null or strings concatenated with "\n"

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.exportarr-sonarr.environment`

See the configuration guide for available options.

Type: attribute set of string

Default

{ }

Example

{PROWLARR__BACKFILL = true;}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.exportarr-sonarr.extraFlags`

Extra commandline options to pass to the exportarr-sonarr exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.exportarr-sonarr.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.exportarr-sonarr.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9708"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.exportarr-sonarr.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.exportarr-sonarr.openFirewall is true.

Type: null or strings concatenated with "\n"

Type: null or path

Default

null

Example

"./fastly-exporter-config.txt"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.fastly.enable`

Whether to enable the prometheus fastly exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.fastly.extraFlags`

Extra commandline options to pass to the fastly exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.fastly.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.fastly.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9118"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.fastly.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.fastly.openFirewall is true.

Type: null or strings concatenated with "\n"

A run-time path to the token file, which is supposed to be provisioned outside of Nix store.

Type: path

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.fastly.user`

User name under which the fastly exporter shall be run.

Type: string

Default

"fastly-exporter"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.flow.asn`

The ASN being monitored. Type: positive integer, meaning >0

Example

65542

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.flow.brokers`

List of Kafka brokers to connect to. Type: list of string

Example

[ "kafka.example.org:19092" ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.flow.enable`

Whether to enable the prometheus flow exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.flow.extraFlags`

Extra commandline options to pass to the flow exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.flow.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.flow.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9590"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.flow.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.flow.openFirewall is true.

Type: null or strings concatenated with "\n"

The Kafka topic to consume from. Type: string

Example

"pmacct.acct"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.flow.user`

User name under which the flow exporter shall be run.

Type: string

Default

"flow-exporter"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.fritz.enable`

Whether to enable the prometheus fritz exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.fritz.extraFlags`

Extra commandline options to pass to the fritz exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.fritz.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.fritz.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9787"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.fritz.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.fritz.openFirewall is true.

Type: null or strings concatenated with "\n"

Configuration settings for fritz-exporter. Type: YAML value

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

Path to a file which contains the password to authenticate with the target device. Needs to be readable by the user the exporter runs under.

Type: path

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.fritz.settings.devices.*.username`

Username to authenticate with the target device.

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.fritz.settings.log_level`

Log level to use for the exporter.

Type: one of "DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"

Default

"INFO"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.fritz.user`

User name under which the fritz exporter shall be run.

Type: string

Default

"fritz-exporter"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.fritzbox.enable`

Whether to enable the prometheus fritzbox exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.fritzbox.extraFlags`

Extra commandline options to pass to the fritzbox exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.fritzbox.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.fritzbox.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9133"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.fritzbox.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.fritzbox.openFirewall is true.

Type: null or strings concatenated with "\n"

"fritzbox-exporter"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.graphite.enable`

Whether to enable the prometheus graphite exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.graphite.extraFlags`

Extra commandline options to pass to the graphite exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.graphite.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.graphite.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9108"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.graphite.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.graphite.openFirewall is true.

Type: null or strings concatenated with "\n"

Configuration for iDRAC exporter, as a nix attribute set.

Configuration reference: https://github.com/mrlhansen/idrac_exporter/#configuration

Mutually exclusive with configurationPath option.

Type: null or (attribute set)

Default

null

Example

{hosts = {default = {password = "password";username = "username";};};metrics = {memory = true;power = true;sel = true;sensors = true;storage = true;system = true;};retries = 1;timeout = 10;}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.idrac.configurationPath`

Path to the service's config file. This path can either be a computed path in /nix/store or a path in the local filesystem.

The config file should NOT be stored in /nix/store as it will contain passwords and/or keys in plain text.

Mutually exclusive with configuration option.

Configuration reference: https://github.com/mrlhansen/idrac_exporter/#configuration

Type: null or path

Default

null

Example

"/etc/prometheus-idrac-exporter/idrac.yml"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.idrac.enable`

Whether to enable the prometheus idrac exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.idrac.extraFlags`

Extra commandline options to pass to the idrac exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.idrac.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.idrac.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9348"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.idrac.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.idrac.openFirewall is true.

Type: null or strings concatenated with "\n"

File containing the configuration

Type: path

Example

"/path/to/config-file"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.imap-mailstat.enable`

Whether to enable the prometheus imap-mailstat exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.imap-mailstat.extraFlags`

Extra commandline options to pass to the imap-mailstat exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.imap-mailstat.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.imap-mailstat.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 8081"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.imap-mailstat.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.imap-mailstat.openFirewall is true.

Type: null or strings concatenated with "\n"

Whether to enable the prometheus influxdb exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.influxdb.extraFlags`

Extra commandline options to pass to the influxdb exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.influxdb.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.influxdb.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9122"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.influxdb.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.influxdb.openFirewall is true.

Type: null or strings concatenated with "\n"

How long a sample is valid for Type: string

Default

"5m"

Example

"10m"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.influxdb.udpBindAddress`

Address on which to listen for udp packets Type: string

Whether to enable the prometheus ipmi exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.ipmi.extraFlags`

Extra commandline options to pass to the ipmi exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.ipmi.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.ipmi.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9290"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.ipmi.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.ipmi.openFirewall is true.

Type: null or strings concatenated with "\n"

Whether to enable the prometheus jitsi exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.jitsi.extraFlags`

Default

"jitsi-exporter"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.jitsi.interval`

How often to scrape new data

Type: string

Path to configuration file.

Type: path

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.json.enable`

Whether to enable the prometheus json exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.json.extraFlags`

Extra commandline options to pass to the json exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.json.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.json.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 7979"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.json.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.json.openFirewall is true.

Type: null or strings concatenated with "\n"

JunOS exporter configuration as nix attribute set. Mutually exclusive with the configurationFile option.

Type: null or (attribute set)

Default

null

Example

{devices = [{host = "router1";key_file = "/path/to/key";}];}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.junos-czerwonk.configurationFile`

Specify the JunOS exporter configuration file to use.

Type: null or path

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.junos-czerwonk.enable`

Whether to enable the prometheus junos-czerwonk exporter. Type: boolean

Specify a filter for iptables to use when {option}services.prometheus.exporters.junos-czerwonk.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9326"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.junos-czerwonk.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.junos-czerwonk.openFirewall is true.

Type: null or strings concatenated with "\n"

Whether to enable the prometheus kea exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.kea.extraFlags`

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.keylight.extraFlags`

Extra commandline options to pass to the keylight exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.keylight.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.keylight.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9288"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.keylight.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.keylight.openFirewall is true.

Type: null or strings concatenated with "\n"

Whether to enable the prometheus knot exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.knot.extraFlags`

Default

"knot-exporter"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.knot.knotLibraryPath`

Path to the library of knot-dns.

Type: null or string

Whether to enable the prometheus lnd exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.lnd.extraFlags`

Extra commandline options to pass to the lnd exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.lnd.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.lnd.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9092"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.lnd.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.lnd.openFirewall is true.

Type: null or strings concatenated with "\n"

Path to lnd macaroons.

Type: path

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.lnd.lndTlsPath`

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.mail.configuration.mailCheckTimeout`

Timeout until mails are considered "didn't make it".

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.mail.configuration.monitoringInterval`

Time interval between two probe attempts.

Type: string

Example

"10s"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.mail.configuration.servers`

List of servers that should be probed.

Note: if your mailserver has {manpage}rspamd(8) configured, it can happen that emails from this exporter are marked as spam.

It's possible to work around the issue with a config like this:

{
  services.rspamd.locals."multimap.conf".text = ''
    ALLOWLIST_PROMETHEUS {
      filter = "email:domain:tld";
      type = "from";
      map = "${pkgs.writeText "allowmap" "domain.tld"}";
      score = -100.0;
    }
  '';
}

Type: list of (submodule)

Username to use for SMTP authentication.

Type: null or string

Default

null

Example

"exporteruser@domain.tld"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.mail.configuration.servers.*.name`

Value for label 'configname' which will be added to all metrics.

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.mail.configuration.servers.*.passphrase`

Password to use for SMTP authentication.

Type: null or string

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.mail.configuration.servers.*.port`

Port to use for SMTP.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Example

587

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.mail.configuration.servers.*.server`

Hostname of the server that should be probed.

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.mail.configuration.servers.*.to`

Content of 'To' Header for probing mails.

Type: string

Example

"exporteruser@domain.tld"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.mail.enable`

Whether to enable the prometheus mail exporter. Type: boolean

Specify a filter for iptables to use when {option}services.prometheus.exporters.mail.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9225"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.mail.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.mail.openFirewall is true.

Type: null or strings concatenated with "\n"

null

Example

./mikrotik.yml

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.mikrotik.configuration`

Mikrotik exporter configuration as nix attribute set. Mutually exclusive with {option}configFile option.

See https://github.com/nshttpd/mikrotik-exporter/blob/master/README.md for the description of the configuration file format.

Type: null or (attribute set)

Default

null

Example

{devices = [{name = "my_router";address = "10.10.0.1";user = "prometheus";password = "changeme";}];features = {bgp = true;dhcp = true;routes = true;optics = true;};}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.mikrotik.enable`

Whether to enable the prometheus mikrotik exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.mikrotik.extraFlags`

Extra commandline options to pass to the mikrotik exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.mikrotik.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.mikrotik.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9436"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.mikrotik.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.mikrotik.openFirewall is true.

Type: null or strings concatenated with "\n"

Whether to enable the prometheus modemmanager exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.modemmanager.extraFlags`

Extra commandline options to pass to the modemmanager exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.modemmanager.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.modemmanager.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9539"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.modemmanager.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.modemmanager.openFirewall is true.

Type: null or strings concatenated with "\n"

[ ]

Example

["db1.coll1""db2"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.mongodb.collectAll`

"mongodb-exporter"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.mongodb.indexStats`

List of comma separared databases.collections to get $indexStats

Type: list of string

Metrics expose path Type: string

Default

"/metrics"

Example

"/metrics"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.mongodb.uri`

MongoDB URI to connect to. Type: string

Default

"mongodb://localhost:27017/test"

Example

"mongodb://localhost:27017/test"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.mongodb.user`

User name under which the mongodb exporter shall be run.

Type: string

Default

"mongodb-exporter"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.mysqld.configFile`

Path to the services config file.

See https://github.com/prometheus/mysqld_exporter#running for more information about the available options.

::: {.warn} Please do not store this file in the nix store if you choose to include any credentials here, as it would be world-readable. :::

Type: path

Example

"/var/lib/prometheus-mysqld-exporter.cnf"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.mysqld.enable`

Whether to enable the prometheus mysqld exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.mysqld.extraFlags`

Extra commandline options to pass to the mysqld exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.mysqld.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.mysqld.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9104"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.mysqld.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.mysqld.openFirewall is true.

Type: null or strings concatenated with "\n"

"mysqld-exporter"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.nats.enable`

Whether to enable the prometheus nats exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.nats.extraFlags`

Extra commandline options to pass to the nats exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.nats.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.nats.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 7777"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.nats.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.nats.openFirewall is true.

Type: null or strings concatenated with "\n"

Whether to enable the prometheus nextcloud exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.nextcloud.extraFlags`

Extra commandline options to pass to the nextcloud exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.nextcloud.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.nextcloud.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9205"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.nextcloud.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.nextcloud.openFirewall is true.

Type: null or strings concatenated with "\n"

File containing the password for connecting to Nextcloud. Make sure that this file is readable by the exporter user.

Type: null or path

File containing the token for connecting to Nextcloud. Make sure that this file is readable by the exporter user.

Type: null or path

[ ]

Example

["label1=value1""label2=value2"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.nginx.enable`

Whether to enable the prometheus nginx exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.nginx.extraFlags`

Extra commandline options to pass to the nginx exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.nginx.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.nginx.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9113"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.nginx.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.nginx.openFirewall is true.

Type: null or strings concatenated with "\n"

Whether to enable the prometheus nginxlog exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.nginxlog.extraFlags`

Extra commandline options to pass to the nginxlog exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.nginxlog.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.nginxlog.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9117"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.nginxlog.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.nginxlog.openFirewall is true.

Type: null or strings concatenated with "\n"

All settings of nginxlog expressed as an Nix attrset.

Check the official documentation for the corresponding YAML settings that can all be used here: https://github.com/martin-helmich/prometheus-nginxlog-exporter

The listen object is already generated by port, listenAddress and metricsEndpoint and will be merged with the value of settings before writing it as JSON.

Type: submodule

Default

{ }

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.nginxlog.settings.consul`

Consul integration options. For more information see the example config.

Collectors to disable which are enabled by default.

Type: list of string

Default

[ ]

Example

["timex"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.node.enable`

Whether to enable the prometheus node exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.node.enabledCollectors`

Collectors to enable. The collectors listed here are enabled in addition to the default ones.

Type: list of string

Default

[ ]

Example

["systemd"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.node.extraFlags`

Extra commandline options to pass to the node exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.node.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.node.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9100"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.node.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.node.openFirewall is true.

Type: null or strings concatenated with "\n"

Whether to enable the prometheus nut exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.nut.extraFlags`

List of NUT variable names to monitor.

Whether to enable the prometheus openldap exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.openldap.extraFlags`

Default

"openldap-exporter"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.openldap.interval`

Scrape interval of the exporter.

Type: string

Default

"30s"

Example

"1m"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.openldap.ldapAddr`

Address of the openldap-instance.

Type: string

Default

"localhost:389"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.openldap.ldapCredentialFile`

Environment file to contain the credentials to authenticate against openldap.

The file should look like this:

---
ldapUser: "cn=monitoring,cn=Monitor"
ldapPass: "secret"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.openldap.protocol`

Which protocol to use to connect against openldap.

Type: string

Default

"tcp"

Example

"udp"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.openldap.user`

User name under which the openldap exporter shall be run.

Type: string

Default

"openldap-exporter"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.pgbouncer.connectionString`

Connection string for accessing pgBouncer.

NOTE: You MUST keep pgbouncer as database name (special internal db)!!!

NOTE: Admin user (with password or passwordless) MUST exist in the services.pgbouncer.authFile if authType other than any is used.

WARNING: this secret is stored in the world-readable Nix store! Use {option}connectionStringFile instead.

Type: string

Default

""

Example

"postgres://admin:@localhost:6432/pgbouncer?sslmode=require"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.pgbouncer.connectionStringFile`

File that contains pgBouncer connection string in format: postgres://admin:@localhost:6432/pgbouncer?sslmode=require

NOTE: You MUST keep pgbouncer as database name (special internal db)!!!

NOTE: Admin user (with password or passwordless) MUST exist in the services.pgbouncer.authFile if authType other than any is used.

{option}connectionStringFile takes precedence over {option}connectionString

Type: null or path

Default

null

Example

"/run/keys/pgBouncer-connection-string"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.pgbouncer.enable`

Whether to enable the prometheus pgbouncer exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.pgbouncer.extraFlags`

Extra commandline options when launching Prometheus.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.pgbouncer.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.pgbouncer.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9127"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.pgbouncer.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.pgbouncer.openFirewall is true.

Type: null or strings concatenated with "\n"

Path to PgBouncer pid file.

If provided, the standard process metrics get exported for the PgBouncer process, prefixed with 'pgbouncer_process_...'. The pgbouncer_process exporter needs to have read access to files owned by the PgBouncer process. Depends on the availability of /proc.

Whether to enable the prometheus php-fpm exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.php-fpm.environmentFile`

Environment file as defined in {manpage}systemd.exec(5).

Secrets may be passed to the service without adding them to the world-readable Nix store, by specifying placeholder variables as the option value in Nix and setting these variables accordingly in the environment file.

Environment variables from this file will be interpolated into the config file using envsubst with this syntax: $ENVIRONMENT ${VARIABLE}

For variables to use see options and defaults.

The main use is to set the PHP_FPM_SCRAPE_URI that indicate how to connect to PHP-FPM process.

  # Content of the environment file
  PHP_FPM_SCRAPE_URI="unix:///tmp/php.sock;/status"

Note that this file needs to be available on the host on which this exporter is running.

Type: null or path

Default

null

Example

"/root/prometheus-php-fpm-exporter.env"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.php-fpm.extraFlags`

Extra commandline options to pass to the php-fpm exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.php-fpm.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.php-fpm.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9253"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.php-fpm.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.php-fpm.openFirewall is true.

Type: null or strings concatenated with "\n"

Type: string

Default

""

Example

"580a770cb40511eb85290242ac130003580a770cb40511eb85290242ac130003"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.pihole.enable`

Whether to enable the prometheus pihole exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.pihole.extraFlags`

Extra commandline options to pass to the pihole exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.pihole.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.pihole.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9617"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.pihole.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.pihole.openFirewall is true.

Type: null or strings concatenated with "\n"

Port to listen on.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

9617

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.pihole.protocol`

The protocol which is used to connect to Pi-Hole

Type: one of "http", "https"

Whether to enable the prometheus ping exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.ping.extraFlags`

Extra commandline options to pass to the ping exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.ping.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.ping.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9427"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.ping.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.ping.openFirewall is true.

Type: null or strings concatenated with "\n"

"ping-exporter"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.postfix.enable`

Whether to enable the prometheus postfix exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.postfix.extraFlags`

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.postfix.listenAddress`

Address to listen on.

Type: string

Default

"0.0.0.0"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.postfix.logfilePath`

Path where Postfix writes log entries. This file will be truncated by this exporter!

Type: path

Path where Postfix places its showq socket.

Type: path

"user=postgres database=postgres host=/run/postgresql sslmode=disable"

Example

"postgresql://username:password@localhost:5432/postgres?sslmode=disable"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.postgres.enable`

Whether to enable the prometheus postgres exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.postgres.environmentFile`

Environment file as defined in {manpage}systemd.exec(5).

Secrets may be passed to the service without adding them to the world-readable Nix store, by specifying placeholder variables as the option value in Nix and setting these variables accordingly in the environment file.

Environment variables from this file will be interpolated into the config file using envsubst with this syntax: $ENVIRONMENT ${VARIABLE}

The main use is to set the DATA_SOURCE_NAME that contains the postgres password

note that contents from this file will override dataSourceName if you have set it from nix.

  # Content of the environment file
  DATA_SOURCE_NAME=postgresql://username:password@localhost:5432/postgres?sslmode=disable

Note that this file needs to be available on the host on which this exporter is running.

Type: null or path

Default

null

Example

"/root/prometheus-postgres-exporter.env"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.postgres.extraFlags`

Extra commandline options to pass to the postgres exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.postgres.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.postgres.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9187"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.postgres.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.postgres.openFirewall is true.

Type: null or strings concatenated with "\n"

"postgres-exporter"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.process.enable`

Whether to enable the prometheus process exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.process.extraFlags`

Default

Path to the service's config file. This path can either be a computed path in /nix/store or a path in the local filesystem.

The config file should NOT be stored in /nix/store as it will contain passwords and/or keys in plain text.

If both configFile and environmentFile are provided, the configFile option will be ignored.

Configuration reference: https://github.com/prometheus-pve/prometheus-pve-exporter/#authentication

Type: null or path

Default

null

Example

"/etc/prometheus-pve-exporter/pve.yml"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.pve.enable`

Whether to enable the prometheus pve exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.pve.environmentFile`

Path to the service's environment file. This path can either be a computed path in /nix/store or a path in the local filesystem.

The environment file should NOT be stored in /nix/store as it contains passwords and/or keys in plain text.

Environment reference: https://github.com/prometheus-pve/prometheus-pve-exporter#authentication

Type: null or path

Default

null

Example

"/etc/prometheus-pve-exporter/pve.env"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.pve.extraFlags`

Extra commandline options to pass to the pve exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.pve.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.pve.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9221"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.pve.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.pve.openFirewall is true.

Type: null or strings concatenated with "\n"

The prometheus-pve-exporter package to use. Type: package

Default

pkgs.prometheus-pve-exporter

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.pve.port`

Default

"pve-exporter"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.py-air-control.deviceHostname`

The hostname of the air purification device from which to scrape the metrics.

Type: string

Example

"192.168.1.123"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.py-air-control.enable`

Whether to enable the prometheus py-air-control exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.py-air-control.extraFlags`

Extra commandline options to pass to the py-air-control exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.py-air-control.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.py-air-control.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9896"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.py-air-control.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.py-air-control.openFirewall is true.

Type: null or strings concatenated with "\n"

"py-air-control-exporter"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.redis.enable`

Whether to enable the prometheus redis exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.redis.extraFlags`

Extra commandline options to pass to the redis exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.redis.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.redis.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9121"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.redis.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.redis.openFirewall is true.

Type: null or strings concatenated with "\n"

Whether to enable the prometheus restic exporter. Type: boolean

Specify a filter for iptables to use when {option}services.prometheus.exporters.restic.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9753"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.restic.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.restic.openFirewall is true.

Type: null or strings concatenated with "\n"

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for available options. When specifying option names, strip the leading --. To set a flag such as --drive-use-trash, which does not take a value, set the value to the Boolean true.

Type: attribute set of (string or boolean)

Default

{ }

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.restic.refreshInterval`

Refresh interval for the metrics in seconds. Computing the metrics is an expensive task, keep this value as high as possible.

Type: unsigned integer, meaning >=0

Default

60

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.restic.repository`

URI pointing to the repository to monitor.

Type: string

Example

"sftp:backup@192.168.1.100:/backups/example"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.restic.user`

User name under which the restic exporter shall be run.

Type: string

Default

"restic-exporter"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.rspamd.enable`

Whether to enable the prometheus rspamd exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.rspamd.extraFlags`

Extra commandline options to pass to the rspamd exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

List of channel matchers to export.

Type: list of (submodule)

Default

[ ]

Example

[{channel = 6543;location = "Kitchen";name = "Acurite";}]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.rtl_433.channels.*.channel`

Channel to match. Type: signed integer

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.rtl_433.channels.*.location`

Location to match. Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.rtl_433.channels.*.name`

Name to match. Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.rtl_433.enable`

Whether to enable the prometheus rtl_433 exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.rtl_433.extraFlags`

Default

"rtl_433-exporter"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.rtl_433.ids`

List of ID matchers to export.

Type: list of (submodule)

"-C si"

Example

"-C si -R 19"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.rtl_433.user`

User name under which the rtl_433 exporter shall be run.

Type: string

Default

"rtl_433-exporter"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.sabnzbd.enable`

Whether to enable the prometheus sabnzbd exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.sabnzbd.extraFlags`

Example

"/run/secrets/sabnzbd_apikey"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.sabnzbd.servers.*.baseUrl`

Base URL of the sabnzbd server. Type: string

Example

"http://localhost:8080/sabnzbd"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.sabnzbd.user`

User name under which the sabnzbd exporter shall be run.

Type: string

Default

"sabnzbd-exporter"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.scaphandre.enable`

Whether to enable the prometheus scaphandre exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.scaphandre.extraFlags`

Extra commandline options to pass to the scaphandre exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.scaphandre.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.scaphandre.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 8080"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.scaphandre.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.scaphandre.openFirewall is true.

Type: null or strings concatenated with "\n"

Whether to enable the prometheus script exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.script.extraFlags`

Extra commandline options to pass to the script exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.script.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.script.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9172"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.script.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.script.openFirewall is true.

Type: null or strings concatenated with "\n"

All settings expressed as an Nix attrset.

Check the official documentation for the corresponding YAML settings that can all be used here: https://github.com/adhocteam/script_exporter#sample-configuration

Optional timeout for the script in seconds. Type: null or signed integer

Default

null

Example

60

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.script.user`

User name under which the script exporter shall be run.

Type: string

Default

"script-exporter"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.shelly.enable`

Whether to enable the prometheus shelly exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.shelly.extraFlags`

Extra commandline options to pass to the shelly exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.shelly.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.shelly.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9784"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.shelly.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.shelly.openFirewall is true.

Type: null or strings concatenated with "\n"

Path to the JSON file with the metric definitions

[ ]

Example

[ "/dev/sda", "/dev/nvme0n1" ];

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.smartctl.enable`

Whether to enable the prometheus smartctl exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.smartctl.extraFlags`

Extra commandline options to pass to the smartctl exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.smartctl.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.smartctl.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9633"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.smartctl.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.smartctl.openFirewall is true.

Type: null or strings concatenated with "\n"

Interval that limits how often a disk can be queried.

Type: string

Whether to enable the prometheus smokeping exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.smokeping.extraFlags`

Default

"smokeping-exporter"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.smokeping.hosts`

List of endpoints to probe.

null

Example

{auths = {public_v2 = {community = "public";version = 2;};};}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.snmp.configurationPath`

Path to a snmp exporter configuration file. Mutually exclusive with 'configuration' option.

Type: null or path

Default

null

Example

./snmp.yml

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.snmp.enable`

Whether to enable the prometheus snmp exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.snmp.enableConfigCheck`

Whether to run a correctness check for the configuration file. This depends on the configuration file residing in the nix-store. Paths passed as string will be copied to the store.

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.snmp.environmentFile`

EnvironmentFile as defined in {manpage}systemd.exec(5).

Secrets may be passed to the service without adding them to the world-readable Nix store, by specifying placeholder variables as the option value in Nix and setting these variables accordingly in the environment file.

Environment variables from this file will be interpolated into the config file using envsubst with this syntax: $ENVIRONMENT ${VARIABLE}

For variables to use see Prometheus Configuration.

If the file path is set to this option, the parameter --config.expand-environment-variables is implicitly added to ExecStart.

Note that this file needs to be available on the host on which this exporter is running.

Type: null or path

Default

null

Example

"/root/prometheus-snmp-exporter.env"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.snmp.extraFlags`

Extra commandline options to pass to the snmp exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.snmp.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.snmp.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9116"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.snmp.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.snmp.openFirewall is true.

Type: null or strings concatenated with "\n"

An attrset of metrics scraping jobs to run. Type: attribute set of (submodule)

Default

{ }

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.sql.configuration.jobs.<name>.connections`

A list of connection strings of the SQL servers to scrape metrics from Type: list of string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.sql.configuration.jobs.<name>.interval`

How often to run this job, specified in Go duration format.

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.sql.configuration.jobs.<name>.queries`

SQL queries to run. Type: attribute set of (submodule)

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.sql.configuration.jobs.<name>.queries.<name>.help`

A human-readable description of this metric. Type: null or string

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.sql.configuration.jobs.<name>.queries.<name>.labels`

A set of columns that will be used as Prometheus labels. Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.sql.configuration.jobs.<name>.queries.<name>.query`

The SQL query to run. Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.sql.configuration.jobs.<name>.queries.<name>.values`

A set of columns that will be used as values of this metric. Type: list of string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.sql.configuration.jobs.<name>.startupSql`

A list of SQL statements to execute once after making a connection. Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.sql.enable`

Whether to enable the prometheus sql exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.sql.extraFlags`

Extra commandline options to pass to the sql exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.sql.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.sql.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9237"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.sql.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.sql.openFirewall is true.

Type: null or strings concatenated with "\n"

Whether to enable the prometheus statsd exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.statsd.extraFlags`

Extra commandline options to pass to the statsd exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.statsd.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.statsd.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9102"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.statsd.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.statsd.openFirewall is true.

Type: null or strings concatenated with "\n"

Whether to enable the prometheus surfboard exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.surfboard.extraFlags`

Extra commandline options to pass to the surfboard exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.surfboard.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.surfboard.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9239"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.surfboard.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.surfboard.openFirewall is true.

Type: null or strings concatenated with "\n"

Whether to enable the prometheus systemd exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.systemd.extraFlags`

Extra commandline options to pass to the systemd exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.systemd.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.systemd.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9558"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.systemd.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.systemd.openFirewall is true.

Type: null or strings concatenated with "\n"

Whether to enable the prometheus tor exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.tor.extraFlags`

Extra commandline options to pass to the tor exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.tor.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.tor.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9130"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.tor.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.tor.openFirewall is true.

Type: null or strings concatenated with "\n"

"tor-exporter"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.unbound.enable`

Whether to enable the prometheus unbound exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.unbound.extraFlags`

Extra commandline options to pass to the unbound exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.unbound.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.unbound.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9167"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.unbound.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.unbound.openFirewall is true.

Type: null or strings concatenated with "\n"

Default

"unbound-exporter"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.unifi.enable`

Whether to enable the prometheus unifi exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.unifi.extraFlags`

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.unifi.unifiTimeout`

Timeout including unit for UniFi Controller API requests.

Type: string

Whether to enable the prometheus unpoller exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.unpoller.extraFlags`

Extra commandline options to pass to the unpoller exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.unpoller.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.unpoller.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9130"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.unpoller.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.unpoller.openFirewall is true.

Type: null or strings concatenated with "\n"

"unpoller-exporter"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.v2ray.enable`

Whether to enable the prometheus v2ray exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.v2ray.extraFlags`

Extra commandline options to pass to the v2ray exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.v2ray.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.v2ray.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9299"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.v2ray.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.v2ray.openFirewall is true.

Type: null or strings concatenated with "\n"

Whether to enable the prometheus varnish exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.varnish.extraFlags`

Extra commandline options to pass to the varnish exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.varnish.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.varnish.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9131"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.varnish.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.varnish.openFirewall is true.

Type: null or strings concatenated with "\n"

Whether to enable the prometheus wireguard exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.wireguard.extraFlags`

Extra commandline options to pass to the wireguard exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.wireguard.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.wireguard.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9586"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.wireguard.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.wireguard.openFirewall is true.

Type: null or strings concatenated with "\n"

Whether to enable verbose logging mode for prometheus-wireguard-exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.wireguard.wireguardConfig`

Path to the Wireguard Config to add the peer's name to the stats of a peer.

Please note that networking.wg-quick is required for this feature as networking.wireguard uses {manpage}wg(8) to set the peers up.

Type: null or path or string

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.wireguard.withRemoteIp`

Whether or not the remote IP of a WireGuard peer should be exposed via prometheus.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.zfs.enable`

Whether to enable the prometheus zfs exporter. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.zfs.extraFlags`

Extra commandline options to pass to the zfs exporter.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.zfs.firewallFilter`

Specify a filter for iptables to use when {option}services.prometheus.exporters.zfs.openFirewall is true. It is used as ip46tables -I nixos-fw firewallFilter -j nixos-fw-accept.

Type: null or string

Default

null

Example

"-i eth0 -p tcp -m tcp --dport 9134"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/exporters.nix

`services.prometheus.exporters.zfs.firewallRules`

Specify rules for nftables to add to the input chain when {option}services.prometheus.exporters.zfs.openFirewall is true.

Type: null or strings concatenated with "\n"

How frequently to evaluate rules by default.

How frequently to scrape targets by default.

Defaults to 1m in prometheus when set to null.

Type: null or string

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.globalConfig.scrape_timeout`

How long until a scrape request times out.

Defaults to 10s in prometheus when set to null.

Type: null or string

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.listenAddress`

Address to listen on for the web interface, API, and telemetry.

Type: string

Default

"0.0.0.0"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.package`

The prometheus package to use. Type: package

Default

pkgs.prometheus

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.port`

Port to listen on.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

9090

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.pushgateway.enable`

Whether to enable Prometheus Pushgateway. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/pushgateway.nix

`services.prometheus.pushgateway.extraFlags`

Extra commandline options when launching the Pushgateway.

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/pushgateway.nix

`services.prometheus.pushgateway.log.format`

Set the log target and format.

null will default to logger:stderr.

Type: null or string

Default

null

Example

"logger:syslog?appname=bob&local=7"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/pushgateway.nix

`services.prometheus.pushgateway.log.level`

Only log messages with the given severity or above.

null will default to info.

Type: null or one of "debug", "info", "warn", "error", "fatal"

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/pushgateway.nix

`services.prometheus.pushgateway.package`

The prometheus-pushgateway package to use. Type: package

Default

pkgs.prometheus-pushgateway

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/pushgateway.nix

`services.prometheus.pushgateway.persistMetrics`

Whether to persist metrics to a file.

When enabled metrics will be saved to a file called metrics in the directory /var/lib/pushgateway. The directory below /var/lib can be set using {option}services.prometheus.pushgateway.stateDir.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/pushgateway.nix

`services.prometheus.pushgateway.persistence.interval`

The minimum interval at which to write out the persistence file.

null will default to 5m.

Type: null or string

Default

null

Example

"10m"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/pushgateway.nix

`services.prometheus.pushgateway.stateDir`

Directory below /var/lib to store metrics.

This directory will be created automatically using systemd's StateDirectory mechanism when {option}services.prometheus.pushgateway.persistMetrics is enabled.

Type: string

Default

"pushgateway"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/pushgateway.nix

HTTP username

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

ServerName extension to indicate the name of the server. http://tools.ietf.org/html/rfc4366#section-3.1

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.remoteWrite`

Parameters of the endpoints to send samples to. See the official documentation for more information.

Type: list of (submodule)

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.remoteWrite.*.basic_auth`

Sets the Authorization header on every remote write request with the configured username and password. password and password_file are mutually exclusive.

ServerName extension to indicate the name of the server. http://tools.ietf.org/html/rfc4366#section-3.1

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.remoteWrite.*.write_relabel_configs`

List of remote write relabel configurations.

Type: null or (list of (submodule))

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.remoteWrite..write_relabel_configs..action` {services-prometheus-remoteWrite--write_relabel_configs--action}

Action to perform based on regex matching.

Defaults to replace in prometheus when set to null.

Type: null or one of "replace", "lowercase", "uppercase", "keep", "drop", "hashmod", "labelmap", "labeldrop", "labelkeep"

Default {services-prometheus-remoteWrite--write_relabel_configs--action-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

How long to retain samples in storage.

Type: null or string

Sachet's configuration as a nix attribute set.

Type: null or (attribute set)

Default

null

Example

{providers = {twilio = {# environment variables gets expanded at runtimeaccount_sid = "$TWILIO_ACCOUNT";auth_token = "$TWILIO_TOKEN";};};templates = [ ./some-template.tmpl ];receivers = [{name = "pager";provider = "twilio";to = [ "+33123456789" ];text = "{{ template \"message\" . }}";}];}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/sachet.nix

`services.prometheus.sachet.enable`

Whether to enable Sachet, an SMS alerting tool for the Prometheus Alertmanager. Type: boolean

The authentication method, either OAuth or ManagedIdentity. See https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview

HTTP username

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs.*.consul_sd_configs`

List of Consul service discovery configurations.

Type: null or (list of (submodule))

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..consul_sd_configs..allow_stale` {services-prometheus-scrapeConfigs--consul_sd_configs--allow_stale}

Allow stale Consul results (see https://www.consul.io/api/index.html#consistency-modes).

Sets the authentication type.

Defaults to Bearer in prometheus when set to null.

Type: null or string

Default {services-prometheus-scrapeConfigs--consul_sd_configs--authorization-type-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..consul_sd_configs..basic_auth` {services-prometheus-scrapeConfigs--consul_sd_configs--basic_auth}

Optional HTTP basic authentication information.

HTTP username

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..consul_sd_configs..datacenter` {services-prometheus-scrapeConfigs--consul_sd_configs--datacenter}

Consul datacenter Type: null or string

Default {services-prometheus-scrapeConfigs--consul_sd_configs--datacenter-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..consul_sd_configs..follow_redirects` {services-prometheus-scrapeConfigs--consul_sd_configs--follow_redirects}

Configure whether HTTP requests follow HTTP 3xx redirects.

Consul password Type: null or string

Default {services-prometheus-scrapeConfigs--consul_sd_configs--password-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..consul_sd_configs..proxy_url` {services-prometheus-scrapeConfigs--consul_sd_configs--proxy_url}

Optional proxy URL.

Type: null or string

Default {services-prometheus-scrapeConfigs--consul_sd_configs--proxy_url-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..consul_sd_configs..refresh_interval` {services-prometheus-scrapeConfigs--consul_sd_configs--refresh_interval}

Sets the authentication type.

Defaults to Bearer in prometheus when set to null.

Type: null or string

Default {services-prometheus-scrapeConfigs--digitalocean_sd_configs--authorization-type-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..digitalocean_sd_configs..basic_auth` {services-prometheus-scrapeConfigs--digitalocean_sd_configs--basic_auth}

Optional HTTP basic authentication information.

HTTP username

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..digitalocean_sd_configs..follow_redirects` {services-prometheus-scrapeConfigs--digitalocean_sd_configs--follow_redirects}

Configure whether HTTP requests follow HTTP 3xx redirects.

The port to scrape metrics from.

Defaults to 80 in prometheus when set to null.

Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default {services-prometheus-scrapeConfigs--digitalocean_sd_configs--port-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..digitalocean_sd_configs..proxy_url` {services-prometheus-scrapeConfigs--digitalocean_sd_configs--proxy_url}

Optional proxy URL.

Type: null or string

Default {services-prometheus-scrapeConfigs--digitalocean_sd_configs--proxy_url-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..digitalocean_sd_configs..refresh_interval` {services-prometheus-scrapeConfigs--digitalocean_sd_configs--refresh_interval}

The time after which the droplets are refreshed.

A list of DNS SRV record names to be queried.

Type: list of string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

Sets the authentication type.

Defaults to Bearer in prometheus when set to null.

Type: null or string

Default {services-prometheus-scrapeConfigs--docker_sd_configs--authorization-type-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..docker_sd_configs..basic_auth` {services-prometheus-scrapeConfigs--docker_sd_configs--basic_auth}

Optional HTTP basic authentication information.

HTTP username

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..docker_sd_configs..filters` {services-prometheus-scrapeConfigs--docker_sd_configs--filters}

Optional filters to limit the discovery process to a subset of available resources.

Type: null or (list of (submodule))

Default {services-prometheus-scrapeConfigs--docker_sd_configs--filters-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..docker_sd_configs..filters..name` {services-prometheus-scrapeConfigs--docker_sd_configs--filters--name}

Name of the filter. The available filters are listed in the upstream documentation: Services: https://docs.docker.com/engine/api/v1.40/#operation/ServiceList Tasks: https://docs.docker.com/engine/api/v1.40/#operation/TaskList Nodes: https://docs.docker.com/engine/api/v1.40/#operation/NodeList

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..docker_sd_configs..filters..values` {services-prometheus-scrapeConfigs--docker_sd_configs--filters--values}

Value for the filter.

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..docker_sd_configs..follow_redirects` {services-prometheus-scrapeConfigs--docker_sd_configs--follow_redirects}

Configure whether HTTP requests follow HTTP 3xx redirects.

Defaults to true in prometheus when set to null.

Type: null or boolean

Default {services-prometheus-scrapeConfigs--docker_sd_configs--follow_redirects-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..docker_sd_configs..host` {services-prometheus-scrapeConfigs--docker_sd_configs--host}

Address of the Docker daemon.

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..docker_sd_configs..host_networking_host` {services-prometheus-scrapeConfigs--docker_sd_configs--host_networking_host}

The host to use if the container is in host networking mode.

The port to scrape metrics from, when role is nodes, and for discovered tasks and services that don't have published ports.

Defaults to 80 in prometheus when set to null.

Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default {services-prometheus-scrapeConfigs--docker_sd_configs--port-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..docker_sd_configs..proxy_url` {services-prometheus-scrapeConfigs--docker_sd_configs--proxy_url}

Optional proxy URL.

Type: null or string

Default {services-prometheus-scrapeConfigs--docker_sd_configs--proxy_url-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..docker_sd_configs..refresh_interval` {services-prometheus-scrapeConfigs--docker_sd_configs--refresh_interval}

The time after which the containers are refreshed.

Sets the authentication type.

Defaults to Bearer in prometheus when set to null.

Type: null or string

Default {services-prometheus-scrapeConfigs--dockerswarm_sd_configs--authorization-type-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..dockerswarm_sd_configs..basic_auth` {services-prometheus-scrapeConfigs--dockerswarm_sd_configs--basic_auth}

Optional HTTP basic authentication information.

HTTP username

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..dockerswarm_sd_configs..filters` {services-prometheus-scrapeConfigs--dockerswarm_sd_configs--filters}

Optional filters to limit the discovery process to a subset of available resources.

Type: null or (list of (submodule))

Default {services-prometheus-scrapeConfigs--dockerswarm_sd_configs--filters-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..dockerswarm_sd_configs..filters..name` {services-prometheus-scrapeConfigs--dockerswarm_sd_configs--filters--name}

Name of the filter. The available filters are listed in the upstream documentation: Services: https://docs.docker.com/engine/api/v1.40/#operation/ServiceList Tasks: https://docs.docker.com/engine/api/v1.40/#operation/TaskList Nodes: https://docs.docker.com/engine/api/v1.40/#operation/NodeList

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..dockerswarm_sd_configs..filters..values` {services-prometheus-scrapeConfigs--dockerswarm_sd_configs--filters--values}

Value for the filter.

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..dockerswarm_sd_configs..follow_redirects` {services-prometheus-scrapeConfigs--dockerswarm_sd_configs--follow_redirects}

Configure whether HTTP requests follow HTTP 3xx redirects.

Defaults to true in prometheus when set to null.

Type: null or boolean

Default {services-prometheus-scrapeConfigs--dockerswarm_sd_configs--follow_redirects-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..dockerswarm_sd_configs..host` {services-prometheus-scrapeConfigs--dockerswarm_sd_configs--host}

`services.prometheus.scrapeConfigs..dockerswarm_sd_configs..port` {services-prometheus-scrapeConfigs--dockerswarm_sd_configs--port}

The port to scrape metrics from, when role is nodes, and for discovered tasks and services that don't have published ports.

Defaults to 80 in prometheus when set to null.

Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default {services-prometheus-scrapeConfigs--dockerswarm_sd_configs--port-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..dockerswarm_sd_configs..proxy_url` {services-prometheus-scrapeConfigs--dockerswarm_sd_configs--proxy_url}

Optional proxy URL.

Type: null or string

Default {services-prometheus-scrapeConfigs--dockerswarm_sd_configs--proxy_url-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..dockerswarm_sd_configs..refresh_interval` {services-prometheus-scrapeConfigs--dockerswarm_sd_configs--refresh_interval}

The time after which the containers are refreshed.

Defaults to 60s in prometheus when set to null.

Type: null or string

Default {services-prometheus-scrapeConfigs--dockerswarm_sd_configs--refresh_interval-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..dockerswarm_sd_configs..role` {services-prometheus-scrapeConfigs--dockerswarm_sd_configs--role}

`services.prometheus.scrapeConfigs..ec2_sd_configs..filters..name` {services-prometheus-scrapeConfigs--ec2_sd_configs--filters--name}

See this list for the available filters.

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..ec2_sd_configs..filters..values` {services-prometheus-scrapeConfigs--ec2_sd_configs--filters--values}

Value of the filter.

Type: list of string

Default {services-prometheus-scrapeConfigs--ec2_sd_configs--filters-*-values-default}

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..ec2_sd_configs..port` {services-prometheus-scrapeConfigs--ec2_sd_configs--port}

The port to scrape metrics from. If using the public IP address, this must instead be specified in the relabeling rule.

Defaults to 80 in prometheus when set to null.

Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default {services-prometheus-scrapeConfigs--ec2_sd_configs--port-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

Default {services-prometheus-scrapeConfigs--eureka_sd_configs--authorization-type-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..eureka_sd_configs..basic_auth` {services-prometheus-scrapeConfigs--eureka_sd_configs--basic_auth}

Optional HTTP basic authentication information.

HTTP username

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..eureka_sd_configs..follow_redirects` {services-prometheus-scrapeConfigs--eureka_sd_configs--follow_redirects}

Configure whether HTTP requests follow HTTP 3xx redirects.

`services.prometheus.scrapeConfigs..file_sd_configs..files` {services-prometheus-scrapeConfigs--file_sd_configs--files}

Patterns for files from which target groups are extracted. Refer to the Prometheus documentation for permitted filename patterns and formats.

Type: list of string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..file_sd_configs..refresh_interval` {services-prometheus-scrapeConfigs--file_sd_configs--refresh_interval}

Refresh interval to re-read the files.

Defaults to 5m in prometheus when set to null.

Type: null or string

Default {services-prometheus-scrapeConfigs--file_sd_configs--refresh_interval-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs.*.gce_sd_configs`

List of Google Compute Engine service discovery configurations.

See the relevant Prometheus configuration docs for more detail.

Type: null or (list of (submodule))

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..gce_sd_configs..filter` {services-prometheus-scrapeConfigs--gce_sd_configs--filter}

Filter can be used optionally to filter the instance list by other criteria Syntax of this filter string is described here in the filter query parameter section: https://cloud.google.com/compute/docs/reference/latest/instances/list.

Type: null or string

Default {services-prometheus-scrapeConfigs--gce_sd_configs--filter-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..gce_sd_configs..port` {services-prometheus-scrapeConfigs--gce_sd_configs--port}

The port to scrape metrics from. If using the public IP address, this must instead be specified in the relabeling rule.

Defaults to 80 in prometheus when set to null.

Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default {services-prometheus-scrapeConfigs--gce_sd_configs--port-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..gce_sd_configs..project` {services-prometheus-scrapeConfigs--gce_sd_configs--project}

The GCP Project.

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..gce_sd_configs..refresh_interval` {services-prometheus-scrapeConfigs--gce_sd_configs--refresh_interval}

Refresh interval to re-read the cloud instance list.

Defaults to 60s in prometheus when set to null.

Type: null or string

Default {services-prometheus-scrapeConfigs--gce_sd_configs--refresh_interval-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..gce_sd_configs..tag_separator` {services-prometheus-scrapeConfigs--gce_sd_configs--tag_separator}

The tag separator used to separate concatenated GCE instance network tags.

See the GCP documentation on network tags for more information: https://cloud.google.com/vpc/docs/add-remove-network-tags

Defaults to , in prometheus when set to null.

Type: null or string

Default {services-prometheus-scrapeConfigs--gce_sd_configs--tag_separator-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..gce_sd_configs..zone` {services-prometheus-scrapeConfigs--gce_sd_configs--zone}

`services.prometheus.scrapeConfigs..hetzner_sd_configs..authorization.type` {services-prometheus-scrapeConfigs--hetzner_sd_configs--authorization-type}

Sets the authentication type.

Defaults to Bearer in prometheus when set to null.

Type: null or string

Default {services-prometheus-scrapeConfigs--hetzner_sd_configs--authorization-type-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..hetzner_sd_configs..basic_auth` {services-prometheus-scrapeConfigs--hetzner_sd_configs--basic_auth}

Optional HTTP basic authentication information.

HTTP username

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..hetzner_sd_configs..follow_redirects` {services-prometheus-scrapeConfigs--hetzner_sd_configs--follow_redirects}

Configure whether HTTP requests follow HTTP 3xx redirects.

The port to scrape metrics from.

Defaults to 80 in prometheus when set to null.

Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default {services-prometheus-scrapeConfigs--hetzner_sd_configs--port-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..hetzner_sd_configs..proxy_url` {services-prometheus-scrapeConfigs--hetzner_sd_configs--proxy_url}

Optional proxy URL.

Type: null or string

Default {services-prometheus-scrapeConfigs--hetzner_sd_configs--proxy_url-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..hetzner_sd_configs..refresh_interval` {services-prometheus-scrapeConfigs--hetzner_sd_configs--refresh_interval}

The time after which the servers are refreshed.

Defaults to 60s in prometheus when set to null.

Type: null or string

Default {services-prometheus-scrapeConfigs--hetzner_sd_configs--refresh_interval-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..hetzner_sd_configs..role` {services-prometheus-scrapeConfigs--hetzner_sd_configs--role}

`services.prometheus.scrapeConfigs..http_sd_configs..basic_auth` {services-prometheus-scrapeConfigs--http_sd_configs--basic_auth}

Authentication information used to authenticate to the API server. password and password_file are mutually exclusive.

HTTP username

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..http_sd_configs..follow_redirects` {services-prometheus-scrapeConfigs--http_sd_configs--follow_redirects}

Configure whether HTTP requests follow HTTP 3xx redirects.

Defaults to true in prometheus when set to null.

Type: null or boolean

Default {services-prometheus-scrapeConfigs--http_sd_configs--follow_redirects-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..http_sd_configs..proxy_url` {services-prometheus-scrapeConfigs--http_sd_configs--proxy_url}

Optional proxy URL.

Type: null or string

Default {services-prometheus-scrapeConfigs--http_sd_configs--proxy_url-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..http_sd_configs..refresh_interval` {services-prometheus-scrapeConfigs--http_sd_configs--refresh_interval}

Refresh interval to re-query the endpoint.

URL from which the targets are fetched.

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs.*.job_name`

Type: null or string

Default {services-prometheus-scrapeConfigs--kubernetes_sd_configs--authorization-type-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..kubernetes_sd_configs..basic_auth` {services-prometheus-scrapeConfigs--kubernetes_sd_configs--basic_auth}

Optional HTTP basic authentication information.

HTTP username

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..kubernetes_sd_configs..follow_redirects` {services-prometheus-scrapeConfigs--kubernetes_sd_configs--follow_redirects}

Configure whether HTTP requests follow HTTP 3xx redirects.

The Kubernetes role of entities that should be discovered. One of endpoints, service, pod, node, or ingress.

Type: one of "endpoints", "service", "pod", "node", "ingress"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..kubernetes_sd_configs..selectors` {services-prometheus-scrapeConfigs--kubernetes_sd_configs--selectors}

Optional label and field selectors to limit the discovery process to a subset of available resources. See https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/ and https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ to learn more about the possible filters that can be used. Endpoints role supports pod, service and endpoints selectors, other roles only support selectors matching the role itself (e.g. node role can only contain node selectors).

`services.prometheus.scrapeConfigs..kuma_sd_configs..authorization.type` {services-prometheus-scrapeConfigs--kuma_sd_configs--authorization-type}

Sets the authentication type.

Defaults to Bearer in prometheus when set to null.

Type: null or string

Default {services-prometheus-scrapeConfigs--kuma_sd_configs--authorization-type-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..kuma_sd_configs..basic_auth` {services-prometheus-scrapeConfigs--kuma_sd_configs--basic_auth}

Optional HTTP basic authentication information.

HTTP username

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..kuma_sd_configs..fetch_timeout` {services-prometheus-scrapeConfigs--kuma_sd_configs--fetch_timeout}

The time after which the monitoring assignments are refreshed.

Defaults to 2m in prometheus when set to null.

Type: null or string

Default {services-prometheus-scrapeConfigs--kuma_sd_configs--fetch_timeout-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..kuma_sd_configs..follow_redirects` {services-prometheus-scrapeConfigs--kuma_sd_configs--follow_redirects}

Configure whether HTTP requests follow HTTP 3xx redirects.

The time to wait between polling update requests.

Defaults to 30s in prometheus when set to null.

Type: null or string

Default {services-prometheus-scrapeConfigs--kuma_sd_configs--refresh_interval-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..kuma_sd_configs..server` {services-prometheus-scrapeConfigs--kuma_sd_configs--server}

The port to scrape metrics from. If using the public IP address, this must instead be specified in the relabeling rule.

Defaults to 80 in prometheus when set to null.

Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default {services-prometheus-scrapeConfigs--lightsail_sd_configs--port-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..lightsail_sd_configs..profile` {services-prometheus-scrapeConfigs--lightsail_sd_configs--profile}

Named AWS profile used to connect to the API.

Type: null or string

Default {services-prometheus-scrapeConfigs--lightsail_sd_configs--profile-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..lightsail_sd_configs..refresh_interval` {services-prometheus-scrapeConfigs--lightsail_sd_configs--refresh_interval}

Refresh interval to re-read the instance list.

Sets the authentication type.

Defaults to Bearer in prometheus when set to null.

Type: null or string

Default {services-prometheus-scrapeConfigs--linode_sd_configs--authorization-type-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..linode_sd_configs..basic_auth` {services-prometheus-scrapeConfigs--linode_sd_configs--basic_auth}

Optional HTTP basic authentication information.

HTTP username

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..linode_sd_configs..follow_redirects` {services-prometheus-scrapeConfigs--linode_sd_configs--follow_redirects}

Configure whether HTTP requests follow HTTP 3xx redirects.

The port to scrape metrics from.

Defaults to 80 in prometheus when set to null.

Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default {services-prometheus-scrapeConfigs--linode_sd_configs--port-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

Sets the authentication type.

Defaults to Bearer in prometheus when set to null.

Type: null or string

Default {services-prometheus-scrapeConfigs--marathon_sd_configs--authorization-type-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..marathon_sd_configs..basic_auth` {services-prometheus-scrapeConfigs--marathon_sd_configs--basic_auth}

Optional HTTP basic authentication information.

HTTP username

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..marathon_sd_configs..follow_redirects` {services-prometheus-scrapeConfigs--marathon_sd_configs--follow_redirects}

Configure whether HTTP requests follow HTTP 3xx redirects.

Polling interval.

Defaults to 30s in prometheus when set to null.

Type: null or string

Default {services-prometheus-scrapeConfigs--marathon_sd_configs--refresh_interval-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..marathon_sd_configs..servers` {services-prometheus-scrapeConfigs--marathon_sd_configs--servers}

`services.prometheus.scrapeConfigs..metric_relabel_configs..action` {services-prometheus-scrapeConfigs--metric_relabel_configs--action}

Action to perform based on regex matching.

Defaults to replace in prometheus when set to null.

Type: null or one of "replace", "lowercase", "uppercase", "keep", "drop", "hashmod", "labelmap", "labeldrop", "labelkeep"

Default {services-prometheus-scrapeConfigs--metric_relabel_configs--action-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

The HTTP resource path on which to fetch metrics from targets.

Defaults to /metrics in prometheus when set to null.

Type: null or string

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs.*.nerve_sd_configs`

List of AirBnB's Nerve service discovery configurations.

Type: null or (list of (submodule))

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..nerve_sd_configs..paths` {services-prometheus-scrapeConfigs--nerve_sd_configs--paths}

Paths can point to a single service, or the root of a tree of services.

Type: list of string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..nerve_sd_configs..servers` {services-prometheus-scrapeConfigs--nerve_sd_configs--servers}

The Zookeeper servers.

Type: list of string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..nerve_sd_configs..timeout` {services-prometheus-scrapeConfigs--nerve_sd_configs--timeout}

Timeout value.

Defaults to 10s in prometheus when set to null.

Type: null or string

Default {services-prometheus-scrapeConfigs--nerve_sd_configs--timeout-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs.*.openstack_sd_configs`

List of OpenStack service discovery configurations.

Type: null or (list of (submodule))

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..openstack_sd_configs..all_tenants` {services-prometheus-scrapeConfigs--openstack_sd_configs--all_tenants}

Whether the service discovery should list all instances for all projects. It is only relevant for the 'instance' role and usually requires admin permissions.

The availability of the endpoint to connect to. Must be one of public, admin or internal.

The port to scrape metrics from. If using the public IP address, this must instead be specified in the relabeling rule.

Refresh interval to re-read the instance list.

Defaults to 60s in prometheus when set to null.

Type: null or string

Default {services-prometheus-scrapeConfigs--openstack_sd_configs--refresh_interval-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..openstack_sd_configs..region` {services-prometheus-scrapeConfigs--openstack_sd_configs--region}

The OpenStack Region.

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..openstack_sd_configs..role` {services-prometheus-scrapeConfigs--openstack_sd_configs--role}

Type: null or string

Default {services-prometheus-scrapeConfigs--puppetdb_sd_configs--authorization-type-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..puppetdb_sd_configs..basic_auth` {services-prometheus-scrapeConfigs--puppetdb_sd_configs--basic_auth}

Optional HTTP basic authentication information.

HTTP username

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..puppetdb_sd_configs..follow_redirects` {services-prometheus-scrapeConfigs--puppetdb_sd_configs--follow_redirects}

Configure whether HTTP requests follow HTTP 3xx redirects.

Defaults to true in prometheus when set to null.

Type: null or boolean

Default {services-prometheus-scrapeConfigs--puppetdb_sd_configs--follow_redirects-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..puppetdb_sd_configs..include_parameters` {services-prometheus-scrapeConfigs--puppetdb_sd_configs--include_parameters}

Whether to include the parameters as meta labels. Due to the differences between parameter types and Prometheus labels, some parameters might not be rendered. The format of the parameters might also change in future releases.

Note: Enabling this exposes parameters in the Prometheus UI and API. Make sure that you don't have secrets exposed as parameters if you enable this.

The port to scrape metrics from.

Defaults to 80 in prometheus when set to null.

Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default {services-prometheus-scrapeConfigs--puppetdb_sd_configs--port-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..puppetdb_sd_configs..proxy_url` {services-prometheus-scrapeConfigs--puppetdb_sd_configs--proxy_url}

Optional proxy URL.

Type: null or string

Default {services-prometheus-scrapeConfigs--puppetdb_sd_configs--proxy_url-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..puppetdb_sd_configs..query` {services-prometheus-scrapeConfigs--puppetdb_sd_configs--query}

Puppet Query Language (PQL) query. Only resources are supported. https://puppet.com/docs/puppetdb/latest/api/query/v4/pql.html

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..puppetdb_sd_configs..refresh_interval` {services-prometheus-scrapeConfigs--puppetdb_sd_configs--refresh_interval}

Refresh interval to re-read the resources list.

The URL of the PuppetDB root query endpoint.

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs.*.relabel_configs`

List of relabel configurations.

Type: null or (list of (submodule))

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..relabel_configs..action` {services-prometheus-scrapeConfigs--relabel_configs--action}

Action to perform based on regex matching.

Defaults to replace in prometheus when set to null.

Type: null or one of "replace", "lowercase", "uppercase", "keep", "drop", "hashmod", "labelmap", "labeldrop", "labelkeep"

Default {services-prometheus-scrapeConfigs--relabel_configs--action-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

Per-scrape limit on number of scraped samples that will be accepted. If more than this number of samples are present after metric relabelling the entire scrape will be treated as failed. 0 means no limit.

Defaults to 0 in prometheus when set to null.

Type: null or signed integer

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs.*.scaleway_sd_configs`

List of Scaleway service discovery configurations.

Type: null or (list of (submodule))

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..scaleway_sd_configs..access_key` {services-prometheus-scrapeConfigs--scaleway_sd_configs--access_key}

Access key to use. https://console.scaleway.com/project/credentials

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..scaleway_sd_configs..api_url` {services-prometheus-scrapeConfigs--scaleway_sd_configs--api_url}

API URL to use when doing the server listing requests.

Defaults to https://api.scaleway.com in prometheus when set to null.

Type: null or string

Default {services-prometheus-scrapeConfigs--scaleway_sd_configs--api_url-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..scaleway_sd_configs..follow_redirects` {services-prometheus-scrapeConfigs--scaleway_sd_configs--follow_redirects}

Configure whether HTTP requests follow HTTP 3xx redirects.

Defaults to true in prometheus when set to null.

Type: null or boolean

Default {services-prometheus-scrapeConfigs--scaleway_sd_configs--follow_redirects-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..scaleway_sd_configs..name_filter` {services-prometheus-scrapeConfigs--scaleway_sd_configs--name_filter}

Specify a name filter (works as a LIKE) to apply on the server listing request.

Type: null or string

Default {services-prometheus-scrapeConfigs--scaleway_sd_configs--name_filter-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..scaleway_sd_configs..port` {services-prometheus-scrapeConfigs--scaleway_sd_configs--port}

The port to scrape metrics from.

Defaults to 80 in prometheus when set to null.

Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default {services-prometheus-scrapeConfigs--scaleway_sd_configs--port-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..scaleway_sd_configs..project_id` {services-prometheus-scrapeConfigs--scaleway_sd_configs--project_id}

Project ID of the targets.

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..scaleway_sd_configs..proxy_url` {services-prometheus-scrapeConfigs--scaleway_sd_configs--proxy_url}

Optional proxy URL.

Type: null or string

Default {services-prometheus-scrapeConfigs--scaleway_sd_configs--proxy_url-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..scaleway_sd_configs..refresh_interval` {services-prometheus-scrapeConfigs--scaleway_sd_configs--refresh_interval}

Refresh interval to re-read the managed targets list.

Defaults to 60s in prometheus when set to null.

Type: null or string

Default {services-prometheus-scrapeConfigs--scaleway_sd_configs--refresh_interval-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..scaleway_sd_configs..role` {services-prometheus-scrapeConfigs--scaleway_sd_configs--role}

Paths can point to a single service, or the root of a tree of services.

Type: list of string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..serverset_sd_configs..servers` {services-prometheus-scrapeConfigs--serverset_sd_configs--servers}

The Zookeeper servers.

Type: list of string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..serverset_sd_configs..timeout` {services-prometheus-scrapeConfigs--serverset_sd_configs--timeout}

Timeout value.

Defaults to 10s in prometheus when set to null.

Type: null or string

Default {services-prometheus-scrapeConfigs--serverset_sd_configs--timeout-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs.*.static_configs`

List of labeled target groups for this job.

Type: null or (list of (submodule))

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..static_configs..labels` {services-prometheus-scrapeConfigs--static_configs--labels}

Labels assigned to all metrics scraped from the targets.

Type: attribute set of string

Default {services-prometheus-scrapeConfigs--static_configs--labels-default}

{ }

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..static_configs..targets` {services-prometheus-scrapeConfigs--static_configs--targets}

The targets specified by the target group.

Type: list of string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs.*.target_limit`

Per-scrape config limit on number of unique targets that will be accepted. If more than this number of targets are present after target relabeling, Prometheus will mark the targets as failed without scraping them. 0 means no limit. This is an experimental feature, this behaviour could change in the future.

The account to use for discovering new targets.

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..triton_sd_configs..dns_suffix` {services-prometheus-scrapeConfigs--triton_sd_configs--dns_suffix}

The DNS suffix which should be applied to target.

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..triton_sd_configs..endpoint` {services-prometheus-scrapeConfigs--triton_sd_configs--endpoint}

The Triton discovery endpoint (e.g. cmon.us-east-3b.triton.zone). This is often the same value as dns_suffix.

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

The Triton discovery API version.

Sets the authentication type.

Defaults to Bearer in prometheus when set to null.

Type: null or string

Default {services-prometheus-scrapeConfigs--uyuni_sd_configs--authorization-type-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..uyuni_sd_configs..basic_auth` {services-prometheus-scrapeConfigs--uyuni_sd_configs--basic_auth}

Optional HTTP basic authentication information.

HTTP username

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..uyuni_sd_configs..entitlement` {services-prometheus-scrapeConfigs--uyuni_sd_configs--entitlement}

The entitlement string to filter eligible systems.

Defaults to monitoring_entitled in prometheus when set to null.

Type: null or string

Default {services-prometheus-scrapeConfigs--uyuni_sd_configs--entitlement-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..uyuni_sd_configs..follow_redirects` {services-prometheus-scrapeConfigs--uyuni_sd_configs--follow_redirects}

Configure whether HTTP requests follow HTTP 3xx redirects.

Credentials are used to authenticate the requests to Uyuni API.

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..uyuni_sd_configs..proxy_url` {services-prometheus-scrapeConfigs--uyuni_sd_configs--proxy_url}

Optional proxy URL.

Type: null or string

Default {services-prometheus-scrapeConfigs--uyuni_sd_configs--proxy_url-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..uyuni_sd_configs..refresh_interval` {services-prometheus-scrapeConfigs--uyuni_sd_configs--refresh_interval}

Refresh interval to re-read the managed targets list.

Defaults to 60s in prometheus when set to null.

Type: null or string

Default {services-prometheus-scrapeConfigs--uyuni_sd_configs--refresh_interval-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..uyuni_sd_configs..separator` {services-prometheus-scrapeConfigs--uyuni_sd_configs--separator}

The string by which Uyuni group names are joined into the groups label

Defaults to , in prometheus when set to null.

Type: null or string

Default {services-prometheus-scrapeConfigs--uyuni_sd_configs--separator-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..uyuni_sd_configs..server` {services-prometheus-scrapeConfigs--uyuni_sd_configs--server}

Default {services-prometheus-scrapeConfigs--uyuni_sd_configs--tls_config-server_name-default}

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.scrapeConfigs..uyuni_sd_configs..username` {services-prometheus-scrapeConfigs--uyuni_sd_configs--username}

Credentials are used to authenticate the requests to Uyuni API.

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

"https://example.com/"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/default.nix

`services.prometheus.xmpp-alerts.enable`

Whether to enable XMPP Web hook service for Alertmanager. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/xmpp-alerts.nix

`services.prometheus.xmpp-alerts.settings`

Configuration for prometheus xmpp-alerts, see https://github.com/jelmer/prometheus-xmpp-alerts/blob/master/xmpp-alerts.yml.example for supported values.

Type: YAML value

Default

{ }

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/monitoring/prometheus/xmpp-alerts.nix