commit ce319f60ad515fd0991e33f91af68aec530228c8 · pyrox.dev/nixpkgs

+180

nixos/modules/services/monitoring/prometheus/exporters.md

···

       1
       +
       # Prometheus exporters {#module-services-prometheus-exporters}

     

       2
       +
       

     

       3
       +
       Prometheus exporters provide metrics for the

     

       4
       +
       [prometheus monitoring system](https://prometheus.io).

     

       5
       +
       

     

       6
       +
       ## Configuration {#module-services-prometheus-exporters-configuration}

     

       7
       +
       

     

       8
       +
       One of the most common exporters is the

     

       9
       +
       [node exporter](https://github.com/prometheus/node_exporter),

     

       10
       +
       it provides hardware and OS metrics from the host it's

     

       11
       +
       running on. The exporter could be configured as follows:

     

       12
       +
       ```

     

       13
       +
         services.prometheus.exporters.node = {

     

       14
       +
           enable = true;

     

       15
       +
           port = 9100;

     

       16
       +
           enabledCollectors = [

     

       17
       +
             "logind"

     

       18
       +
             "systemd"

     

       19
       +
           ];

     

       20
       +
           disabledCollectors = [

     

       21
       +
             "textfile"

     

       22
       +
           ];

     

       23
       +
           openFirewall = true;

     

       24
       +
           firewallFilter = "-i br0 -p tcp -m tcp --dport 9100";

     

       25
       +
         };

     

       26
       +
       ```

     

       27
       +
       It should now serve all metrics from the collectors that are explicitly

     

       28
       +
       enabled and the ones that are

     

       29
       +
       [enabled by default](https://github.com/prometheus/node_exporter#enabled-by-default),

     

       30
       +
       via http under `/metrics`. In this

     

       31
       +
       example the firewall should just allow incoming connections to the

     

       32
       +
       exporter's port on the bridge interface `br0` (this would

     

       33
       +
       have to be configured separately of course). For more information about

     

       34
       +
       configuration see `man configuration.nix` or search through

     

       35
       +
       the [available options](https://nixos.org/nixos/options.html#prometheus.exporters).

     

       36
       +
       

     

       37
       +
       Prometheus can now be configured to consume the metrics produced by the exporter:

     

       38
       +
       ```

     

       39
       +
           services.prometheus = {

     

       40
       +
             # ...

     

       41
       +
       

     

       42
       +
             scrapeConfigs = [

     

       43
       +
               {

     

       44
       +
                 job_name = "node";

     

       45
       +
                 static_configs = [{

     

       46
       +
                   targets = [ "localhost:${toString config.services.prometheus.exporters.node.port}" ];

     

       47
       +
                 }];

     

       48
       +
               }

     

       49
       +
             ];

     

       50
       +
       

     

       51
       +
             # ...

     

       52
       +
           }

     

       53
       +
       ```

     

       54
       +
       

     

       55
       +
       ## Adding a new exporter {#module-services-prometheus-exporters-new-exporter}

     

       56
       +
       

     

       57
       +
       To add a new exporter, it has to be packaged first (see

     

       58
       +
       `nixpkgs/pkgs/servers/monitoring/prometheus/` for

     

       59
       +
       examples), then a module can be added. The postfix exporter is used in this

     

       60
       +
       example:

     

       61
       +
       

     

       62
       +
         - Some default options for all exporters are provided by

     

       63
       +
           `nixpkgs/nixos/modules/services/monitoring/prometheus/exporters.nix`:

     

       64
       +
       

     

       65
       +
             - `enable`

     

       66
       +
             - `port`

     

       67
       +
             - `listenAddress`

     

       68
       +
             - `extraFlags`

     

       69
       +
             - `openFirewall`

     

       70
       +
             - `firewallFilter`

     

       71
       +
             - `user`

     

       72
       +
             - `group`

     

       73
       +
         - As there is already a package available, the module can now be added. This

     

       74
       +
           is accomplished by adding a new file to the

     

       75
       +
           `nixos/modules/services/monitoring/prometheus/exporters/`

     

       76
       +
           directory, which will be called postfix.nix and contains all exporter

     

       77
       +
           specific options and configuration:

     

       78
       +
           ```

     

       79
       +
           # nixpgs/nixos/modules/services/prometheus/exporters/postfix.nix

     

       80
       +
           { config, lib, pkgs, options }:

     

       81
       +
       

     

       82
       +
           with lib;

     

       83
       +
       

     

       84
       +
           let

     

       85
       +
             # for convenience we define cfg here

     

       86
       +
             cfg = config.services.prometheus.exporters.postfix;

     

       87
       +
           in

     

       88
       +
           {

     

       89
       +
             port = 9154; # The postfix exporter listens on this port by default

     

       90
       +
       

     

       91
       +
             # `extraOpts` is an attribute set which contains additional options

     

       92
       +
             # (and optional overrides for default options).

     

       93
       +
             # Note that this attribute is optional.

     

       94
       +
             extraOpts = {

     

       95
       +
               telemetryPath = mkOption {

     

       96
       +
                 type = types.str;

     

       97
       +
                 default = "/metrics";

     

       98
       +
                 description = ''

     

       99
       +
                   Path under which to expose metrics.

     

       100
       +
                 '';

     

       101
       +
               };

     

       102
       +
               logfilePath = mkOption {

     

       103
       +
                 type = types.path;

     

       104
       +
                 default = /var/log/postfix_exporter_input.log;

     

       105
       +
                 example = /var/log/mail.log;

     

       106
       +
                 description = ''

     

       107
       +
                   Path where Postfix writes log entries.

     

       108
       +
                   This file will be truncated by this exporter!

     

       109
       +
                 '';

     

       110
       +
               };

     

       111
       +
               showqPath = mkOption {

     

       112
       +
                 type = types.path;

     

       113
       +
                 default = /var/spool/postfix/public/showq;

     

       114
       +
                 example = /var/lib/postfix/queue/public/showq;

     

       115
       +
                 description = ''

     

       116
       +
                   Path at which Postfix places its showq socket.

     

       117
       +
                 '';

     

       118
       +
               };

     

       119
       +
             };

     

       120
       +
       

     

       121
       +
             # `serviceOpts` is an attribute set which contains configuration

     

       122
       +
             # for the exporter's systemd service. One of

     

       123
       +
             # `serviceOpts.script` and `serviceOpts.serviceConfig.ExecStart`

     

       124
       +
             # has to be specified here. This will be merged with the default

     

       125
       +
             # service configuration.

     

       126
       +
             # Note that by default 'DynamicUser' is 'true'.

     

       127
       +
             serviceOpts = {

     

       128
       +
               serviceConfig = {

     

       129
       +
                 DynamicUser = false;

     

       130
       +
                 ExecStart = ''

     

       131
       +
                   ${pkgs.prometheus-postfix-exporter}/bin/postfix_exporter \

     

       132
       +
                     --web.listen-address ${cfg.listenAddress}:${toString cfg.port} \

     

       133
       +
                     --web.telemetry-path ${cfg.telemetryPath} \

     

       134
       +
                     ${concatStringsSep " \\\n  " cfg.extraFlags}

     

       135
       +
                 '';

     

       136
       +
               };

     

       137
       +
             };

     

       138
       +
           }

     

       139
       +
           ```

     

       140
       +
         - This should already be enough for the postfix exporter. Additionally one

     

       141
       +
           could now add assertions and conditional default values. This can be done

     

       142
       +
           in the 'meta-module' that combines all exporter definitions and generates

     

       143
       +
           the submodules:

     

       144
       +
           `nixpkgs/nixos/modules/services/prometheus/exporters.nix`

     

       145
       +
       

     

       146
       +
       ## Updating an exporter module {#module-services-prometheus-exporters-update-exporter-module}

     

       147
       +
       

     

       148
       +
       Should an exporter option change at some point, it is possible to add

     

       149
       +
       information about the change to the exporter definition similar to

     

       150
       +
       `nixpkgs/nixos/modules/rename.nix`:

     

       151
       +
       ```

     

       152
       +
       { config, lib, pkgs, options }:

     

       153
       +
       

     

       154
       +
       with lib;

     

       155
       +
       

     

       156
       +
       let

     

       157
       +
         cfg = config.services.prometheus.exporters.nginx;

     

       158
       +
       in

     

       159
       +
       {

     

       160
       +
         port = 9113;

     

       161
       +
         extraOpts = {

     

       162
       +
           # additional module options

     

       163
       +
           # ...

     

       164
       +
         };

     

       165
       +
         serviceOpts = {

     

       166
       +
           # service configuration

     

       167
       +
           # ...

     

       168
       +
         };

     

       169
       +
         imports = [

     

       170
       +
           # 'services.prometheus.exporters.nginx.telemetryEndpoint' -> 'services.prometheus.exporters.nginx.telemetryPath'

     

       171
       +
           (mkRenamedOptionModule [ "telemetryEndpoint" ] [ "telemetryPath" ])

     

       172
       +
       

     

       173
       +
           # removed option 'services.prometheus.exporters.nginx.insecure'

     

       174
       +
           (mkRemovedOptionModule [ "insecure" ] ''

     

       175
       +
             This option was replaced by 'prometheus.exporters.nginx.sslVerify' which defaults to true.

     

       176
       +
           '')

     

       177
       +
           ({ options.warnings = options.warnings; })

     

       178
       +
         ];

     

       179
       +
       }

     

       180
       +
       ```

nixos/modules/services/monitoring/prometheus/exporters.nix

···

       323
        
         );

     

       324
        
       

     

       325
        
         meta = {

     

       0
        
       
     

       0
        
       
     

       326
        
           doc = ./exporters.xml;

     

       327
        
           maintainers = [ maintainers.willibutz ];

     

       328
        
         };

···

       323
        
         );

     

       324
        
       

     

       325
        
         meta = {

     

       326
       +
           # Don't edit the docbook xml directly, edit the md and generate it:

     

       327
       +
           # `pandoc exporters.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart --lua-filter ../../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > exporters.xml`

     

       328
        
           doc = ./exporters.xml;

     

       329
        
           maintainers = [ maintainers.willibutz ];

     

       330
        
         };

+127 -132

nixos/modules/services/monitoring/prometheus/exporters.xml

···

       1
       -
       <chapter xmlns="http://docbook.org/ns/docbook"

     

       2
       -
                xmlns:xlink="http://www.w3.org/1999/xlink"

     

       3
       -
                xmlns:xi="http://www.w3.org/2001/XInclude"

     

       4
       -
                version="5.0"

     

       5
       -
                xml:id="module-services-prometheus-exporters">

     

       6
       -
        <title>Prometheus exporters</title>

     

       7
       -
        <para>

     

       8
       -
         Prometheus exporters provide metrics for the

     

       9
       -
         <link xlink:href="https://prometheus.io">prometheus monitoring system</link>.

     

       10
       -
        </para>

     

       11
       -
        <section xml:id="module-services-prometheus-exporters-configuration">

     

       12
       -
         <title>Configuration</title>

     

       13
       -
       

     

       14
        
         <para>

     

       15
       -
          One of the most common exporters is the

     

       16
       -
          <link xlink:href="https://github.com/prometheus/node_exporter">node

     

       17
       -
          exporter</link>, it provides hardware and OS metrics from the host it's

     

       18
       -
          running on. The exporter could be configured as follows:

     

       19
       -
       <programlisting>

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       20
        
         services.prometheus.exporters.node = {

     

       21
        
           enable = true;

     

       22
        
           port = 9100;

     

       23
        
           enabledCollectors = [

     

       24
       -
             "logind"

     

       25
       -
             "systemd"

     

       26
        
           ];

     

       27
        
           disabledCollectors = [

     

       28
       -
             "textfile"

     

       29
        
           ];

     

       30
        
           openFirewall = true;

     

       31
       -
           firewallFilter = "-i br0 -p tcp -m tcp --dport 9100";

     

       32
        
         };

     

       33
        
       </programlisting>

     

       34
       -
          It should now serve all metrics from the collectors that are explicitly

     

       35
       -
          enabled and the ones that are

     

       36
       -
          <link xlink:href="https://github.com/prometheus/node_exporter#enabled-by-default">enabled

     

       37
       -
          by default</link>, via http under <literal>/metrics</literal>. In this

     

       38
       -
          example the firewall should just allow incoming connections to the

     

       39
       -
          exporter's port on the bridge interface <literal>br0</literal> (this would

     

       40
       -
          have to be configured separately of course). For more information about

     

       41
       -
          configuration see <literal>man configuration.nix</literal> or search through

     

       42
       -
          the

     

       43
       -
          <link xlink:href="https://nixos.org/nixos/options.html#prometheus.exporters">available

     

       44
       -
          options</link>.

     

       45
       -
         </para>

     

       46
       -
       

     

       47
       -
         <para>

     

       48
       -
           Prometheus can now be configured to consume the metrics produced by the exporter:

     

       0
        
       
     

       0
        
       
     

       49
        
           <programlisting>

     

       50
        
           services.prometheus = {

     

       51
        
             # ...

     

       52
        
       

     

       53
        
             scrapeConfigs = [

     

       54
        
               {

     

       55
       -
                 job_name = "node";

     

       56
        
                 static_configs = [{

     

       57
       -
                   targets = [ "localhost:${toString config.services.prometheus.exporters.node.port}" ];

     

       58
        
                 }];

     

       59
        
               }

     

       60
        
             ];

     

       61
        
       

     

       62
        
             # ...

     

       63
        
           }

     

       64
       -
           </programlisting>

     

       65
       -
         </para>

     

       66
       -
        </section>

     

       67
       -
        <section xml:id="module-services-prometheus-exporters-new-exporter">

     

       68
       -
         <title>Adding a new exporter</title>

     

       69
       -
       

     

       70
       -
         <para>

     

       71
       -
          To add a new exporter, it has to be packaged first (see

     

       72
       -
          <literal>nixpkgs/pkgs/servers/monitoring/prometheus/</literal> for

     

       73
       -
          examples), then a module can be added. The postfix exporter is used in this

     

       74
       -
          example:

     

       75
       -
         </para>

     

       76
       -
       

     

       77
       -
         <itemizedlist>

     

       78
       -
          <listitem>

     

       79
        
           <para>

     

       80
       -
            Some default options for all exporters are provided by

     

       81
       -
            <literal>nixpkgs/nixos/modules/services/monitoring/prometheus/exporters.nix</literal>:

     

       0
        
       
     

       0
        
       
     

       82
        
           </para>

     

       83
       -
          </listitem>

     

       84
       -
          <listitem override='none'>

     

       85
        
           <itemizedlist>

     

       86
       -
            <listitem>

     

       87
       -
             <para>

     

       88
       -
              <literal>enable</literal>

     

       89
       -
             </para>

     

       90
       -
            </listitem>

     

       91
       -
            <listitem>

     

       92
       -
             <para>

     

       93
       -
              <literal>port</literal>

     

       94
       -
             </para>

     

       95
       -
            </listitem>

     

       96
       -
            <listitem>

     

       97
       -
             <para>

     

       98
       -
              <literal>listenAddress</literal>

     

       99
       -
             </para>

     

       100
       -
            </listitem>

     

       101
       -
            <listitem>

     

       102
       -
             <para>

     

       103
       -
              <literal>extraFlags</literal>

     

       104
       -
             </para>

     

       105
       -
            </listitem>

     

       106
       -
            <listitem>

     

       107
       -
             <para>

     

       108
       -
              <literal>openFirewall</literal>

     

       109
       -
             </para>

     

       110
       -
            </listitem>

     

       111
       -
            <listitem>

     

       112
       -
             <para>

     

       113
       -
              <literal>firewallFilter</literal>

     

       114
       -
             </para>

     

       115
       -
            </listitem>

     

       116
       -
            <listitem>

     

       117
       -
             <para>

     

       118
       -
              <literal>user</literal>

     

       119
       -
             </para>

     

       120
       -
            </listitem>

     

       121
       -
            <listitem>

     

       122
       -
             <para>

     

       123
       -
              <literal>group</literal>

     

       124
       -
             </para>

     

       125
       -
            </listitem>

     

       126
       -
           </itemizedlist>

     

       127
       -
          </listitem>

     

       128
       -
          <listitem>

     

       129
       -
           <para>

     

       130
       -
            As there is already a package available, the module can now be added. This

     

       131
       -
            is accomplished by adding a new file to the

     

       132
       -
            <literal>nixos/modules/services/monitoring/prometheus/exporters/</literal>

     

       133
       -
            directory, which will be called postfix.nix and contains all exporter

     

       134
       -
            specific options and configuration:

     

       135
       -
       <programlisting>

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       136
        
       # nixpgs/nixos/modules/services/prometheus/exporters/postfix.nix

     

       137
        
       { config, lib, pkgs, options }:

     

       138
        
       

     
···

       151
        
         extraOpts = {

     

       152
        
           telemetryPath = mkOption {

     

       153
        
             type = types.str;

     

       154
       -
             default = "/metrics";

     

       155
        
             description = ''

     

       156
        
               Path under which to expose metrics.

     

       157
        
             '';

     
···

       188
        
               ${pkgs.prometheus-postfix-exporter}/bin/postfix_exporter \

     

       189
        
                 --web.listen-address ${cfg.listenAddress}:${toString cfg.port} \

     

       190
        
                 --web.telemetry-path ${cfg.telemetryPath} \

     

       191
       -
                 ${concatStringsSep " \\\n  " cfg.extraFlags}

     

       192
        
             '';

     

       193
        
           };

     

       194
        
         };

     

       195
        
       }

     

       196
        
       </programlisting>

     

       197
       -
           </para>

     

       198
       -
          </listitem>

     

       199
       -
          <listitem>

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       200
        
           <para>

     

       201
       -
            This should already be enough for the postfix exporter. Additionally one

     

       202
       -
            could now add assertions and conditional default values. This can be done

     

       203
       -
            in the 'meta-module' that combines all exporter definitions and generates

     

       204
       -
            the submodules:

     

       205
       -
            <literal>nixpkgs/nixos/modules/services/prometheus/exporters.nix</literal>

     

       206
        
           </para>

     

       207
       -
          </listitem>

     

       208
       -
         </itemizedlist>

     

       209
       -
        </section>

     

       210
       -
        <section xml:id="module-services-prometheus-exporters-update-exporter-module">

     

       211
       -
         <title>Updating an exporter module</title>

     

       212
       -
          <para>

     

       213
       -
            Should an exporter option change at some point, it is possible to add

     

       214
       -
            information about the change to the exporter definition similar to

     

       215
       -
            <literal>nixpkgs/nixos/modules/rename.nix</literal>:

     

       216
       -
       <programlisting>

     

       217
        
       { config, lib, pkgs, options }:

     

       218
        
       

     

       219
        
       with lib;

     
···

       232
        
           # ...

     

       233
        
         };

     

       234
        
         imports = [

     

       235
       -
           # 'services.prometheus.exporters.nginx.telemetryEndpoint' -> 'services.prometheus.exporters.nginx.telemetryPath'

     

       236
       -
           (mkRenamedOptionModule [ "telemetryEndpoint" ] [ "telemetryPath" ])

     

       237
        
       

     

       238
        
           # removed option 'services.prometheus.exporters.nginx.insecure'

     

       239
       -
           (mkRemovedOptionModule [ "insecure" ] ''

     

       240
        
             This option was replaced by 'prometheus.exporters.nginx.sslVerify' which defaults to true.

     

       241
        
           '')

     

       242
        
           ({ options.warnings = options.warnings; })

     

       243
        
         ];

     

       244
        
       }

     

       245
        
       </programlisting>

     

       246
       -
           </para>

     

       247
        
         </section>

     

       248
        
       </chapter>

···

       1
       +
       <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="module-services-prometheus-exporters">

     

       2
       +
         <title>Prometheus exporters</title>

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       3
        
         <para>

     

       4
       +
           Prometheus exporters provide metrics for the

     

       5
       +
           <link xlink:href="https://prometheus.io">prometheus monitoring

     

       6
       +
           system</link>.

     

       7
       +
         </para>

     

       8
       +
         <section xml:id="module-services-prometheus-exporters-configuration">

     

       9
       +
           <title>Configuration</title>

     

       10
       +
           <para>

     

       11
       +
             One of the most common exporters is the

     

       12
       +
             <link xlink:href="https://github.com/prometheus/node_exporter">node

     

       13
       +
             exporter</link>, it provides hardware and OS metrics from the host

     

       14
       +
             it's running on. The exporter could be configured as follows:

     

       15
       +
           </para>

     

       16
       +
           <programlisting>

     

       17
        
         services.prometheus.exporters.node = {

     

       18
        
           enable = true;

     

       19
        
           port = 9100;

     

       20
        
           enabledCollectors = [

     

       21
       +
             &quot;logind&quot;

     

       22
       +
             &quot;systemd&quot;

     

       23
        
           ];

     

       24
        
           disabledCollectors = [

     

       25
       +
             &quot;textfile&quot;

     

       26
        
           ];

     

       27
        
           openFirewall = true;

     

       28
       +
           firewallFilter = &quot;-i br0 -p tcp -m tcp --dport 9100&quot;;

     

       29
        
         };

     

       30
        
       </programlisting>

     

       31
       +
           <para>

     

       32
       +
             It should now serve all metrics from the collectors that are

     

       33
       +
             explicitly enabled and the ones that are

     

       34
       +
             <link xlink:href="https://github.com/prometheus/node_exporter#enabled-by-default">enabled

     

       35
       +
             by default</link>, via http under <literal>/metrics</literal>. In

     

       36
       +
             this example the firewall should just allow incoming connections

     

       37
       +
             to the exporter's port on the bridge interface

     

       38
       +
             <literal>br0</literal> (this would have to be configured

     

       39
       +
             separately of course). For more information about configuration

     

       40
       +
             see <literal>man configuration.nix</literal> or search through the

     

       41
       +
             <link xlink:href="https://nixos.org/nixos/options.html#prometheus.exporters">available

     

       42
       +
             options</link>.

     

       43
       +
           </para>

     

       44
       +
           <para>

     

       45
       +
             Prometheus can now be configured to consume the metrics produced

     

       46
       +
             by the exporter:

     

       47
       +
           </para>

     

       48
        
           <programlisting>

     

       49
        
           services.prometheus = {

     

       50
        
             # ...

     

       51
        
       

     

       52
        
             scrapeConfigs = [

     

       53
        
               {

     

       54
       +
                 job_name = &quot;node&quot;;

     

       55
        
                 static_configs = [{

     

       56
       +
                   targets = [ &quot;localhost:${toString config.services.prometheus.exporters.node.port}&quot; ];

     

       57
        
                 }];

     

       58
        
               }

     

       59
        
             ];

     

       60
        
       

     

       61
        
             # ...

     

       62
        
           }

     

       63
       +
       </programlisting>

     

       64
       +
         </section>

     

       65
       +
         <section xml:id="module-services-prometheus-exporters-new-exporter">

     

       66
       +
           <title>Adding a new exporter</title>

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       67
        
           <para>

     

       68
       +
             To add a new exporter, it has to be packaged first (see

     

       69
       +
             <literal>nixpkgs/pkgs/servers/monitoring/prometheus/</literal> for

     

       70
       +
             examples), then a module can be added. The postfix exporter is

     

       71
       +
             used in this example:

     

       72
        
           </para>

     

       0
        
       
     

       0
        
       
     

       73
        
           <itemizedlist>

     

       74
       +
             <listitem>

     

       75
       +
               <para>

     

       76
       +
                 Some default options for all exporters are provided by

     

       77
       +
                 <literal>nixpkgs/nixos/modules/services/monitoring/prometheus/exporters.nix</literal>:

     

       78
       +
               </para>

     

       79
       +
               <itemizedlist spacing="compact">

     

       80
       +
                 <listitem>

     

       81
       +
                   <para>

     

       82
       +
                     <literal>enable</literal>

     

       83
       +
                   </para>

     

       84
       +
                 </listitem>

     

       85
       +
                 <listitem>

     

       86
       +
                   <para>

     

       87
       +
                     <literal>port</literal>

     

       88
       +
                   </para>

     

       89
       +
                 </listitem>

     

       90
       +
                 <listitem>

     

       91
       +
                   <para>

     

       92
       +
                     <literal>listenAddress</literal>

     

       93
       +
                   </para>

     

       94
       +
                 </listitem>

     

       95
       +
                 <listitem>

     

       96
       +
                   <para>

     

       97
       +
                     <literal>extraFlags</literal>

     

       98
       +
                   </para>

     

       99
       +
                 </listitem>

     

       100
       +
                 <listitem>

     

       101
       +
                   <para>

     

       102
       +
                     <literal>openFirewall</literal>

     

       103
       +
                   </para>

     

       104
       +
                 </listitem>

     

       105
       +
                 <listitem>

     

       106
       +
                   <para>

     

       107
       +
                     <literal>firewallFilter</literal>

     

       108
       +
                   </para>

     

       109
       +
                 </listitem>

     

       110
       +
                 <listitem>

     

       111
       +
                   <para>

     

       112
       +
                     <literal>user</literal>

     

       113
       +
                   </para>

     

       114
       +
                 </listitem>

     

       115
       +
                 <listitem>

     

       116
       +
                   <para>

     

       117
       +
                     <literal>group</literal>

     

       118
       +
                   </para>

     

       119
       +
                 </listitem>

     

       120
       +
               </itemizedlist>

     

       121
       +
             </listitem>

     

       122
       +
             <listitem>

     

       123
       +
               <para>

     

       124
       +
                 As there is already a package available, the module can now be

     

       125
       +
                 added. This is accomplished by adding a new file to the

     

       126
       +
                 <literal>nixos/modules/services/monitoring/prometheus/exporters/</literal>

     

       127
       +
                 directory, which will be called postfix.nix and contains all

     

       128
       +
                 exporter specific options and configuration:

     

       129
       +
               </para>

     

       130
       +
               <programlisting>

     

       131
        
       # nixpgs/nixos/modules/services/prometheus/exporters/postfix.nix

     

       132
        
       { config, lib, pkgs, options }:

     

       133
        
       

     
···

       146
        
         extraOpts = {

     

       147
        
           telemetryPath = mkOption {

     

       148
        
             type = types.str;

     

       149
       +
             default = &quot;/metrics&quot;;

     

       150
        
             description = ''

     

       151
        
               Path under which to expose metrics.

     

       152
        
             '';

     
···

       183
        
               ${pkgs.prometheus-postfix-exporter}/bin/postfix_exporter \

     

       184
        
                 --web.listen-address ${cfg.listenAddress}:${toString cfg.port} \

     

       185
        
                 --web.telemetry-path ${cfg.telemetryPath} \

     

       186
       +
                 ${concatStringsSep &quot; \\\n  &quot; cfg.extraFlags}

     

       187
        
             '';

     

       188
        
           };

     

       189
        
         };

     

       190
        
       }

     

       191
        
       </programlisting>

     

       192
       +
             </listitem>

     

       193
       +
             <listitem>

     

       194
       +
               <para>

     

       195
       +
                 This should already be enough for the postfix exporter.

     

       196
       +
                 Additionally one could now add assertions and conditional

     

       197
       +
                 default values. This can be done in the 'meta-module' that

     

       198
       +
                 combines all exporter definitions and generates the

     

       199
       +
                 submodules:

     

       200
       +
                 <literal>nixpkgs/nixos/modules/services/prometheus/exporters.nix</literal>

     

       201
       +
               </para>

     

       202
       +
             </listitem>

     

       203
       +
           </itemizedlist>

     

       204
       +
         </section>

     

       205
       +
         <section xml:id="module-services-prometheus-exporters-update-exporter-module">

     

       206
       +
           <title>Updating an exporter module</title>

     

       207
        
           <para>

     

       208
       +
             Should an exporter option change at some point, it is possible to

     

       209
       +
             add information about the change to the exporter definition

     

       210
       +
             similar to <literal>nixpkgs/nixos/modules/rename.nix</literal>:

     

       0
        
       
     

       0
        
       
     

       211
        
           </para>

     

       212
       +
           <programlisting>

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       213
        
       { config, lib, pkgs, options }:

     

       214
        
       

     

       215
        
       with lib;

     
···

       228
        
           # ...

     

       229
        
         };

     

       230
        
         imports = [

     

       231
       +
           # 'services.prometheus.exporters.nginx.telemetryEndpoint' -&gt; 'services.prometheus.exporters.nginx.telemetryPath'

     

       232
       +
           (mkRenamedOptionModule [ &quot;telemetryEndpoint&quot; ] [ &quot;telemetryPath&quot; ])

     

       233
        
       

     

       234
        
           # removed option 'services.prometheus.exporters.nginx.insecure'

     

       235
       +
           (mkRemovedOptionModule [ &quot;insecure&quot; ] ''

     

       236
        
             This option was replaced by 'prometheus.exporters.nginx.sslVerify' which defaults to true.

     

       237
        
           '')

     

       238
        
           ({ options.warnings = options.warnings; })

     

       239
        
         ];

     

       240
        
       }

     

       241
        
       </programlisting>

     

       0
        
       
     

       242
        
         </section>

     

       243
        
       </chapter>