movefasta/nixpkgs
1
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-06-12 04:35:41 +03:00
Code Issues Projects Releases Packages Wiki Activity

nixos/prometheus-exporters: minor doc improvements

Browse source 
* Content of `programlisting` shouldn't be indented, otherwise it's
  weirdly indented in the output.
* Use `<xref linkend=.../>` in the release notes: then users can
  directly go to the option documentation when reading release notes.
* Don't use docbook tags in `mkRemovedOptionModule`: it's only used
  during evaluation where docbook isn't rendered.
This commit is contained in:
Maximilian Bosch 2021-01-03 19:04:33 +01:00
parent 3f94c66ee1
commit 6e43cc7fb0
No known key found for this signature in database
GPG key ID: 091DBF4D1FC46B8E
3 changed files with 12 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

4
nixos/doc/manual/release-notes/rl-2103.xml
View file

@ -304,7 +304,7 @@
<literal>/probe</literal> endpoint. <literal>/probe</literal> endpoint.
In the prometheus scrape configuration the scrape target might look like this: In the prometheus scrape configuration the scrape target might look like this:
<programlisting> <programlisting>
http://some.json-exporter.host:7979/probe?target=https://example.com/some/json/endpoint http://some.json-exporter.host:7979/probe?target=https://example.com/some/json/endpoint
</programlisting> </programlisting>
</para> </para>
<para> <para>
@ -313,7 +313,7 @@
in the corresponding NixOS test. in the corresponding NixOS test.
</para> </para>
<para> <para>
These changes also affect <literal>services.prometheus.exporters.rspamd</literal>, which is These changes also affect <xref linkend="opt-services.prometheus.exporters.rspamd.enable" />, which is
just a preconfigured instance of the json exporter. just a preconfigured instance of the json exporter.
</para> </para>
<para> <para>

12
nixos/modules/services/monitoring/prometheus/exporters/json.nix
View file

@ -4,7 +4,6 @@ with lib;
let let
cfg = config.services.prometheus.exporters.json; cfg = config.services.prometheus.exporters.json;
in in
{ {
port = 7979; port = 7979;
@ -30,15 +29,14 @@ in
(mkRemovedOptionModule [ "url" ] '' (mkRemovedOptionModule [ "url" ] ''
This option was removed. The URL of the endpoint serving JSON This option was removed. The URL of the endpoint serving JSON
must now be provided to the exporter by prometheus via the url must now be provided to the exporter by prometheus via the url
parameter <literal>target</literal>. parameter `target'.
In prometheus a scrape URL would look like this: In prometheus a scrape URL would look like this:
<programlisting>
http://some.json-exporter.host:7979/probe?target=https://example.com/some/json/endpoint
</programlisting>
For more information, take a look at the <link xlink:href="https://github.com/prometheus-community/json_exporter"> http://some.json-exporter.host:7979/probe?target=https://example.com/some/json/endpoint
official documentation</link> of the json_exporter.
For more information, take a look at the official documentation
(https://github.com/prometheus-community/json_exporter) of the json_exporter.
'') '')
({ options.warnings = options.warnings; options.assertions = options.assertions; }) ({ options.warnings = options.warnings; options.assertions = options.assertions; })
]; ];

11
nixos/modules/services/monitoring/prometheus/exporters/rspamd.nix
View file

@ -85,15 +85,14 @@ in
(mkRemovedOptionModule [ "url" ] '' (mkRemovedOptionModule [ "url" ] ''
This option was removed. The URL of the rspamd metrics endpoint This option was removed. The URL of the rspamd metrics endpoint
must now be provided to the exporter by prometheus via the url must now be provided to the exporter by prometheus via the url
parameter <literal>target</literal>. parameter `target'.
In prometheus a scrape URL would look like this: In prometheus a scrape URL would look like this:
<programlisting>
http://some.rspamd-exporter.host:7980/probe?target=http://some.rspamd.host:11334/stat
</programlisting>
For more information, take a look at the <link xlink:href="https://github.com/prometheus-community/json_exporter"> http://some.rspamd-exporter.host:7980/probe?target=http://some.rspamd.host:11334/stat
official documentation</link> of the json_exporter.
For more information, take a look at the official documentation
(https://github.com/prometheus-community/json_exporter) of the json_exporter.
'') '')
({ options.warnings = options.warnings; options.assertions = options.assertions; }) ({ options.warnings = options.warnings; options.assertions = options.assertions; })
]; ];