Clarify docs

grafana · Nov 6, 2023 · e9dfc64 · e9dfc64
1 parent ca630e9
commit e9dfc64
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/docs/sources/flow/reference/components/prometheus.exporter.blackbox.md b/docs/sources/flow/reference/components/prometheus.exporter.blackbox.md
@@ -34,6 +34,7 @@ Omitted fields take their default values.
 | `config`               | `string` or `secret` | blackbox_exporter configuration as inline string.                |          | no       |
 | `probe_timeout_offset` | `duration`           | Offset in seconds to subtract from timeout when probing targets. | `"0.5s"` | no       |
 
+Either `config_file` or `config` must be specified.
 The `config_file` argument points to a YAML file defining which blackbox_exporter modules to use.
 The `config` argument must be a YAML document as string defining which blackbox_exporter modules to use.
 `config` is typically loaded by using the exports of another component. For example,

diff --git a/docs/sources/static/configuration/integrations/blackbox-config.md b/docs/sources/static/configuration/integrations/blackbox-config.md
@@ -91,6 +91,7 @@ Full reference of options:
   [config_file: <string> | default = ""]
 
   # Embedded blackbox configuration. You can specify your modules here instead of an external config file.
+  # config_file or blackbox_config must be specified.
   # See https://github.com/prometheus/blackbox_exporter/blob/master/CONFIGURATION.md for more details how to specify your blackbox modules.
   blackbox_config:
     [- <modules> ... ]