diff options
Diffstat (limited to 'nixos/modules/services/monitoring')
10 files changed, 30 insertions, 38 deletions
diff --git a/nixos/modules/services/monitoring/cadvisor.nix b/nixos/modules/services/monitoring/cadvisor.nix index c844b1599dd46..7374b1ece4953 100644 --- a/nixos/modules/services/monitoring/cadvisor.nix +++ b/nixos/modules/services/monitoring/cadvisor.nix @@ -75,7 +75,7 @@ in { world-readable Nix store that contains the value of <option>storageDriverPassword</option>. It's recommended to override this with a path not in the Nix store. - Tip: use <link xlink:href='https://nixos.org/nixops/manual/#idm140737318306400'>nixops key management</link> + Tip: use <link xlink:href="https://nixos.org/nixops/manual/#idm140737318306400">nixops key management</link> ''; }; @@ -91,7 +91,7 @@ in { description = '' Additional cadvisor options. - See <link xlink:href='https://github.com/google/cadvisor/blob/master/docs/runtime_options.md'/> for available options. + See <link xlink:href="https://github.com/google/cadvisor/blob/master/docs/runtime_options.md"/> for available options. ''; }; }; diff --git a/nixos/modules/services/monitoring/grafana-image-renderer.nix b/nixos/modules/services/monitoring/grafana-image-renderer.nix index 97488f2653a5b..4820b19469875 100644 --- a/nixos/modules/services/monitoring/grafana-image-renderer.nix +++ b/nixos/modules/services/monitoring/grafana-image-renderer.nix @@ -92,7 +92,7 @@ in { description = '' Configuration attributes for <package>grafana-image-renderer</package>. - See <link xlink:href="https://github.com/grafana/grafana-image-renderer/blob/ce1f81438e5f69c7fd7c73ce08bab624c4c92e25/default.json" /> + See <link xlink:href="https://github.com/grafana/grafana-image-renderer/blob/ce1f81438e5f69c7fd7c73ce08bab624c4c92e25/default.json"/> for supported values. ''; }; diff --git a/nixos/modules/services/monitoring/graphite.nix b/nixos/modules/services/monitoring/graphite.nix index 73b509202df66..0905b4b57fb96 100644 --- a/nixos/modules/services/monitoring/graphite.nix +++ b/nixos/modules/services/monitoring/graphite.nix @@ -253,7 +253,7 @@ in { default = {}; description = '' Extra seyren configuration. See - <link xlink:href='https://github.com/scobal/seyren#config' /> + <link xlink:href="https://github.com/scobal/seyren#config"/> ''; type = types.attrsOf types.str; example = literalExpression '' diff --git a/nixos/modules/services/monitoring/munin.nix b/nixos/modules/services/monitoring/munin.nix index c77ae7b3b6eb2..3455d0d3d4a6f 100644 --- a/nixos/modules/services/monitoring/munin.nix +++ b/nixos/modules/services/monitoring/munin.nix @@ -142,7 +142,7 @@ in Enable Munin Node agent. Munin node listens on 0.0.0.0 and by default accepts connections only from 127.0.0.1 for security reasons. - See <link xlink:href='http://guide.munin-monitoring.org/en/latest/architecture/index.html' />. + See <link xlink:href="http://guide.munin-monitoring.org/en/latest/architecture/index.html"/>. ''; }; @@ -151,7 +151,7 @@ in type = types.lines; description = '' <filename>munin-node.conf</filename> extra configuration. See - <link xlink:href='http://guide.munin-monitoring.org/en/latest/reference/munin-node.conf.html' /> + <link xlink:href="http://guide.munin-monitoring.org/en/latest/reference/munin-node.conf.html"/> ''; }; @@ -160,7 +160,7 @@ in type = types.lines; description = '' <filename>plugin-conf.d</filename> extra plugin configuration. See - <link xlink:href='http://guide.munin-monitoring.org/en/latest/plugin/use.html' /> + <link xlink:href="http://guide.munin-monitoring.org/en/latest/plugin/use.html"/> ''; example = '' [fail2ban_*] @@ -268,9 +268,9 @@ in type = types.lines; description = '' <filename>munin.conf</filename> extra global configuration. - See <link xlink:href='http://guide.munin-monitoring.org/en/latest/reference/munin.conf.html' />. + See <link xlink:href="http://guide.munin-monitoring.org/en/latest/reference/munin.conf.html"/>. Useful to setup notifications, see - <link xlink:href='http://guide.munin-monitoring.org/en/latest/tutorial/alert.html' /> + <link xlink:href="http://guide.munin-monitoring.org/en/latest/tutorial/alert.html"/> ''; example = '' contact.email.command mail -s "Munin notification for ''${var:host}" someone@example.com @@ -283,7 +283,7 @@ in description = '' Definitions of hosts of nodes to collect data from. Needs at least one host for cron to succeed. See - <link xlink:href='http://guide.munin-monitoring.org/en/latest/reference/munin.conf.html' /> + <link xlink:href="http://guide.munin-monitoring.org/en/latest/reference/munin.conf.html"/> ''; example = literalExpression '' ''' diff --git a/nixos/modules/services/monitoring/nagios.nix b/nixos/modules/services/monitoring/nagios.nix index 69173ce4e44ed..a17797f682f8b 100644 --- a/nixos/modules/services/monitoring/nagios.nix +++ b/nixos/modules/services/monitoring/nagios.nix @@ -88,7 +88,7 @@ in options = { services.nagios = { - enable = mkEnableOption "<link xlink:href='http://www.nagios.org/'>Nagios</link> to monitor your system or network."; + enable = mkEnableOption ''<link xlink:href="http://www.nagios.org/">Nagios</link> to monitor your system or network.''; objectDefs = mkOption { description = " diff --git a/nixos/modules/services/monitoring/parsedmarc.nix b/nixos/modules/services/monitoring/parsedmarc.nix index 736718c25359c..60ebbd6f75258 100644 --- a/nixos/modules/services/monitoring/parsedmarc.nix +++ b/nixos/modules/services/monitoring/parsedmarc.nix @@ -69,14 +69,12 @@ in type = lib.types.bool; default = true; description = '' - Whether to enable and configure the <link - linkend="opt-services.geoipupdate.enable">geoipupdate</link> + Whether to enable and configure the <link linkend="opt-services.geoipupdate.enable">geoipupdate</link> service to automatically fetch GeoIP databases. Not crucial, but recommended for full functionality. - To finish the setup, you need to manually set the <xref - linkend="opt-services.geoipupdate.settings.AccountID" /> and - <xref linkend="opt-services.geoipupdate.settings.LicenseKey" /> + To finish the setup, you need to manually set the <xref linkend="opt-services.geoipupdate.settings.AccountID"/> and + <xref linkend="opt-services.geoipupdate.settings.LicenseKey"/> options. ''; }; @@ -101,7 +99,7 @@ in Whether the automatically provisioned Elasticsearch instance should be added as a grafana datasource. Has no effect unless - <xref linkend="opt-services.parsedmarc.provision.elasticsearch" /> + <xref linkend="opt-services.parsedmarc.provision.elasticsearch"/> is also enabled. ''; }; @@ -213,8 +211,7 @@ in Always handled as a secret whether the value is wrapped in a <literal>{ _secret = ...; }</literal> - attrset or not (refer to <xref - linkend="opt-services.parsedmarc.settings" /> for + attrset or not (refer to <xref linkend="opt-services.parsedmarc.settings"/> for details). ''; apply = x: if isAttrs x || x == null then x else { _secret = x; }; @@ -278,8 +275,7 @@ in Always handled as a secret whether the value is wrapped in a <literal>{ _secret = ...; }</literal> - attrset or not (refer to <xref - linkend="opt-services.parsedmarc.settings" /> for + attrset or not (refer to <xref linkend="opt-services.parsedmarc.settings"/> for details). ''; apply = x: if isAttrs x || x == null then x else { _secret = x; }; @@ -332,8 +328,7 @@ in Always handled as a secret whether the value is wrapped in a <literal>{ _secret = ...; }</literal> - attrset or not (refer to <xref - linkend="opt-services.parsedmarc.settings" /> for + attrset or not (refer to <xref linkend="opt-services.parsedmarc.settings"/> for details). ''; apply = x: if isAttrs x || x == null then x else { _secret = x; }; diff --git a/nixos/modules/services/monitoring/prometheus/default.nix b/nixos/modules/services/monitoring/prometheus/default.nix index db4286b66a5d3..3bc61fba158f3 100644 --- a/nixos/modules/services/monitoring/prometheus/default.nix +++ b/nixos/modules/services/monitoring/prometheus/default.nix @@ -379,9 +379,8 @@ let gce_sd_configs = mkOpt (types.listOf promTypes.gce_sd_config) '' List of Google Compute Engine service discovery configurations. - See <link - xlink:href="https://prometheus.io/docs/prometheus/latest/configuration/configuration/#gce_sd_config">the - relevant Prometheus configuration docs</link> for more detail. + See <link xlink:href="https://prometheus.io/docs/prometheus/latest/configuration/configuration/#gce_sd_config">the relevant Prometheus configuration docs</link> + for more detail. ''; hetzner_sd_configs = mkOpt (types.listOf promTypes.hetzner_sd_config) '' @@ -807,9 +806,7 @@ let filter = mkOpt types.str '' 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: <link - xlink:href="https://cloud.google.com/compute/docs/reference/latest/instances/list" - />. + query parameter section: <link xlink:href="https://cloud.google.com/compute/docs/reference/latest/instances/list"/>. ''; refresh_interval = mkDefOpt types.str "60s" '' @@ -825,7 +822,7 @@ let The tag separator used to separate concatenated GCE instance network tags. See the GCP documentation on network tags for more information: - <link xlink:href="https://cloud.google.com/vpc/docs/add-remove-network-tags" /> + <link xlink:href="https://cloud.google.com/vpc/docs/add-remove-network-tags"/> ''; }; }; @@ -1033,13 +1030,13 @@ let auth_token = mkOpt types.str '' Optional authentication information for token-based authentication: - <link xlink:href="https://docs.mesosphere.com/1.11/security/ent/iam-api/#passing-an-authentication-token" /> + <link xlink:href="https://docs.mesosphere.com/1.11/security/ent/iam-api/#passing-an-authentication-token"/> It is mutually exclusive with <literal>auth_token_file</literal> and other authentication mechanisms. ''; auth_token_file = mkOpt types.str '' Optional authentication information for token-based authentication: - <link xlink:href="https://docs.mesosphere.com/1.11/security/ent/iam-api/#passing-an-authentication-token" /> + <link xlink:href="https://docs.mesosphere.com/1.11/security/ent/iam-api/#passing-an-authentication-token"/> It is mutually exclusive with <literal>auth_token</literal> and other authentication mechanisms. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/dovecot.nix b/nixos/modules/services/monitoring/prometheus/exporters/dovecot.nix index 092ac6fea7d74..4e7aae0b34b59 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/dovecot.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/dovecot.nix @@ -33,10 +33,10 @@ in work with this exporter: <programlisting> { - <xref linkend="opt-services.prometheus.exporters.dovecot.enable" /> = true; - <xref linkend="opt-services.prometheus.exporters.dovecot.socketPath" /> = "/var/run/dovecot2/old-stats"; - <xref linkend="opt-services.dovecot2.mailPlugins.globally.enable" /> = [ "old_stats" ]; - <xref linkend="opt-services.dovecot2.extraConfig" /> = ''' + <xref linkend="opt-services.prometheus.exporters.dovecot.enable"/> = true; + <xref linkend="opt-services.prometheus.exporters.dovecot.socketPath"/> = "/var/run/dovecot2/old-stats"; + <xref linkend="opt-services.dovecot2.mailPlugins.globally.enable"/> = [ "old_stats" ]; + <xref linkend="opt-services.dovecot2.extraConfig"/> = ''' service old-stats { unix_listener old-stats { user = dovecot-exporter diff --git a/nixos/modules/services/monitoring/prometheus/exporters/process.nix b/nixos/modules/services/monitoring/prometheus/exporters/process.nix index 1e9c402fb55bd..666116991b5a9 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/process.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/process.nix @@ -22,7 +22,7 @@ in All settings expressed as an Nix attrset. Check the official documentation for the corresponding YAML - settings that can all be used here: <link xlink:href="https://github.com/ncabatoff/process-exporter" /> + settings that can all be used here: <link xlink:href="https://github.com/ncabatoff/process-exporter"/> ''; }; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/script.nix b/nixos/modules/services/monitoring/prometheus/exporters/script.nix index a805a0ad335d2..2a43fbcab3a10 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/script.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/script.nix @@ -41,7 +41,7 @@ in All settings expressed as an Nix attrset. Check the official documentation for the corresponding YAML - settings that can all be used here: <link xlink:href="https://github.com/adhocteam/script_exporter#sample-configuration" /> + settings that can all be used here: <link xlink:href="https://github.com/adhocteam/script_exporter#sample-configuration"/> ''; }; }; |