Skip to content

monitoring.v1alpha1.scrapeConfig

"ScrapeConfig defines a namespaced Prometheus scrape_config to be aggregated across multiple namespaces into the Prometheus configuration."

Index

Fields

fn new

new(name)

new returns an instance of ScrapeConfig

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

"ScrapeConfigSpec is a specification of the desired configuration for a scrape configuration."

fn spec.withConsulSDConfigs

withConsulSDConfigs(consulSDConfigs)

"ConsulSDConfigs defines a list of Consul service discovery configurations."

fn spec.withConsulSDConfigsMixin

withConsulSDConfigsMixin(consulSDConfigs)

"ConsulSDConfigs defines a list of Consul service discovery configurations."

Note: This function appends passed data to existing values

fn spec.withDnsSDConfigs

withDnsSDConfigs(dnsSDConfigs)

"DNSSDConfigs defines a list of DNS service discovery configurations."

fn spec.withDnsSDConfigsMixin

withDnsSDConfigsMixin(dnsSDConfigs)

"DNSSDConfigs defines a list of DNS service discovery configurations."

Note: This function appends passed data to existing values

fn spec.withFileSDConfigs

withFileSDConfigs(fileSDConfigs)

"FileSDConfigs defines a list of file service discovery configurations."

fn spec.withFileSDConfigsMixin

withFileSDConfigsMixin(fileSDConfigs)

"FileSDConfigs defines a list of file service discovery configurations."

Note: This function appends passed data to existing values

fn spec.withHonorLabels

withHonorLabels(honorLabels)

"HonorLabels chooses the metric's labels on collisions with target labels."

fn spec.withHonorTimestamps

withHonorTimestamps(honorTimestamps)

"HonorTimestamps controls whether Prometheus respects the timestamps present in scraped data."

fn spec.withHttpSDConfigs

withHttpSDConfigs(httpSDConfigs)

"HTTPSDConfigs defines a list of HTTP service discovery configurations."

fn spec.withHttpSDConfigsMixin

withHttpSDConfigsMixin(httpSDConfigs)

"HTTPSDConfigs defines a list of HTTP service discovery configurations."

Note: This function appends passed data to existing values

fn spec.withKeepDroppedTargets

withKeepDroppedTargets(keepDroppedTargets)

"Per-scrape limit on the number of targets dropped by relabeling that will be kept in memory. 0 means no limit. \n It requires Prometheus >= v2.47.0."

fn spec.withKubernetesSDConfigs

withKubernetesSDConfigs(kubernetesSDConfigs)

"KubernetesSDConfigs defines a list of Kubernetes service discovery configurations."

fn spec.withKubernetesSDConfigsMixin

withKubernetesSDConfigsMixin(kubernetesSDConfigs)

"KubernetesSDConfigs defines a list of Kubernetes service discovery configurations."

Note: This function appends passed data to existing values

fn spec.withLabelLimit

withLabelLimit(labelLimit)

"Per-scrape limit on number of labels that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer."

fn spec.withLabelNameLengthLimit

withLabelNameLengthLimit(labelNameLengthLimit)

"Per-scrape limit on length of labels name that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer."

fn spec.withLabelValueLengthLimit

withLabelValueLengthLimit(labelValueLengthLimit)

"Per-scrape limit on length of labels value that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer."

fn spec.withMetricRelabelings

withMetricRelabelings(metricRelabelings)

"MetricRelabelConfigs to apply to samples before ingestion."

fn spec.withMetricRelabelingsMixin

withMetricRelabelingsMixin(metricRelabelings)

"MetricRelabelConfigs to apply to samples before ingestion."

Note: This function appends passed data to existing values

fn spec.withMetricsPath

withMetricsPath(metricsPath)

"MetricsPath HTTP path to scrape for metrics. If empty, Prometheus uses the default value (e.g. /metrics)."

fn spec.withParams

withParams(params)

"Optional HTTP URL parameters"

fn spec.withParamsMixin

withParamsMixin(params)

"Optional HTTP URL parameters"

Note: This function appends passed data to existing values

fn spec.withRelabelings

withRelabelings(relabelings)

"RelabelConfigs defines how to rewrite the target's labels before scraping. Prometheus Operator automatically adds relabelings for a few standard Kubernetes fields. The original scrape job's name is available via the __tmp_prometheus_job_name label. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config"

fn spec.withRelabelingsMixin

withRelabelingsMixin(relabelings)

"RelabelConfigs defines how to rewrite the target's labels before scraping. Prometheus Operator automatically adds relabelings for a few standard Kubernetes fields. The original scrape job's name is available via the __tmp_prometheus_job_name label. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config"

Note: This function appends passed data to existing values

fn spec.withSampleLimit

withSampleLimit(sampleLimit)

"SampleLimit defines per-scrape limit on number of scraped samples that will be accepted."

fn spec.withScheme

withScheme(scheme)

"Configures the protocol scheme used for requests. If empty, Prometheus uses HTTP by default."

fn spec.withScrapeInterval

withScrapeInterval(scrapeInterval)

"ScrapeInterval is the interval between consecutive scrapes."

fn spec.withScrapeTimeout

withScrapeTimeout(scrapeTimeout)

"ScrapeTimeout is the number of seconds to wait until a scrape request times out."

fn spec.withStaticConfigs

withStaticConfigs(staticConfigs)

"StaticConfigs defines a list of static targets with a common label set."

fn spec.withStaticConfigsMixin

withStaticConfigsMixin(staticConfigs)

"StaticConfigs defines a list of static targets with a common label set."

Note: This function appends passed data to existing values

fn spec.withTargetLimit

withTargetLimit(targetLimit)

"TargetLimit defines a limit on the number of scraped targets that will be accepted."

obj spec.authorization

"Authorization header to use on every scrape request."

fn spec.authorization.withType

withType(type)

"Defines the authentication type. The value is case-insensitive. \n \"Basic\" is not a supported value. \n Default: \"Bearer\

obj spec.authorization.credentials

"Selects a key of a Secret in the namespace that contains the credentials for authentication."

fn spec.authorization.credentials.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.authorization.credentials.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.authorization.credentials.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.basicAuth

"BasicAuth information to use on every scrape request."

obj spec.basicAuth.password

"The secret in the service monitor namespace that contains the password for authentication."

fn spec.basicAuth.password.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.basicAuth.password.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.basicAuth.password.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.basicAuth.username

"The secret in the service monitor namespace that contains the username for authentication."

fn spec.basicAuth.username.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.basicAuth.username.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.basicAuth.username.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.consulSDConfigs

"ConsulSDConfigs defines a list of Consul service discovery configurations."

fn spec.consulSDConfigs.withAllow_stale

withAllow_stale(allow_stale)

"Allow stale Consul results (see https://www.consul.io/api/features/consistency.html). Will reduce load on Consul. If unset, Prometheus uses its default value."

fn spec.consulSDConfigs.withDatacenter

withDatacenter(datacenter)

"Consul Datacenter name, if not provided it will use the local Consul Agent Datacenter."

fn spec.consulSDConfigs.withEnable_http2

withEnable_http2(enable_http2)

"Whether to enable HTTP2. If unset, Prometheus uses its default value."

fn spec.consulSDConfigs.withFollow_redirects

withFollow_redirects(follow_redirects)

"Configure whether HTTP requests follow HTTP 3xx redirects. If unset, Prometheus uses its default value."

fn spec.consulSDConfigs.withNamespace

withNamespace(namespace)

"Namespaces are only supported in Consul Enterprise."

fn spec.consulSDConfigs.withNo_proxy

withNo_proxy(no_proxy)

"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."

fn spec.consulSDConfigs.withNode_meta

withNode_meta(node_meta)

"Node metadata key/value pairs to filter nodes for a given service."

fn spec.consulSDConfigs.withNode_metaMixin

withNode_metaMixin(node_meta)

"Node metadata key/value pairs to filter nodes for a given service."

Note: This function appends passed data to existing values

fn spec.consulSDConfigs.withPartition

withPartition(partition)

"Admin Partitions are only supported in Consul Enterprise."

fn spec.consulSDConfigs.withProxy_connect_header

withProxy_connect_header(proxy_connect_header)

"Specifies headers to send to proxies during CONNECT requests."

fn spec.consulSDConfigs.withProxy_connect_headerMixin

withProxy_connect_headerMixin(proxy_connect_header)

"Specifies headers to send to proxies during CONNECT requests."

Note: This function appends passed data to existing values

fn spec.consulSDConfigs.withProxy_from_environment

withProxy_from_environment(proxy_from_environment)

"Use proxy URL indicated by environment variables (HTTP_PROXY, https_proxy, HTTPs_PROXY, https_proxy, and no_proxy) If unset, Prometheus uses its default value."

fn spec.consulSDConfigs.withProxy_url

withProxy_url(proxy_url)

"Optional proxy URL."

fn spec.consulSDConfigs.withRefresh_interval

withRefresh_interval(refresh_interval)

"The time after which the provided names are refreshed. On large setup it might be a good idea to increase this value because the catalog will change all the time. If unset, Prometheus uses its default value."

fn spec.consulSDConfigs.withScheme

withScheme(scheme)

"HTTP Scheme default \"http\

fn spec.consulSDConfigs.withServer

withServer(server)

"A valid string consisting of a hostname or IP followed by an optional port number."

fn spec.consulSDConfigs.withServices

withServices(services)

"A list of services for which targets are retrieved. If omitted, all services are scraped."

fn spec.consulSDConfigs.withServicesMixin

withServicesMixin(services)

"A list of services for which targets are retrieved. If omitted, all services are scraped."

Note: This function appends passed data to existing values

fn spec.consulSDConfigs.withTag_separator

withTag_separator(tag_separator)

"The string by which Consul tags are joined into the tag label. If unset, Prometheus uses its default value."

fn spec.consulSDConfigs.withTags

withTags(tags)

"An optional list of tags used to filter nodes for a given service. Services must contain all tags in the list."

fn spec.consulSDConfigs.withTagsMixin

withTagsMixin(tags)

"An optional list of tags used to filter nodes for a given service. Services must contain all tags in the list."

Note: This function appends passed data to existing values

obj spec.consulSDConfigs.authorization

"Authorization header configuration to authenticate against the Consul Server."

fn spec.consulSDConfigs.authorization.withType

withType(type)

"Defines the authentication type. The value is case-insensitive. \n \"Basic\" is not a supported value. \n Default: \"Bearer\

obj spec.consulSDConfigs.authorization.credentials

"Selects a key of a Secret in the namespace that contains the credentials for authentication."

fn spec.consulSDConfigs.authorization.credentials.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.consulSDConfigs.authorization.credentials.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.consulSDConfigs.authorization.credentials.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.consulSDConfigs.basicAuth

"BasicAuth information to authenticate against the Consul Server. More info: https://prometheus.io/docs/operating/configuration/#endpoints"

obj spec.consulSDConfigs.basicAuth.password

"The secret in the service monitor namespace that contains the password for authentication."

fn spec.consulSDConfigs.basicAuth.password.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.consulSDConfigs.basicAuth.password.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.consulSDConfigs.basicAuth.password.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.consulSDConfigs.basicAuth.username

"The secret in the service monitor namespace that contains the username for authentication."

fn spec.consulSDConfigs.basicAuth.username.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.consulSDConfigs.basicAuth.username.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.consulSDConfigs.basicAuth.username.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.consulSDConfigs.oauth2

"Optional OAuth 2.0 configuration."

fn spec.consulSDConfigs.oauth2.withEndpointParams

withEndpointParams(endpointParams)

"Parameters to append to the token URL"

fn spec.consulSDConfigs.oauth2.withEndpointParamsMixin

withEndpointParamsMixin(endpointParams)

"Parameters to append to the token URL"

Note: This function appends passed data to existing values

fn spec.consulSDConfigs.oauth2.withScopes

withScopes(scopes)

"OAuth2 scopes used for the token request"

fn spec.consulSDConfigs.oauth2.withScopesMixin

withScopesMixin(scopes)

"OAuth2 scopes used for the token request"

Note: This function appends passed data to existing values

fn spec.consulSDConfigs.oauth2.withTokenUrl

withTokenUrl(tokenUrl)

"The URL to fetch the token from"

obj spec.consulSDConfigs.oauth2.clientId

"The secret or configmap containing the OAuth2 client id"

obj spec.consulSDConfigs.oauth2.clientId.configMap

"ConfigMap containing data to use for the targets."

fn spec.consulSDConfigs.oauth2.clientId.configMap.withKey

withKey(key)

"The key to select."

fn spec.consulSDConfigs.oauth2.clientId.configMap.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.consulSDConfigs.oauth2.clientId.configMap.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.consulSDConfigs.oauth2.clientId.secret

"Secret containing data to use for the targets."

fn spec.consulSDConfigs.oauth2.clientId.secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.consulSDConfigs.oauth2.clientId.secret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.consulSDConfigs.oauth2.clientId.secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.consulSDConfigs.oauth2.clientSecret

"The secret containing the OAuth2 client secret"

fn spec.consulSDConfigs.oauth2.clientSecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.consulSDConfigs.oauth2.clientSecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.consulSDConfigs.oauth2.clientSecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.consulSDConfigs.tlsConfig

"TLS Config"

fn spec.consulSDConfigs.tlsConfig.withInsecureSkipVerify

withInsecureSkipVerify(insecureSkipVerify)

"Disable target certificate validation."

fn spec.consulSDConfigs.tlsConfig.withServerName

withServerName(serverName)

"Used to verify the hostname for the targets."

obj spec.consulSDConfigs.tlsConfig.ca

"Certificate authority used when verifying server certificates."

obj spec.consulSDConfigs.tlsConfig.ca.configMap

"ConfigMap containing data to use for the targets."

fn spec.consulSDConfigs.tlsConfig.ca.configMap.withKey

withKey(key)

"The key to select."

fn spec.consulSDConfigs.tlsConfig.ca.configMap.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.consulSDConfigs.tlsConfig.ca.configMap.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.consulSDConfigs.tlsConfig.ca.secret

"Secret containing data to use for the targets."

fn spec.consulSDConfigs.tlsConfig.ca.secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.consulSDConfigs.tlsConfig.ca.secret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.consulSDConfigs.tlsConfig.ca.secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.consulSDConfigs.tlsConfig.cert

"Client certificate to present when doing client-authentication."

obj spec.consulSDConfigs.tlsConfig.cert.configMap

"ConfigMap containing data to use for the targets."

fn spec.consulSDConfigs.tlsConfig.cert.configMap.withKey

withKey(key)

"The key to select."

fn spec.consulSDConfigs.tlsConfig.cert.configMap.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.consulSDConfigs.tlsConfig.cert.configMap.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.consulSDConfigs.tlsConfig.cert.secret

"Secret containing data to use for the targets."

fn spec.consulSDConfigs.tlsConfig.cert.secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.consulSDConfigs.tlsConfig.cert.secret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.consulSDConfigs.tlsConfig.cert.secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.consulSDConfigs.tlsConfig.keySecret

"Secret containing the client key file for the targets."

fn spec.consulSDConfigs.tlsConfig.keySecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.consulSDConfigs.tlsConfig.keySecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.consulSDConfigs.tlsConfig.keySecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.consulSDConfigs.tokenRef

"Consul ACL TokenRef, if not provided it will use the ACL from the local Consul Agent."

fn spec.consulSDConfigs.tokenRef.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.consulSDConfigs.tokenRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.consulSDConfigs.tokenRef.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.dnsSDConfigs

"DNSSDConfigs defines a list of DNS service discovery configurations."

fn spec.dnsSDConfigs.withNames

withNames(names)

"A list of DNS domain names to be queried."

fn spec.dnsSDConfigs.withNamesMixin

withNamesMixin(names)

"A list of DNS domain names to be queried."

Note: This function appends passed data to existing values

fn spec.dnsSDConfigs.withPort

withPort(port)

"The port number used if the query type is not SRV Ignored for SRV records"

fn spec.dnsSDConfigs.withRefreshInterval

withRefreshInterval(refreshInterval)

"RefreshInterval configures the time after which the provided names are refreshed. If not set, Prometheus uses its default value."

fn spec.dnsSDConfigs.withType

withType(type)

"The type of DNS query to perform. One of SRV, A, AAAA or MX. If not set, Prometheus uses its default value."

obj spec.fileSDConfigs

"FileSDConfigs defines a list of file service discovery configurations."

fn spec.fileSDConfigs.withFiles

withFiles(files)

"List of files to be used for file discovery. Recommendation: use absolute paths. While relative paths work, the prometheus-operator project makes no guarantees about the working directory where the configuration file is stored. Files must be mounted using Prometheus.ConfigMaps or Prometheus.Secrets."

fn spec.fileSDConfigs.withFilesMixin

withFilesMixin(files)

"List of files to be used for file discovery. Recommendation: use absolute paths. While relative paths work, the prometheus-operator project makes no guarantees about the working directory where the configuration file is stored. Files must be mounted using Prometheus.ConfigMaps or Prometheus.Secrets."

Note: This function appends passed data to existing values

fn spec.fileSDConfigs.withRefreshInterval

withRefreshInterval(refreshInterval)

"RefreshInterval configures the refresh interval at which Prometheus will reload the content of the files."

obj spec.httpSDConfigs

"HTTPSDConfigs defines a list of HTTP service discovery configurations."

fn spec.httpSDConfigs.withRefreshInterval

withRefreshInterval(refreshInterval)

"RefreshInterval configures the refresh interval at which Prometheus will re-query the endpoint to update the target list."

fn spec.httpSDConfigs.withUrl

withUrl(url)

"URL from which the targets are fetched."

obj spec.httpSDConfigs.authorization

"Authorization header configuration to authenticate against the target HTTP endpoint."

fn spec.httpSDConfigs.authorization.withType

withType(type)

"Defines the authentication type. The value is case-insensitive. \n \"Basic\" is not a supported value. \n Default: \"Bearer\

obj spec.httpSDConfigs.authorization.credentials

"Selects a key of a Secret in the namespace that contains the credentials for authentication."

fn spec.httpSDConfigs.authorization.credentials.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.httpSDConfigs.authorization.credentials.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.httpSDConfigs.authorization.credentials.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.httpSDConfigs.basicAuth

"BasicAuth information to authenticate against the target HTTP endpoint. More info: https://prometheus.io/docs/operating/configuration/#endpoints"

obj spec.httpSDConfigs.basicAuth.password

"The secret in the service monitor namespace that contains the password for authentication."

fn spec.httpSDConfigs.basicAuth.password.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.httpSDConfigs.basicAuth.password.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.httpSDConfigs.basicAuth.password.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.httpSDConfigs.basicAuth.username

"The secret in the service monitor namespace that contains the username for authentication."

fn spec.httpSDConfigs.basicAuth.username.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.httpSDConfigs.basicAuth.username.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.httpSDConfigs.basicAuth.username.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.httpSDConfigs.tlsConfig

"TLS configuration applying to the target HTTP endpoint."

fn spec.httpSDConfigs.tlsConfig.withInsecureSkipVerify

withInsecureSkipVerify(insecureSkipVerify)

"Disable target certificate validation."

fn spec.httpSDConfigs.tlsConfig.withServerName

withServerName(serverName)

"Used to verify the hostname for the targets."

obj spec.httpSDConfigs.tlsConfig.ca

"Certificate authority used when verifying server certificates."

obj spec.httpSDConfigs.tlsConfig.ca.configMap

"ConfigMap containing data to use for the targets."

fn spec.httpSDConfigs.tlsConfig.ca.configMap.withKey

withKey(key)

"The key to select."

fn spec.httpSDConfigs.tlsConfig.ca.configMap.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.httpSDConfigs.tlsConfig.ca.configMap.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.httpSDConfigs.tlsConfig.ca.secret

"Secret containing data to use for the targets."

fn spec.httpSDConfigs.tlsConfig.ca.secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.httpSDConfigs.tlsConfig.ca.secret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.httpSDConfigs.tlsConfig.ca.secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.httpSDConfigs.tlsConfig.cert

"Client certificate to present when doing client-authentication."

obj spec.httpSDConfigs.tlsConfig.cert.configMap

"ConfigMap containing data to use for the targets."

fn spec.httpSDConfigs.tlsConfig.cert.configMap.withKey

withKey(key)

"The key to select."

fn spec.httpSDConfigs.tlsConfig.cert.configMap.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.httpSDConfigs.tlsConfig.cert.configMap.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.httpSDConfigs.tlsConfig.cert.secret

"Secret containing data to use for the targets."

fn spec.httpSDConfigs.tlsConfig.cert.secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.httpSDConfigs.tlsConfig.cert.secret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.httpSDConfigs.tlsConfig.cert.secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.httpSDConfigs.tlsConfig.keySecret

"Secret containing the client key file for the targets."

fn spec.httpSDConfigs.tlsConfig.keySecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.httpSDConfigs.tlsConfig.keySecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.httpSDConfigs.tlsConfig.keySecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.kubernetesSDConfigs

"KubernetesSDConfigs defines a list of Kubernetes service discovery configurations."

fn spec.kubernetesSDConfigs.withRole

withRole(role)

"Role of the Kubernetes entities that should be discovered. Currently the only supported role is \"Node\"."

obj spec.metricRelabelings

"MetricRelabelConfigs to apply to samples before ingestion."

fn spec.metricRelabelings.withAction

withAction(action)

"Action to perform based on the regex matching. \n Uppercase and Lowercase actions require Prometheus >= v2.36.0. DropEqual and KeepEqual actions require Prometheus >= v2.41.0. \n Default: \"Replace\

fn spec.metricRelabelings.withModulus

withModulus(modulus)

"Modulus to take of the hash of the source label values. \n Only applicable when the action is HashMod."

fn spec.metricRelabelings.withRegex

withRegex(regex)

"Regular expression against which the extracted value is matched."

fn spec.metricRelabelings.withReplacement

withReplacement(replacement)

"Replacement value against which a Replace action is performed if the regular expression matches. \n Regex capture groups are available."

fn spec.metricRelabelings.withSeparator

withSeparator(separator)

"Separator is the string between concatenated SourceLabels."

fn spec.metricRelabelings.withSourceLabels

withSourceLabels(sourceLabels)

"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression."

fn spec.metricRelabelings.withSourceLabelsMixin

withSourceLabelsMixin(sourceLabels)

"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression."

Note: This function appends passed data to existing values

fn spec.metricRelabelings.withTargetLabel

withTargetLabel(targetLabel)

"Label to which the resulting string is written in a replacement. \n It is mandatory for Replace, HashMod, Lowercase, Uppercase, KeepEqual and DropEqual actions. \n Regex capture groups are available."

obj spec.relabelings

"RelabelConfigs defines how to rewrite the target's labels before scraping. Prometheus Operator automatically adds relabelings for a few standard Kubernetes fields. The original scrape job's name is available via the __tmp_prometheus_job_name label. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config"

fn spec.relabelings.withAction

withAction(action)

"Action to perform based on the regex matching. \n Uppercase and Lowercase actions require Prometheus >= v2.36.0. DropEqual and KeepEqual actions require Prometheus >= v2.41.0. \n Default: \"Replace\

fn spec.relabelings.withModulus

withModulus(modulus)

"Modulus to take of the hash of the source label values. \n Only applicable when the action is HashMod."

fn spec.relabelings.withRegex

withRegex(regex)

"Regular expression against which the extracted value is matched."

fn spec.relabelings.withReplacement

withReplacement(replacement)

"Replacement value against which a Replace action is performed if the regular expression matches. \n Regex capture groups are available."

fn spec.relabelings.withSeparator

withSeparator(separator)

"Separator is the string between concatenated SourceLabels."

fn spec.relabelings.withSourceLabels

withSourceLabels(sourceLabels)

"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression."

fn spec.relabelings.withSourceLabelsMixin

withSourceLabelsMixin(sourceLabels)

"The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression."

Note: This function appends passed data to existing values

fn spec.relabelings.withTargetLabel

withTargetLabel(targetLabel)

"Label to which the resulting string is written in a replacement. \n It is mandatory for Replace, HashMod, Lowercase, Uppercase, KeepEqual and DropEqual actions. \n Regex capture groups are available."

obj spec.staticConfigs

"StaticConfigs defines a list of static targets with a common label set."

fn spec.staticConfigs.withLabels

withLabels(labels)

"Labels assigned to all metrics scraped from the targets."

fn spec.staticConfigs.withLabelsMixin

withLabelsMixin(labels)

"Labels assigned to all metrics scraped from the targets."

Note: This function appends passed data to existing values

fn spec.staticConfigs.withTargets

withTargets(targets)

"List of targets for this static configuration."

fn spec.staticConfigs.withTargetsMixin

withTargetsMixin(targets)

"List of targets for this static configuration."

Note: This function appends passed data to existing values

obj spec.tlsConfig

"TLS configuration to use on every scrape request"

fn spec.tlsConfig.withInsecureSkipVerify

withInsecureSkipVerify(insecureSkipVerify)

"Disable target certificate validation."

fn spec.tlsConfig.withServerName

withServerName(serverName)

"Used to verify the hostname for the targets."

obj spec.tlsConfig.ca

"Certificate authority used when verifying server certificates."

obj spec.tlsConfig.ca.configMap

"ConfigMap containing data to use for the targets."

fn spec.tlsConfig.ca.configMap.withKey

withKey(key)

"The key to select."

fn spec.tlsConfig.ca.configMap.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.tlsConfig.ca.configMap.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.tlsConfig.ca.secret

"Secret containing data to use for the targets."

fn spec.tlsConfig.ca.secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.tlsConfig.ca.secret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.tlsConfig.ca.secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.tlsConfig.cert

"Client certificate to present when doing client-authentication."

obj spec.tlsConfig.cert.configMap

"ConfigMap containing data to use for the targets."

fn spec.tlsConfig.cert.configMap.withKey

withKey(key)

"The key to select."

fn spec.tlsConfig.cert.configMap.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.tlsConfig.cert.configMap.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.tlsConfig.cert.secret

"Secret containing data to use for the targets."

fn spec.tlsConfig.cert.secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.tlsConfig.cert.secret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.tlsConfig.cert.secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.tlsConfig.keySecret

"Secret containing the client key file for the targets."

fn spec.tlsConfig.keySecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.tlsConfig.keySecret.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"

fn spec.tlsConfig.keySecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"