Targets Config

# DNS server to use for DNS resolution, instead of system's default. Server # can be specified in the following format: [network://]ip[:port] # where network is one of udp, tcp, tcp4, tcp6, udp4, udp6. # Example: # - "1.1.1.1" // Use default network and port (53) # - "tcp://1.1.1.1" // Use tcp network and default port (53) # - "tcp://1.1.1.1:513 // Use tcp network and port 513

# DNS TTL (time to live). This controls how often backend DNS server will be # queried.

# This option controls for how long cached IP can be used in case of resolve # errors. Default value for this is set to ttl_sec. It should never be # lower than dns_ttl_sec.

# Backend timeout in milliseconds. This option controls how long we'll wait # for the backend DNS server to respond. Note that DNS resolution happens # asynchronously, so DNS resolve time should never really affect the probe. # This timeout affects how soon DNS resolution is retried, if it's hanging.

# Endpoint name. Metrics for a target are identified by a combination of # endpoint name and port name, if specified.

# Optional IP address. If not specified, endpoint name is DNS resolved.

# Endpoint port. If specified, this port will be used by the port-based # probes (e.g. TCP, HTTP), if probe's configuration doesn't specify a port.

# HTTP probe URL. If provided, this field is used by the HTTP probe, if # probe configuration itself doesn't specify URL fields.

# Endpoint labels. These labels can be exported as metrics labels using the # `additional_label` field in the probe configuration.

# RDS server address # Deprecated: This option is now deprecated, please use rds_server_options # instead.

# RDS server options, for example: # rds_server_options { # server_address: "rds-server.xyz:9314" # oauth_config: { # ... # } # }

# GCE targets options.

# Lame duck options. If provided, targets module checks for the lame duck # targets and removes them from the targets list.

# Targets namespace. If this field is unset, we select resources from all # namespaces.

# labelSelector uses the same format as kubernetes API calls. # Example: # labelSelector: "k8s-app" # label k8s-app exists # labelSelector: "role=frontend" # label role=frontend # labelSelector: "!canary" # canary label doesn't exist

# Which resources to target. If value is not empty (""), we use it as a # regex for resource names. # Example: # services: "" // All services. # endpoints: ".*-service" // Endpoints ending with "service".

# portFilter can be used to filter resources by port name. This is useful # for resources like endpoints and services, where each resource may have # multiple ports, and we may hit just a subset of those ports. portFilter # takes a regex -- we apply it on port names if port name is available, # otherwise we apply it port numbers. # Example: ".*-dns", "metrics", ".*-service", etc.

# How often to re-check k8s API servers. Note this field will be irrelevant # when (and if) we move to the watch API. Default is 30s.

# RDS server options, for example: # rds_server_options { # server_address: "rds-server.xyz:9314" # oauth_config: { # ... # } # }

# Resource path specifies the resources to return. Resources paths have the # following format: # <resource_provider>://<resource_type>/<additional_params> # # Examples: # For GCE instances in projectA: "gcp://gce_instances/<projectA>" # Kubernetes Pods : "k8s://pods"

# Filters to filter resources by.

# IP config to specify the IP address to pick for a resource.

# Static endpoints. These endpoints are merged with the resources returned # by the targets type above. # Example: # endpoint { # name: "service-gtwy-1" # ip: "10.1.18.121" # port: 8080 # labels { # key: "service" # value: "products-service" # } # } # endpoint { # name: "frontend-url1" # url: "https://frontend.example.com/url1" # }

# Regex to apply on the targets.

# Exclude lameducks. Lameduck targets can be set through RTC (realtime # configurator) service. This functionality works only if lame_duck_options # are specified.

# Options to control DNS resolution behavior if using Cloudprober's DNS # resolver, which get triggered only if you're setting `resolve_first` probe # setting to true.

# Provide a dns resolver override instead of using the default dns resolver. # Deprecated: This option is now deprecated, please use dns_options instead.

# File that contains resources in either textproto or json format. # Example in textproto format: # # resource { # name: "switch-xx-01" # ip: "10.11.112.3" # port: 8080 # labels { # key: "device_type" # value: "switch" # } # } # resource { # name: "switch-yy-01" # ip: "10.16.110.12" # port: 8080 # }

# If specified, file will be re-read at the given interval.

# Important: if multiple probes use forwarding_rules targets, only the # settings in the definition will take effect. # TODO(manugarg): Fix this behavior. # # For regional forwarding rules, regions to return forwarding rules for. # Default is to return forwarding rules from the region that the VM is # running in. To return forwarding rules from all regions, specify region as # "all".

# For global forwarding rules, if it is set to true, it will ignore # the value for the above region property.

# How often targets should be evaluated/expanded

# Compute API version.

# Use DNS to resolve target names (instances). If set to false (default), # IP addresses specified in the compute.Instance resource is used. If set # to true all the other resolving options are ignored.

# Labels to filter instances by ("key:value-regex" format).

# If running on GCE, this defaults to the local project. # Note: Multiple projects support in targets is experimental and may go away # with future iterations.

# How often to check for lame-ducked targets

# Runtime config project. If running on GCE, this defaults to the project # containing the VM.

# Lame duck targets runtime config name. An operator will create a variable # here to mark a target as lame-ducked.

# Lame duck targets pubsub topic name. An operator will create a message # here to mark a target as lame-ducked.

# Lame duck expiration time. We ignore variables (targets) that have been # updated more than these many seconds ago. This is a safety mechanism for # failing to cleanup. Also, the idea is that if a target has actually # disappeared, automatic targets expansion will take care of that some time # during this expiration period.

# Use an RDS client to get lame-duck-targets. # This option is always true now and will be removed after v0.10.7.

# RDS server options, for example: # rds_server_options { # server_address: "rds-server.xyz:9314" # oauth_config: { # ... # }

# DNS server to use for DNS resolution, instead of system's default. Server # can be specified in the following format: [network://]ip[:port] # where network is one of udp, tcp, tcp4, tcp6, udp4, udp6. # Example: # - "1.1.1.1" // Use default network and port (53) # - "tcp://1.1.1.1" // Use tcp network and default port (53) # - "tcp://1.1.1.1:513 // Use tcp network and port 513

# DNS TTL (time to live). This controls how often backend DNS server will be # queried.

# This option controls for how long cached IP can be used in case of resolve # errors. Default value for this is set to ttl_sec. It should never be # lower than dns_ttl_sec.

# Backend timeout in milliseconds. This option controls how long we'll wait # for the backend DNS server to respond. Note that DNS resolution happens # asynchronously, so DNS resolve time should never really affect the probe. # This timeout affects how soon DNS resolution is retried, if it's hanging.

# Endpoint name. Metrics for a target are identified by a combination of # endpoint name and port name, if specified.

# Optional IP address. If not specified, endpoint name is DNS resolved.

# Endpoint port. If specified, this port will be used by the port-based # probes (e.g. TCP, HTTP), if probe's configuration doesn't specify a port.

# HTTP probe URL. If provided, this field is used by the HTTP probe, if # probe configuration itself doesn't specify URL fields.

# Endpoint labels. These labels can be exported as metrics labels using the # `additional_label` field in the probe configuration.

# RDS server address # Deprecated: This option is now deprecated, please use rds_server_options # instead.

# RDS server options, for example: # rds_server_options { # server_address: "rds-server.xyz:9314" # oauth_config: { # ... # } # }

# GCE targets options.

# Lame duck options. If provided, targets module checks for the lame duck # targets and removes them from the targets list.

# Targets namespace. If this field is unset, we select resources from all # namespaces.

# labelSelector uses the same format as kubernetes API calls. # Example: # labelSelector: "k8s-app" # label k8s-app exists # labelSelector: "role=frontend" # label role=frontend # labelSelector: "!canary" # canary label doesn't exist

# Which resources to target. If value is not empty (""), we use it as a # regex for resource names. # Example: # services: "" // All services. # endpoints: ".*-service" // Endpoints ending with "service".

# portFilter can be used to filter resources by port name. This is useful # for resources like endpoints and services, where each resource may have # multiple ports, and we may hit just a subset of those ports. portFilter # takes a regex -- we apply it on port names if port name is available, # otherwise we apply it port numbers. # Example: ".*-dns", "metrics", ".*-service", etc.

# How often to re-check k8s API servers. Note this field will be irrelevant # when (and if) we move to the watch API. Default is 30s.

# RDS server options, for example: # rds_server_options { # server_address: "rds-server.xyz:9314" # oauth_config: { # ... # } # }

# Resource path specifies the resources to return. Resources paths have the # following format: # <resource_provider>://<resource_type>/<additional_params> # # Examples: # For GCE instances in projectA: "gcp://gce_instances/<projectA>" # Kubernetes Pods : "k8s://pods"

# Filters to filter resources by.

# IP config to specify the IP address to pick for a resource.

# Static endpoints. These endpoints are merged with the resources returned # by the targets type above. # Example: # endpoint { # name: "service-gtwy-1" # ip: "10.1.18.121" # port: 8080 # labels { # key: "service" # value: "products-service" # } # } # endpoint { # name: "frontend-url1" # url: "https://frontend.example.com/url1" # }

# Regex to apply on the targets.

# Exclude lameducks. Lameduck targets can be set through RTC (realtime # configurator) service. This functionality works only if lame_duck_options # are specified.

# Options to control DNS resolution behavior if using Cloudprober's DNS # resolver, which get triggered only if you're setting `resolve_first` probe # setting to true.

# Provide a dns resolver override instead of using the default dns resolver. # Deprecated: This option is now deprecated, please use dns_options instead.

# File that contains resources in either textproto or json format. # Example in textproto format: # # resource { # name: "switch-xx-01" # ip: "10.11.112.3" # port: 8080 # labels { # key: "device_type" # value: "switch" # } # } # resource { # name: "switch-yy-01" # ip: "10.16.110.12" # port: 8080 # }

# If specified, file will be re-read at the given interval.

# Important: if multiple probes use forwarding_rules targets, only the # settings in the definition will take effect. # TODO(manugarg): Fix this behavior. # # For regional forwarding rules, regions to return forwarding rules for. # Default is to return forwarding rules from the region that the VM is # running in. To return forwarding rules from all regions, specify region as # "all".

# For global forwarding rules, if it is set to true, it will ignore # the value for the above region property.

# How often targets should be evaluated/expanded

# Compute API version.

# Use DNS to resolve target names (instances). If set to false (default), # IP addresses specified in the compute.Instance resource is used. If set # to true all the other resolving options are ignored.

# Labels to filter instances by ("key:value-regex" format).

# If running on GCE, this defaults to the local project. # Note: Multiple projects support in targets is experimental and may go away # with future iterations.

# How often to check for lame-ducked targets

# Runtime config project. If running on GCE, this defaults to the project # containing the VM.

# Lame duck targets runtime config name. An operator will create a variable # here to mark a target as lame-ducked.

# Lame duck targets pubsub topic name. An operator will create a message # here to mark a target as lame-ducked.

# Lame duck expiration time. We ignore variables (targets) that have been # updated more than these many seconds ago. This is a safety mechanism for # failing to cleanup. Also, the idea is that if a target has actually # disappeared, automatic targets expansion will take care of that some time # during this expiration period.

# Use an RDS client to get lame-duck-targets. # This option is always true now and will be removed after v0.10.7.

# RDS server options, for example: # rds_server_options { # server_address: "rds-server.xyz:9314" # oauth_config: { # ... # }