diff --git a/sd_configs.md b/sd_configs.md index 7345e13..858bd2f 100644 --- a/sd_configs.md +++ b/sd_configs.md @@ -204,23 +204,23 @@ The following meta labels are available on discovered targets during [relabeling The list of discovered Consul targets is refreshed at the interval, which can be configured via `-promscrape.consulSDCheckInterval` command-line flag. -If you have performance issues with consul_sd_configs on a large cluster, then consider using [consulagent_sd_configs](#consulagent_sd_configs) instead. +If you have performance issues with `consul_sd_configs` on a large cluster, then consider using [consulagent_sd_configs](#consulagent_sd_configs) instead. ## consulagent_sd_configs -Consul Agent SD configuration allows retrieving scrape targets from [Consul's Agent API](https://developer.hashicorp.com/consul/api-docs/agent/service). -When using the Agent API, each running vmagent will only get services registered in the local Consul Agent running on the same node when discovering new targets. -It's suitable for huge clusters for which using the [Catalog API](https://developer.hashicorp.com/consul/api-docs/catalog#list-services) would be too slow or resource intensive, -in other cases we recommend to use [consul_sd_configs](#consul_sd_configs). +Consul Agent SD configuration allows retrieving scrape targets from [Consul Agent API](https://developer.hashicorp.com/consul/api-docs/agent/service). +When using the Agent API, only services registered in the locally running Consul Agent are discovered. +It is suitable for huge clusters for which using the [Catalog API](https://developer.hashicorp.com/consul/api-docs/catalog#list-services) would be too slow or resource intensive, +in other cases it is recommended to use [consul_sd_configs](#consul_sd_configs). Configuration example: ```yaml scrape_configs: -- job_name: consul +- job_name: consulagent consulagent_sd_configs: - # server is an optional Consul agent to connect to. By default localhost:8500 is used + # server is an optional Consul Agent to connect to. By default localhost:8500 is used - server: "localhost:8500" # token is an optional Consul API token. @@ -252,12 +252,12 @@ scrape_configs: # Individual tags are also available via __meta_consul_tag_ labels - see below. # tag_separator: "..." - # filter is optional filter for service nodes discovery request. + # filter is optional filter for service nodes discovery request. # Replaces tags and node_metadata options. # consul supports it since 1.14 version # list of supported filters https://developer.hashicorp.com/consul/api-docs/catalog#filtering-1 # syntax examples https://developer.hashicorp.com/consul/api-docs/features/filtering - # filter: "..." + # filter: "..." # Additional HTTP API client options can be specified here. # See https://docs.victoriametrics.com/sd_configs.html#http-api-client-options