Class DockerSDConfig

    • Method Detail

      • getAuthorization

        public SafeAuthorization getAuthorization()
        Docker SD configurations allow retrieving scrape targets from Docker Engine hosts. This SD discovers "containers" and will create a target for each network IP and port the container is configured to expose. See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#docker_sd_config
      • setAuthorization

        public void setAuthorization​(SafeAuthorization authorization)
        Docker SD configurations allow retrieving scrape targets from Docker Engine hosts. This SD discovers "containers" and will create a target for each network IP and port the container is configured to expose. See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#docker_sd_config
      • getBasicAuth

        public BasicAuth getBasicAuth()
        Docker SD configurations allow retrieving scrape targets from Docker Engine hosts. This SD discovers "containers" and will create a target for each network IP and port the container is configured to expose. See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#docker_sd_config
      • setBasicAuth

        public void setBasicAuth​(BasicAuth basicAuth)
        Docker SD configurations allow retrieving scrape targets from Docker Engine hosts. This SD discovers "containers" and will create a target for each network IP and port the container is configured to expose. See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#docker_sd_config
      • getEnableHTTP2

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

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

        public List<Filter> getFilters()
        filters defines filters to limit the discovery process to a subset of the available resources.
      • setFilters

        public void setFilters​(List<Filter> filters)
        filters defines filters to limit the discovery process to a subset of the available resources.
      • 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.
      • getHost

        public String getHost()
        host defines the address of the docker daemon.
      • setHost

        public void setHost​(String host)
        host defines the address of the docker daemon.
      • getHostNetworkingHost

        public String getHostNetworkingHost()
        hostNetworkingHost defines the host to use if the container is in host networking mode.
      • setHostNetworkingHost

        public void setHostNetworkingHost​(String hostNetworkingHost)
        hostNetworkingHost defines the host to use if the container is in host networking mode.
      • getMatchFirstNetwork

        public Boolean getMatchFirstNetwork()
        matchFirstNetwork defines whether to match the first network if the container has multiple networks defined. If unset, Prometheus uses true by default. It requires Prometheus >= v2.54.1.
      • setMatchFirstNetwork

        public void setMatchFirstNetwork​(Boolean matchFirstNetwork)
        matchFirstNetwork defines whether to match the first network if the container has multiple networks defined. If unset, Prometheus uses true by default. It requires Prometheus >= v2.54.1.
      • 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.

      • getOauth2

        public OAuth2 getOauth2()
        Docker SD configurations allow retrieving scrape targets from Docker Engine hosts. This SD discovers "containers" and will create a target for each network IP and port the container is configured to expose. See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#docker_sd_config
      • setOauth2

        public void setOauth2​(OAuth2 oauth2)
        Docker SD configurations allow retrieving scrape targets from Docker Engine hosts. This SD discovers "containers" and will create a target for each network IP and port the container is configured to expose. See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#docker_sd_config
      • getPort

        public Integer getPort()
        port defines the port to scrape metrics from. If using the public IP address, this must
      • setPort

        public void setPort​(Integer port)
        port defines the port to scrape metrics from. If using the public IP address, this must
      • 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.
      • getTlsConfig

        public SafeTLSConfig getTlsConfig()
        Docker SD configurations allow retrieving scrape targets from Docker Engine hosts. This SD discovers "containers" and will create a target for each network IP and port the container is configured to expose. See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#docker_sd_config
      • setTlsConfig

        public void setTlsConfig​(SafeTLSConfig tlsConfig)
        Docker SD configurations allow retrieving scrape targets from Docker Engine hosts. This SD discovers "containers" and will create a target for each network IP and port the container is configured to expose. See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#docker_sd_config
      • getAdditionalProperties

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

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

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