Class ConsulSDConfig

    • Method Detail

      • getAllowStale

        public Boolean getAllowStale()
        allowStale Consul results (see https://www.consul.io/api/features/consistency.html). Will reduce load on Consul. If unset, Prometheus uses its default value.
      • setAllowStale

        public void setAllowStale​(Boolean allowStale)
        allowStale Consul results (see https://www.consul.io/api/features/consistency.html). Will reduce load on Consul. If unset, Prometheus uses its default value.
      • getAuthorization

        public SafeAuthorization getAuthorization()
        ConsulSDConfig defines a Consul service discovery configuration See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#consul_sd_config
      • setAuthorization

        public void setAuthorization​(SafeAuthorization authorization)
        ConsulSDConfig defines a Consul service discovery configuration See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#consul_sd_config
      • getBasicAuth

        public BasicAuth getBasicAuth()
        ConsulSDConfig defines a Consul service discovery configuration See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#consul_sd_config
      • setBasicAuth

        public void setBasicAuth​(BasicAuth basicAuth)
        ConsulSDConfig defines a Consul service discovery configuration See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#consul_sd_config
      • getDatacenter

        public String getDatacenter()
        datacenter defines the consul Datacenter name, if not provided it will use the local Consul Agent Datacenter.
      • setDatacenter

        public void setDatacenter​(String datacenter)
        datacenter defines the consul Datacenter name, if not provided it will use the local Consul Agent Datacenter.
      • getEnableHTTP2

        public Boolean getEnableHTTP2()
        enableHTTP2 defines whether to enable HTTP2.
      • setEnableHTTP2

        public void setEnableHTTP2​(Boolean enableHTTP2)
        enableHTTP2 defines whether to enable HTTP2.
      • getFilter

        public String getFilter()
        filter defines the filter expression used to filter the catalog results. See https://developer.hashicorp.com/consul/api-docs/catalog#filtering It requires Prometheus >= 3.0.0.
      • setFilter

        public void setFilter​(String filter)
        filter defines the filter expression used to filter the catalog results. See https://developer.hashicorp.com/consul/api-docs/catalog#filtering It requires Prometheus >= 3.0.0.
      • getFollowRedirects

        public Boolean getFollowRedirects()
        followRedirects defines whether HTTP requests follow HTTP 3xx redirects.
      • setFollowRedirects

        public void setFollowRedirects​(Boolean followRedirects)
        followRedirects defines whether HTTP requests follow HTTP 3xx redirects.
      • getHealthFilter

        public String getHealthFilter()
        healthFilter defines the filter expression used to filter the health results. See https://developer.hashicorp.com/consul/api-docs/health#filtering It requires Prometheus >= 3.11.2.
      • setHealthFilter

        public void setHealthFilter​(String healthFilter)
        healthFilter defines the filter expression used to filter the health results. See https://developer.hashicorp.com/consul/api-docs/health#filtering It requires Prometheus >= 3.11.2.
      • getNamespace

        public String getNamespace()
        namespace are only supported in Consul Enterprise.


        It requires Prometheus >= 2.28.0.

      • setNamespace

        public void setNamespace​(String namespace)
        namespace are only supported in Consul Enterprise.


        It requires Prometheus >= 2.28.0.

      • getNoProxy

        public String getNoProxy()
        noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers.


        It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

      • setNoProxy

        public void setNoProxy​(String noProxy)
        noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers.


        It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

      • getNodeMeta

        public Map<String,​String> getNodeMeta()
        nodeMeta defines the node metadata key/value pairs to filter nodes for a given service. Starting with Consul 1.14, it is recommended to use `filter` with the `NodeMeta` selector instead.
      • setNodeMeta

        public void setNodeMeta​(Map<String,​String> nodeMeta)
        nodeMeta defines the node metadata key/value pairs to filter nodes for a given service. Starting with Consul 1.14, it is recommended to use `filter` with the `NodeMeta` selector instead.
      • getOauth2

        public OAuth2 getOauth2()
        ConsulSDConfig defines a Consul service discovery configuration See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#consul_sd_config
      • setOauth2

        public void setOauth2​(OAuth2 oauth2)
        ConsulSDConfig defines a Consul service discovery configuration See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#consul_sd_config
      • getPartition

        public String getPartition()
        partition defines the admin Partitions are only supported in Consul Enterprise.
      • setPartition

        public void setPartition​(String partition)
        partition defines the admin Partitions are only supported in Consul Enterprise.
      • getPathPrefix

        public String getPathPrefix()
        pathPrefix defines the prefix for URIs for when consul is behind an API gateway (reverse proxy).


        It requires Prometheus >= 2.45.0.

      • setPathPrefix

        public void setPathPrefix​(String pathPrefix)
        pathPrefix defines the prefix for URIs for when consul is behind an API gateway (reverse proxy).


        It requires Prometheus >= 2.45.0.

      • getProxyConnectHeader

        public Map<String,​List<SecretKeySelector>> getProxyConnectHeader()
        proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.


        It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

      • setProxyConnectHeader

        public void setProxyConnectHeader​(Map<String,​List<SecretKeySelector>> proxyConnectHeader)
        proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.


        It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

      • getProxyFromEnvironment

        public Boolean getProxyFromEnvironment()
        proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).


        It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

      • setProxyFromEnvironment

        public void setProxyFromEnvironment​(Boolean proxyFromEnvironment)
        proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).


        It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

      • getProxyUrl

        public String getProxyUrl()
        proxyUrl defines the HTTP proxy server to use.
      • setProxyUrl

        public void setProxyUrl​(String proxyUrl)
        proxyUrl defines the HTTP proxy server to use.
      • getRefreshInterval

        public String getRefreshInterval()
        refreshInterval defines the time after which the provided names are refreshed. If not set, Prometheus uses its default value.
      • setRefreshInterval

        public void setRefreshInterval​(String refreshInterval)
        refreshInterval defines the time after which the provided names are refreshed. If not set, Prometheus uses its default value.
      • getScheme

        public String getScheme()
        scheme defines the HTTP Scheme.
      • setScheme

        public void setScheme​(String scheme)
        scheme defines the HTTP Scheme.
      • getServer

        public String getServer()
        server defines the consul server address. A valid string consisting of a hostname or IP followed by an optional port number.
      • setServer

        public void setServer​(String server)
        server defines the consul server address. A valid string consisting of a hostname or IP followed by an optional port number.
      • getServices

        public List<String> getServices()
        services defines a list of services for which targets are retrieved. If omitted, all services are scraped.
      • setServices

        public void setServices​(List<String> services)
        services defines a list of services for which targets are retrieved. If omitted, all services are scraped.
      • getTagSeparator

        public String getTagSeparator()
        tagSeparator defines the string by which Consul tags are joined into the tag label. If unset, Prometheus uses its default value.
      • setTagSeparator

        public void setTagSeparator​(String tagSeparator)
        tagSeparator defines the string by which Consul tags are joined into the tag label. If unset, Prometheus uses its default value.
      • getTags

        public List<String> getTags()
        tags defines an optional list of tags used to filter nodes for a given service. Services must contain all tags in the list. Starting with Consul 1.14, it is recommended to use `filter` with the `ServiceTags` selector instead.
      • setTags

        public void setTags​(List<String> tags)
        tags defines an optional list of tags used to filter nodes for a given service. Services must contain all tags in the list. Starting with Consul 1.14, it is recommended to use `filter` with the `ServiceTags` selector instead.
      • getTlsConfig

        public SafeTLSConfig getTlsConfig()
        ConsulSDConfig defines a Consul service discovery configuration See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#consul_sd_config
      • setTlsConfig

        public void setTlsConfig​(SafeTLSConfig tlsConfig)
        ConsulSDConfig defines a Consul service discovery configuration See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#consul_sd_config
      • getTokenRef

        public SecretKeySelector getTokenRef()
        ConsulSDConfig defines a Consul service discovery configuration See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#consul_sd_config
      • setTokenRef

        public void setTokenRef​(SecretKeySelector tokenRef)
        ConsulSDConfig defines a Consul service discovery configuration See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#consul_sd_config
      • getAdditionalProperties

        public Map<String,​Object> getAdditionalProperties()
      • setAdditionalProperty

        public void setAdditionalProperty​(String name,
                                          Object value)
      • setAdditionalProperties

        public void setAdditionalProperties​(Map<String,​Object> additionalProperties)