summaryrefslogtreecommitdiffstats
path: root/nixos/doc
diff options
context:
space:
mode:
authorWilliButz <wbutz@cyberfnord.de>2021-01-01 23:59:06 +0100
committerWilliButz <wbutz@cyberfnord.de>2021-01-02 13:10:27 +0100
commit3f94c66ee121a2fdb136741c3685195c6d1db643 (patch)
tree6010a22b6513f3158e0331f81d0525849a10494c /nixos/doc
parentd539517f2b4e20973d2046ca16ed83d9bc5b34ae (diff)
nixos/prometheus-json-exporter: update modules & tests, add release notes
Diffstat (limited to 'nixos/doc')
-rw-r--r--nixos/doc/manual/release-notes/rl-2103.xml26
1 files changed, 26 insertions, 0 deletions
diff --git a/nixos/doc/manual/release-notes/rl-2103.xml b/nixos/doc/manual/release-notes/rl-2103.xml
index 38262b508994..0475c365504e 100644
--- a/nixos/doc/manual/release-notes/rl-2103.xml
+++ b/nixos/doc/manual/release-notes/rl-2103.xml
@@ -295,6 +295,32 @@
Based on <xref linkend="opt-system.stateVersion" />, existing installations will continue to work.
</para>
</listitem>
+ <listitem>
+ <para>
+ The prometheus json exporter is now managed by the prometheus community. Together with additional features
+ some backwards incompatibilities were introduced.
+ Most importantly the exporter no longer accepts a fixed command-line parameter to specify the URL of the
+ endpoint serving JSON. It now expects this URL to be passed as an URL parameter, when scraping the exporter's
+ <literal>/probe</literal> endpoint.
+ In the prometheus scrape configuration the scrape target might look like this:
+ <programlisting>
+ http://some.json-exporter.host:7979/probe?target=https://example.com/some/json/endpoint
+ </programlisting>
+ </para>
+ <para>
+ Existing configuration for the exporter needs to be updated, but can partially be re-used.
+ Documentation is available in the upstream repository and a small example for NixOS is available
+ in the corresponding NixOS test.
+ </para>
+ <para>
+ These changes also affect <literal>services.prometheus.exporters.rspamd</literal>, which is
+ just a preconfigured instance of the json exporter.
+ </para>
+ <para>
+ For more information, take a look at the <link xlink:href="https://github.com/prometheus-community/json_exporter">
+ official documentation</link> of the json_exporter.
+ </para>
+ </listitem>
</itemizedlist>
</section>