summary refs log tree commit diff
path: root/nixos/modules/services/monitoring/prometheus/exporters/json.nix
diff options
context:
space:
mode:
authorMaximilian Bosch <maximilian@mbosch.me>2021-01-03 19:04:33 +0100
committerMaximilian Bosch <maximilian@mbosch.me>2021-01-03 19:04:33 +0100
commit6e43cc7fb0f22a88a989583ccf50e56f7f72ad6a (patch)
tree79bc6992ea8ead195b63d5745f4d4526b44281a9 /nixos/modules/services/monitoring/prometheus/exporters/json.nix
parent3f94c66ee121a2fdb136741c3685195c6d1db643 (diff)
downloadnixpkgs-6e43cc7fb0f22a88a989583ccf50e56f7f72ad6a.tar
nixpkgs-6e43cc7fb0f22a88a989583ccf50e56f7f72ad6a.tar.gz
nixpkgs-6e43cc7fb0f22a88a989583ccf50e56f7f72ad6a.tar.bz2
nixpkgs-6e43cc7fb0f22a88a989583ccf50e56f7f72ad6a.tar.lz
nixpkgs-6e43cc7fb0f22a88a989583ccf50e56f7f72ad6a.tar.xz
nixpkgs-6e43cc7fb0f22a88a989583ccf50e56f7f72ad6a.tar.zst
nixpkgs-6e43cc7fb0f22a88a989583ccf50e56f7f72ad6a.zip
nixos/prometheus-exporters: minor doc improvements
* 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.
Diffstat (limited to 'nixos/modules/services/monitoring/prometheus/exporters/json.nix')
-rw-r--r--nixos/modules/services/monitoring/prometheus/exporters/json.nix12
1 files changed, 5 insertions, 7 deletions
diff --git a/nixos/modules/services/monitoring/prometheus/exporters/json.nix b/nixos/modules/services/monitoring/prometheus/exporters/json.nix
index 24364aababd..1800da69a25 100644
--- a/nixos/modules/services/monitoring/prometheus/exporters/json.nix
+++ b/nixos/modules/services/monitoring/prometheus/exporters/json.nix
@@ -4,7 +4,6 @@ with lib;
 
 let
   cfg = config.services.prometheus.exporters.json;
-
 in
 {
   port = 7979;
@@ -30,15 +29,14 @@ in
     (mkRemovedOptionModule [ "url" ] ''
       This option was removed. The URL of the endpoint serving JSON
       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:
-      <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">
-      official documentation</link> of the json_exporter.
+        http://some.json-exporter.host:7979/probe?target=https://example.com/some/json/endpoint
+
+      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; })
   ];