From 6e43cc7fb0f22a88a989583ccf50e56f7f72ad6a Mon Sep 17 00:00:00 2001 From: Maximilian Bosch Date: Sun, 3 Jan 2021 19:04:33 +0100 Subject: nixos/prometheus-exporters: minor doc improvements * Content of `programlisting` shouldn't be indented, otherwise it's weirdly indented in the output. * Use `` 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. --- .../services/monitoring/prometheus/exporters/json.nix | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) (limited to 'nixos/modules/services/monitoring/prometheus/exporters/json.nix') 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 target. + parameter `target'. In prometheus a scrape URL would look like this: - - http://some.json-exporter.host:7979/probe?target=https://example.com/some/json/endpoint - - For more information, take a look at the - official documentation 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; }) ]; -- cgit 1.4.1