ScrapeConfig defines a namespaced Prometheus scrape_config to be aggregated across
multiple namespaces into the Prometheus configuration.
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
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: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
Each additional property must conform to the following schema
Type: stringCreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
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.
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.
Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
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.
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.
If this field is specified and the generated name exists, the server will return a 409.
Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
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: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
Each additional property must conform to the following schema
Type: stringManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.
No Additional ItemsManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.
APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
Manager is an identifier of the workflow managing these fields.
Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.
Same definition as creationTimestampName 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
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.
Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
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.
No Additional ItemsOwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.
API version of the referent.
If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
If true, this reference points to the managing controller.
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
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.
Populated 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
Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
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.
Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
spec defines the specification of ScrapeConfigSpec.
azureSDConfigs defines a list of Azure service discovery configurations.
No Additional ItemsAzureSDConfig allow retrieving scrape targets from Azure VMs.
See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#azuresdconfig
authenticationMethod defines the authentication method, either OAuth or ManagedIdentity or SDK.
See https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview
SDK authentication method uses environment variables by default.
See https://learn.microsoft.com/en-us/azure/developer/go/azure-sdk-authentication
basicAuth defines the information to authenticate against the target HTTP endpoint.
More info: https://prometheus.io/docs/operating/configuration/#endpoints
Cannot be set at the same time as authorization, or oAuth2.
password defines a key of a Secret containing the password for
authentication.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
username defines a key of a Secret containing the username for
authentication.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
clientID defines client ID. Only required with the OAuth authentication method.
Must be at least 1 characters long
clientSecret defines client secret. Only required with the OAuth authentication method.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
enableHTTP2 defines whether to enable HTTP2.
environment defines the Azure environment.
Must be at least 1 characters long
followRedirects defines whether HTTP requests follow HTTP 3xx redirects.
oauth2 defines the configuration to use on every scrape request.
clientId defines a key of a Secret or ConfigMap containing the
OAuth2 client's ID.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
clientSecret defines a key of a Secret containing the OAuth2
client's secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
endpointParams configures the HTTP parameters to append to the token
URL.
Each additional property must conform to the following schema
Type: stringproxyConnectHeader 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.
Each additional property must conform to the following schema
Type: array of objectSecretKeySelector selects a key of a Secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrl defines the HTTP proxy server to use.
Must match regular expression:^(http|https|socks5)://.+$
scopes defines the OAuth2 scopes used for the token request.
No Additional ItemstlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.
It requires Prometheus >= v2.43.0.
ca defines the Certificate authority used when verifying server certificates.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
cert defines the Client certificate to present when doing client-authentication.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
insecureSkipVerify defines how to disable target certificate validation.
keySecret defines the Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
maxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverName is used to verify the hostname for the targets.
tokenUrl defines the URL to fetch the token from.
Must be at least 1 characters long
port defines the port to scrape metrics from. If using the public IP address, this must
instead be specified in the relabeling rule.
Value must be greater or equal to 0 and lesser or equal to 65535
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.
Each additional property must conform to the following schema
Type: array of objectSecretKeySelector selects a key of a Secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrl defines the HTTP proxy server to use.
Must match regular expression:^(http|https|socks5)://.+$
refreshInterval defines the time after which the provided names are refreshed.
If not set, Prometheus uses its default value.
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
resourceGroup defines resource group name. Limits discovery to this resource group.
Requires Prometheus v2.35.0 and above
Must be at least 1 characters long
subscriptionID defines subscription ID. Always required.
Must be at least 1 characters long
tenantID defines tenant ID. Only required with the OAuth authentication method.
Must be at least 1 characters long
tlsConfig defies the TLS configuration applying to the target HTTP endpoint.
ca defines the Certificate authority used when verifying server certificates.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
cert defines the Client certificate to present when doing client-authentication.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
insecureSkipVerify defines how to disable target certificate validation.
keySecret defines the Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
maxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverName is used to verify the hostname for the targets.
basicAuth defines information to use on every scrape request.
password defines a key of a Secret containing the password for
authentication.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
username defines a key of a Secret containing the username for
authentication.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
consulSDConfigs defines a list of Consul service discovery configurations.
No Additional ItemsConsulSDConfig defines a Consul service discovery configuration
See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#consulsdconfig
allowStale Consul results (see https://www.consul.io/api/features/consistency.html). Will reduce load on Consul.
If unset, Prometheus uses its default value.
basicAuth defines the information to authenticate against the Consul Server.
More info: https://prometheus.io/docs/operating/configuration/#endpoints
Cannot be set at the same time as authorization, or oauth2.
password defines a key of a Secret containing the password for
authentication.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
username defines a key of a Secret containing the username for
authentication.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
datacenter defines the consul Datacenter name, if not provided it will use the local Consul Agent Datacenter.
Must be at least 1 characters long
enableHTTP2 defines whether to enable HTTP2.
filter defines the filter expression used to filter the catalog results.
See https://www.consul.io/api-docs/catalog#list-services
It requires Prometheus >= 3.0.0.
Must be at least 1 characters long
followRedirects defines whether HTTP requests follow HTTP 3xx redirects.
namespace are only supported in Consul Enterprise.
It requires Prometheus >= 2.28.0.
Must be at least 1 characters long
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.
Each additional property must conform to the following schema
Type: stringoauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint.
Cannot be set at the same time as authorization, or basicAuth.
clientId defines a key of a Secret or ConfigMap containing the
OAuth2 client's ID.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
clientSecret defines a key of a Secret containing the OAuth2
client's secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
endpointParams configures the HTTP parameters to append to the token
URL.
Each additional property must conform to the following schema
Type: stringproxyConnectHeader 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.
Each additional property must conform to the following schema
Type: array of objectSecretKeySelector selects a key of a Secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrl defines the HTTP proxy server to use.
Must match regular expression:^(http|https|socks5)://.+$
scopes defines the OAuth2 scopes used for the token request.
No Additional ItemstlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.
It requires Prometheus >= v2.43.0.
ca defines the Certificate authority used when verifying server certificates.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
cert defines the Client certificate to present when doing client-authentication.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
insecureSkipVerify defines how to disable target certificate validation.
keySecret defines the Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
maxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverName is used to verify the hostname for the targets.
tokenUrl defines the URL to fetch the token from.
Must be at least 1 characters long
partition defines the admin Partitions are only supported in Consul Enterprise.
Must be at least 1 characters long
pathPrefix defines the prefix for URIs for when consul is behind an API gateway (reverse proxy).
It requires Prometheus >= 2.45.0.
Must be at least 1 characters long
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.
Each additional property must conform to the following schema
Type: array of objectSecretKeySelector selects a key of a Secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrl defines the HTTP proxy server to use.
Must match regular expression:^(http|https|socks5)://.+$
refreshInterval defines the time after which the provided names are refreshed.
If not set, Prometheus uses its default value.
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
scheme defines the HTTP Scheme.
server defines the consul server address. A valid string consisting of a hostname or IP followed by an optional port number.
Must be at least 1 characters long
services defines a list of services for which targets are retrieved. If omitted, all services are scraped.
No Additional ItemstagSeparator defines the string by which Consul tags are joined into the tag label.
If unset, Prometheus uses its default value.
Must be at least 1 characters long
tlsConfig defines the TLS configuration to connect to the Consul API.
ca defines the Certificate authority used when verifying server certificates.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
cert defines the Client certificate to present when doing client-authentication.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
insecureSkipVerify defines how to disable target certificate validation.
keySecret defines the Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
maxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverName is used to verify the hostname for the targets.
tokenRef defines the consul ACL TokenRef, if not provided it will use the ACL from the local Consul Agent.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
convertClassicHistogramsToNHCB defines whether to convert all scraped classic histograms into a native histogram with custom buckets.
It requires Prometheus >= v3.0.0.
digitalOceanSDConfigs defines a list of DigitalOcean service discovery configurations.
No Additional ItemsDigitalOceanSDConfig allow retrieving scrape targets from DigitalOcean's Droplets API.
This service discovery uses the public IPv4 address by default, by that can be changed with relabeling
See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#digitaloceansdconfig
enableHTTP2 defines whether to enable HTTP2.
followRedirects defines whether HTTP requests follow HTTP 3xx redirects.
oauth2 defines the configuration to use on every scrape request.
clientId defines a key of a Secret or ConfigMap containing the
OAuth2 client's ID.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
clientSecret defines a key of a Secret containing the OAuth2
client's secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
endpointParams configures the HTTP parameters to append to the token
URL.
Each additional property must conform to the following schema
Type: stringproxyConnectHeader 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.
Each additional property must conform to the following schema
Type: array of objectSecretKeySelector selects a key of a Secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrl defines the HTTP proxy server to use.
Must match regular expression:^(http|https|socks5)://.+$
scopes defines the OAuth2 scopes used for the token request.
No Additional ItemstlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.
It requires Prometheus >= v2.43.0.
ca defines the Certificate authority used when verifying server certificates.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
cert defines the Client certificate to present when doing client-authentication.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
insecureSkipVerify defines how to disable target certificate validation.
keySecret defines the Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
maxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverName is used to verify the hostname for the targets.
tokenUrl defines the URL to fetch the token from.
Must be at least 1 characters long
port defines the port to scrape metrics from. If using the public IP address, this must
Value must be greater or equal to 0 and lesser or equal to 65535
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.
Each additional property must conform to the following schema
Type: array of objectSecretKeySelector selects a key of a Secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrl defines the HTTP proxy server to use.
Must match regular expression:^(http|https|socks5)://.+$
refreshInterval defines the time after which the provided names are refreshed.
If not set, Prometheus uses its default value.
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
tlsConfig defines the TLS configuration to connect to the Consul API.
ca defines the Certificate authority used when verifying server certificates.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
cert defines the Client certificate to present when doing client-authentication.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
insecureSkipVerify defines how to disable target certificate validation.
keySecret defines the Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
maxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverName is used to verify the hostname for the targets.
dnsSDConfigs defines a list of DNS service discovery configurations.
No Additional ItemsDNSSDConfig allows specifying a set of DNS domain names which are periodically queried to discover a list of targets.
The DNS servers to be contacted are read from /etc/resolv.conf.
See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#dnssdconfig
names defines a list of DNS domain names to be queried.
Must contain a minimum of 1 items
Must be at least 1 characters long
port defines the port to scrape metrics from. If using the public IP address, this must
Ignored for SRV records
Value must be greater or equal to 0 and lesser or equal to 65535
refreshInterval defines the time after which the provided names are refreshed.
If not set, Prometheus uses its default value.
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
dockerSDConfigs defines a list of Docker service discovery configurations.
No Additional ItemsDocker 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/#dockersdconfig
basicAuth defines information to use on every scrape request.
password defines a key of a Secret containing the password for
authentication.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
username defines a key of a Secret containing the username for
authentication.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
enableHTTP2 defines whether to enable HTTP2.
filters defines filters to limit the discovery process to a subset of the available resources.
No Additional ItemsFilter name and value pairs to limit the discovery process to a subset of available resources.
name of the Filter.
values defines values to filter on.
Must contain a minimum of 1 items
Must be at least 1 characters long
followRedirects defines whether HTTP requests follow HTTP 3xx redirects.
host defines the address of the docker daemon
Must be at least 1 characters long
hostNetworkingHost defines the host to use if the container is in host networking mode.
Must be at least 1 characters long
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.
oauth2 defines the configuration to use on every scrape request.
clientId defines a key of a Secret or ConfigMap containing the
OAuth2 client's ID.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
clientSecret defines a key of a Secret containing the OAuth2
client's secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
endpointParams configures the HTTP parameters to append to the token
URL.
Each additional property must conform to the following schema
Type: stringproxyConnectHeader 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.
Each additional property must conform to the following schema
Type: array of objectSecretKeySelector selects a key of a Secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrl defines the HTTP proxy server to use.
Must match regular expression:^(http|https|socks5)://.+$
scopes defines the OAuth2 scopes used for the token request.
No Additional ItemstlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.
It requires Prometheus >= v2.43.0.
ca defines the Certificate authority used when verifying server certificates.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
cert defines the Client certificate to present when doing client-authentication.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
insecureSkipVerify defines how to disable target certificate validation.
keySecret defines the Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
maxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverName is used to verify the hostname for the targets.
tokenUrl defines the URL to fetch the token from.
Must be at least 1 characters long
port defines the port to scrape metrics from. If using the public IP address, this must
Value must be greater or equal to 0 and lesser or equal to 65535
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.
Each additional property must conform to the following schema
Type: array of objectSecretKeySelector selects a key of a Secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrl defines the HTTP proxy server to use.
Must match regular expression:^(http|https|socks5)://.+$
refreshInterval defines the time after which the provided names are refreshed.
If not set, Prometheus uses its default value.
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
tlsConfig defines the TLS configuration to connect to the Consul API.
ca defines the Certificate authority used when verifying server certificates.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
cert defines the Client certificate to present when doing client-authentication.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
insecureSkipVerify defines how to disable target certificate validation.
keySecret defines the Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
maxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverName is used to verify the hostname for the targets.
dockerSwarmSDConfigs defines a list of Dockerswarm service discovery configurations.
No Additional ItemsDockerSwarmSDConfig configurations allow retrieving scrape targets from Docker Swarm engine.
See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#dockerswarmsdconfig
basicAuth defines information to use on every scrape request.
password defines a key of a Secret containing the password for
authentication.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
username defines a key of a Secret containing the username for
authentication.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
enableHTTP2 defines whether to enable HTTP2.
filters defines the filters to limit the discovery process to a subset of available
resources.
The available filters are listed in the upstream documentation:
Services: https://docs.docker.com/engine/api/v1.40/#operation/ServiceList
Tasks: https://docs.docker.com/engine/api/v1.40/#operation/TaskList
Nodes: https://docs.docker.com/engine/api/v1.40/#operation/NodeList
Filter name and value pairs to limit the discovery process to a subset of available resources.
name of the Filter.
values defines values to filter on.
Must contain a minimum of 1 items
Must be at least 1 characters long
followRedirects defines whether HTTP requests follow HTTP 3xx redirects.
host defines the address of the Docker daemon
Must match regular expression:^[a-zA-Z][a-zA-Z0-9+.-]*://.+$
oauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint.
Cannot be set at the same time as authorization, or basicAuth.
clientId defines a key of a Secret or ConfigMap containing the
OAuth2 client's ID.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
clientSecret defines a key of a Secret containing the OAuth2
client's secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
endpointParams configures the HTTP parameters to append to the token
URL.
Each additional property must conform to the following schema
Type: stringproxyConnectHeader 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.
Each additional property must conform to the following schema
Type: array of objectSecretKeySelector selects a key of a Secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrl defines the HTTP proxy server to use.
Must match regular expression:^(http|https|socks5)://.+$
scopes defines the OAuth2 scopes used for the token request.
No Additional ItemstlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.
It requires Prometheus >= v2.43.0.
ca defines the Certificate authority used when verifying server certificates.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
cert defines the Client certificate to present when doing client-authentication.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
insecureSkipVerify defines how to disable target certificate validation.
keySecret defines the Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
maxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverName is used to verify the hostname for the targets.
tokenUrl defines the URL to fetch the token from.
Must be at least 1 characters long
port defines the port to scrape metrics from. If using the public IP address, this must
tasks and services that don't have published ports.
Value must be greater or equal to 0 and lesser or equal to 65535
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.
Each additional property must conform to the following schema
Type: array of objectSecretKeySelector selects a key of a Secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrl defines the HTTP proxy server to use.
Must match regular expression:^(http|https|socks5)://.+$
refreshInterval defines the time after which the provided names are refreshed.
If not set, Prometheus uses its default value.
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
role of the targets to retrieve. Must be Services, Tasks, or Nodes.
tlsConfig defines the TLS configuration to connect to the Consul API.
ca defines the Certificate authority used when verifying server certificates.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
cert defines the Client certificate to present when doing client-authentication.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
insecureSkipVerify defines how to disable target certificate validation.
keySecret defines the Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
maxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverName is used to verify the hostname for the targets.
ec2SDConfigs defines a list of EC2 service discovery configurations.
No Additional ItemsEC2SDConfig allow retrieving scrape targets from AWS EC2 instances.
The private IP address is used by default, but may be changed to the public IP address with relabeling.
The IAM credentials used must have the ec2:DescribeInstances permission to discover scrape targets
See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#ec2sdconfig
The EC2 service discovery requires AWS API keys or role ARN for authentication.
BasicAuth, Authorization and OAuth2 fields are not present on purpose.
accessKey defines the AWS API key.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
enableHTTP2 defines whether to enable HTTP2.
It requires Prometheus >= v2.41.0
filters can be used optionally to filter the instance list by other criteria.
Available filter criteria can be found here:
https://docs.aws.amazon.com/AWSEC2/latest/APIReference/APIDescribeInstances.html
Filter API documentation: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/APIFilter.html
It requires Prometheus >= v2.3.0
Filter name and value pairs to limit the discovery process to a subset of available resources.
name of the Filter.
values defines values to filter on.
Must contain a minimum of 1 items
Must be at least 1 characters long
followRedirects defines whether HTTP requests follow HTTP 3xx redirects.
It requires Prometheus >= v2.41.0
port defines the port to scrape metrics from. If using the public IP address, this must
instead be specified in the relabeling rule.
Value must be greater or equal to 0 and lesser or equal to 65535
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.
Each additional property must conform to the following schema
Type: array of objectSecretKeySelector selects a key of a Secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrl defines the HTTP proxy server to use.
Must match regular expression:^(http|https|socks5)://.+$
refreshInterval defines the time after which the provided names are refreshed.
If not set, Prometheus uses its default value.
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
region defines the AWS region.
Must be at least 1 characters long
roleARN defines an alternative to using AWS API keys.
Must be at least 1 characters long
secretKey defines the AWS API secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
tlsConfig defines the TLS configuration to connect to the Consul API.
It requires Prometheus >= v2.41.0
ca defines the Certificate authority used when verifying server certificates.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
cert defines the Client certificate to present when doing client-authentication.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
insecureSkipVerify defines how to disable target certificate validation.
keySecret defines the Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
maxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverName is used to verify the hostname for the targets.
enableCompression when false, Prometheus will request uncompressed response from the scraped target.
It requires Prometheus >= v2.49.0.
If unset, Prometheus uses true by default.
enableHTTP2 defines whether to enable HTTP2.
eurekaSDConfigs defines a list of Eureka service discovery configurations.
No Additional ItemsEureka SD configurations allow retrieving scrape targets using the Eureka REST API.
Prometheus will periodically check the REST endpoint and create a target for every app instance.
See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#eurekasdconfig
basicAuth defines the BasicAuth information to use on every scrape request.
password defines a key of a Secret containing the password for
authentication.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
username defines a key of a Secret containing the username for
authentication.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
enableHTTP2 defines whether to enable HTTP2.
followRedirects defines whether HTTP requests follow HTTP 3xx redirects.
oauth2 defines the configuration to use on every scrape request.
clientId defines a key of a Secret or ConfigMap containing the
OAuth2 client's ID.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
clientSecret defines a key of a Secret containing the OAuth2
client's secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
endpointParams configures the HTTP parameters to append to the token
URL.
Each additional property must conform to the following schema
Type: stringproxyConnectHeader 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.
Each additional property must conform to the following schema
Type: array of objectSecretKeySelector selects a key of a Secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrl defines the HTTP proxy server to use.
Must match regular expression:^(http|https|socks5)://.+$
scopes defines the OAuth2 scopes used for the token request.
No Additional ItemstlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.
It requires Prometheus >= v2.43.0.
ca defines the Certificate authority used when verifying server certificates.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
cert defines the Client certificate to present when doing client-authentication.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
insecureSkipVerify defines how to disable target certificate validation.
keySecret defines the Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
maxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverName is used to verify the hostname for the targets.
tokenUrl defines the URL to fetch the token from.
Must be at least 1 characters long
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.
Each additional property must conform to the following schema
Type: array of objectSecretKeySelector selects a key of a Secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrl defines the HTTP proxy server to use.
Must match regular expression:^(http|https|socks5)://.+$
refreshInterval defines the time after which the provided names are refreshed.
If not set, Prometheus uses its default value.
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
server defines the URL to connect to the Eureka server.
Must match regular expression:^http(s)?://.+$
Must be at least 1 characters long
tlsConfig defines the TLS configuration to connect to the Consul API.
ca defines the Certificate authority used when verifying server certificates.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
cert defines the Client certificate to present when doing client-authentication.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
insecureSkipVerify defines how to disable target certificate validation.
keySecret defines the Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
maxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverName is used to verify the hostname for the targets.
fallbackScrapeProtocol defines the protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type.
It requires Prometheus >= v3.0.0.
fileSDConfigs defines a list of file service discovery configurations.
No Additional ItemsFileSDConfig defines a Prometheus file service discovery configuration
See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#filesdconfig
files defines the 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.
Must contain a minimum of 1 items
SDFile represents a file used for service discovery
Must match regular expression:^[^*]*(\*[^/]*)?\.(json|yml|yaml|JSON|YML|YAML)$
refreshInterval defines the time after which the provided names are refreshed.
If not set, Prometheus uses its default value.
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
gceSDConfigs defines a list of GCE service discovery configurations.
No Additional ItemsGCESDConfig configures scrape targets from GCP GCE instances.
The private IP address is used by default, but may be changed to
the public IP address with relabeling.
See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#gcesdconfig
The GCE service discovery will load the Google Cloud credentials
from the file specified by the GOOGLEAPPLICATIONCREDENTIALS environment variable.
See https://cloud.google.com/kubernetes-engine/docs/tutorials/authenticating-to-cloud-platform
A pre-requisite for using GCESDConfig is that a Secret containing valid
Google Cloud credentials is mounted into the Prometheus or PrometheusAgent
pod via the .spec.secrets field and that the GOOGLEAPPLICATIONCREDENTIALS
environment variable is set to /etc/prometheus/secrets/<secret-name>/<credentials-filename.json>.
filter defines the filter that can be used optionally to filter the instance list by other criteria
Syntax of this filter is described in the filter query parameter section:
https://cloud.google.com/compute/docs/reference/latest/instances/list
Must be at least 1 characters long
port defines the port to scrape metrics from. If using the public IP address, this must
instead be specified in the relabeling rule.
Value must be greater or equal to 0 and lesser or equal to 65535
project defines the Google Cloud Project ID
Must be at least 1 characters long
refreshInterval defines the time after which the provided names are refreshed.
If not set, Prometheus uses its default value.
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
tagSeparator defines the tag separator is used to separate the tags on concatenation
Must be at least 1 characters long
zone defines the zone of the scrape targets. If you need multiple zones use multiple GCESDConfigs.
Must be at least 1 characters long
hetznerSDConfigs defines a list of Hetzner service discovery configurations.
No Additional ItemsHetznerSDConfig allow retrieving scrape targets from Hetzner Cloud API and Robot API.
This service discovery uses the public IPv4 address by default, but that can be changed with relabeling
See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#hetznersdconfig
basicAuth defines information to use on every scrape request.
password defines a key of a Secret containing the password for
authentication.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
username defines a key of a Secret containing the username for
authentication.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
enableHTTP2 defines whether to enable HTTP2.
followRedirects defines whether HTTP requests follow HTTP 3xx redirects.
labelSelector defines the label selector used to filter the servers when fetching them from the API.
It requires Prometheus >= v3.5.0.
Must be at least 1 characters long
oauth2 defines the configuration to use on every scrape request.
clientId defines a key of a Secret or ConfigMap containing the
OAuth2 client's ID.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
clientSecret defines a key of a Secret containing the OAuth2
client's secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
endpointParams configures the HTTP parameters to append to the token
URL.
Each additional property must conform to the following schema
Type: stringproxyConnectHeader 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.
Each additional property must conform to the following schema
Type: array of objectSecretKeySelector selects a key of a Secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrl defines the HTTP proxy server to use.
Must match regular expression:^(http|https|socks5)://.+$
scopes defines the OAuth2 scopes used for the token request.
No Additional ItemstlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.
It requires Prometheus >= v2.43.0.
ca defines the Certificate authority used when verifying server certificates.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
cert defines the Client certificate to present when doing client-authentication.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
insecureSkipVerify defines how to disable target certificate validation.
keySecret defines the Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
maxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverName is used to verify the hostname for the targets.
tokenUrl defines the URL to fetch the token from.
Must be at least 1 characters long
port defines the port to scrape metrics from. If using the public IP address, this must
Value must be greater or equal to 0 and lesser or equal to 65535
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.
Each additional property must conform to the following schema
Type: array of objectSecretKeySelector selects a key of a Secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrl defines the HTTP proxy server to use.
Must match regular expression:^(http|https|socks5)://.+$
refreshInterval defines the time after which the provided names are refreshed.
If not set, Prometheus uses its default value.
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
role defines the Hetzner role of entities that should be discovered.
tlsConfig defines the TLS configuration to connect to the Consul API.
ca defines the Certificate authority used when verifying server certificates.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
cert defines the Client certificate to present when doing client-authentication.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
insecureSkipVerify defines how to disable target certificate validation.
keySecret defines the Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
maxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverName is used to verify the hostname for the targets.
honorLabels defines when true the metric's labels when they collide
with the target's labels.
honorTimestamps defines whether Prometheus preserves the timestamps
when exposed by the target.
httpSDConfigs defines a list of HTTP service discovery configurations.
No Additional ItemsHTTPSDConfig defines a prometheus HTTP service discovery configuration
See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#httpsdconfig
basicAuth defines information to use on every scrape request.
More info: https://prometheus.io/docs/operating/configuration/#endpoints
Cannot be set at the same time as authorization, or oAuth2.
password defines a key of a Secret containing the password for
authentication.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
username defines a key of a Secret containing the username for
authentication.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
enableHTTP2 defines whether to enable HTTP2.
followRedirects defines whether HTTP requests follow HTTP 3xx redirects.
oauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint.
Cannot be set at the same time as authorization, or basicAuth.
clientId defines a key of a Secret or ConfigMap containing the
OAuth2 client's ID.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
clientSecret defines a key of a Secret containing the OAuth2
client's secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
endpointParams configures the HTTP parameters to append to the token
URL.
Each additional property must conform to the following schema
Type: stringproxyConnectHeader 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.
Each additional property must conform to the following schema
Type: array of objectSecretKeySelector selects a key of a Secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrl defines the HTTP proxy server to use.
Must match regular expression:^(http|https|socks5)://.+$
scopes defines the OAuth2 scopes used for the token request.
No Additional ItemstlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.
It requires Prometheus >= v2.43.0.
ca defines the Certificate authority used when verifying server certificates.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
cert defines the Client certificate to present when doing client-authentication.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
insecureSkipVerify defines how to disable target certificate validation.
keySecret defines the Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
maxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverName is used to verify the hostname for the targets.
tokenUrl defines the URL to fetch the token from.
Must be at least 1 characters long
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.
Each additional property must conform to the following schema
Type: array of objectSecretKeySelector selects a key of a Secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrl defines the HTTP proxy server to use.
Must match regular expression:^(http|https|socks5)://.+$
refreshInterval defines the time after which the provided names are refreshed.
If not set, Prometheus uses its default value.
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
tlsConfig defines the TLS configuration applying to the target HTTP endpoint.
ca defines the Certificate authority used when verifying server certificates.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
cert defines the Client certificate to present when doing client-authentication.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
insecureSkipVerify defines how to disable target certificate validation.
keySecret defines the Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
maxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverName is used to verify the hostname for the targets.
url defines the URL from which the targets are fetched.
Must match regular expression:^http(s)?://.+$
Must be at least 1 characters long
ionosSDConfigs defines a list of IONOS service discovery configurations.
No Additional ItemsIonosSDConfig configurations allow retrieving scrape targets from IONOS resources.
See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#ionossdconfig
datacenterID defines the unique ID of the IONOS data center.
Must be at least 1 characters long
enableHTTP2 defines whether to enable HTTP2.
followRedirects defines whether HTTP requests follow HTTP 3xx redirects.
oauth2 defines the configuration to use on every scrape request.
clientId defines a key of a Secret or ConfigMap containing the
OAuth2 client's ID.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
clientSecret defines a key of a Secret containing the OAuth2
client's secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
endpointParams configures the HTTP parameters to append to the token
URL.
Each additional property must conform to the following schema
Type: stringproxyConnectHeader 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.
Each additional property must conform to the following schema
Type: array of objectSecretKeySelector selects a key of a Secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrl defines the HTTP proxy server to use.
Must match regular expression:^(http|https|socks5)://.+$
scopes defines the OAuth2 scopes used for the token request.
No Additional ItemstlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.
It requires Prometheus >= v2.43.0.
ca defines the Certificate authority used when verifying server certificates.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
cert defines the Client certificate to present when doing client-authentication.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
insecureSkipVerify defines how to disable target certificate validation.
keySecret defines the Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
maxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverName is used to verify the hostname for the targets.
tokenUrl defines the URL to fetch the token from.
Must be at least 1 characters long
port defines the port to scrape metrics from. If using the public IP address, this must
Value must be greater or equal to 0 and lesser or equal to 65535
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.
Each additional property must conform to the following schema
Type: array of objectSecretKeySelector selects a key of a Secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrl defines the HTTP proxy server to use.
Must match regular expression:^(http|https|socks5)://.+$
refreshInterval defines the time after which the provided names are refreshed.
If not set, Prometheus uses its default value.
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
tlsConfig defines the TLS configuration to connect to the Consul API.
ca defines the Certificate authority used when verifying server certificates.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
cert defines the Client certificate to present when doing client-authentication.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
insecureSkipVerify defines how to disable target certificate validation.
keySecret defines the Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
maxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverName is used to verify the hostname for the targets.
jobName defines the value of the job label assigned to the scraped metrics by default.
The job_name field in the rendered scrape configuration is always controlled by the
operator to prevent duplicate job names, which Prometheus does not allow. Instead the
job label is set by means of relabeling configs.
Must be at least 1 characters long
keepDroppedTargets defines the per-scrape limit on the number of targets dropped by relabeling
that will be kept in memory. 0 means no limit.
It requires Prometheus >= v2.47.0.
kubernetesSDConfigs defines a list of Kubernetes service discovery configurations.
No Additional ItemsKubernetesSDConfig allows retrieving scrape targets from Kubernetes' REST API.
See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#kubernetessdconfig
apiServer defines the API server address consisting of a hostname or IP address followed
by an optional port number.
If left empty, Prometheus is assumed to run inside
of the cluster. It will discover API servers automatically and use the pod's
CA certificate and bearer token file at /var/run/secrets/kubernetes.io/serviceaccount/.
Must be at least 1 characters long
attachMetadata defines the metadata to attach to discovered targets.
It requires Prometheus >= v2.35.0 when using the Pod role and
Prometheus >= v2.37.0 for Endpoints and Endpointslice roles.
node attaches node metadata to discovered targets.
When set to true, Prometheus must have the get permission on the
Nodes objects.
Only valid for Pod, Endpoint and Endpointslice roles.
basicAuth defines information to use on every scrape request.
Cannot be set at the same time as authorization, or oauth2.
password defines a key of a Secret containing the password for
authentication.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
username defines a key of a Secret containing the username for
authentication.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
enableHTTP2 defines whether to enable HTTP2.
followRedirects defines whether HTTP requests follow HTTP 3xx redirects.
namespaces defines the namespace discovery. If omitted, Prometheus discovers targets across all namespaces.
names defines a list of namespaces where to watch for resources.
If empty and ownNamespace isn't true, Prometheus watches for resources in all namespaces.
ownNamespace includes the namespace in which the Prometheus pod runs to the list of watched namespaces.
oauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint.
Cannot be set at the same time as authorization, or basicAuth.
clientId defines a key of a Secret or ConfigMap containing the
OAuth2 client's ID.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
clientSecret defines a key of a Secret containing the OAuth2
client's secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
endpointParams configures the HTTP parameters to append to the token
URL.
Each additional property must conform to the following schema
Type: stringproxyConnectHeader 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.
Each additional property must conform to the following schema
Type: array of objectSecretKeySelector selects a key of a Secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrl defines the HTTP proxy server to use.
Must match regular expression:^(http|https|socks5)://.+$
scopes defines the OAuth2 scopes used for the token request.
No Additional ItemstlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.
It requires Prometheus >= v2.43.0.
ca defines the Certificate authority used when verifying server certificates.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
cert defines the Client certificate to present when doing client-authentication.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
insecureSkipVerify defines how to disable target certificate validation.
keySecret defines the Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
maxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverName is used to verify the hostname for the targets.
tokenUrl defines the URL to fetch the token from.
Must be at least 1 characters long
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.
Each additional property must conform to the following schema
Type: array of objectSecretKeySelector selects a key of a Secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrl defines the HTTP proxy server to use.
Must match regular expression:^(http|https|socks5)://.+$
role defines the Kubernetes role of the entities that should be discovered.
Role Endpointslice requires Prometheus >= v2.21.0
selectors defines the selector to select objects.
It requires Prometheus >= v2.17.0
K8SSelectorConfig is Kubernetes Selector Config
field defines an optional field selector to limit the service discovery to resources which have fields with specific values.
e.g: metadata.name=foobar
Must be at least 1 characters long
label defines an optional label selector to limit the service discovery to resources with specific labels and label values.
e.g: node.kubernetes.io/instance-type=master
Must be at least 1 characters long
role defines the type of Kubernetes resource to limit the service discovery to.
Accepted values are: Node, Pod, Endpoints, EndpointSlice, Service, Ingress.
tlsConfig defines the TLS configuration to connect to the Kubernetes API.
ca defines the Certificate authority used when verifying server certificates.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
cert defines the Client certificate to present when doing client-authentication.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
insecureSkipVerify defines how to disable target certificate validation.
keySecret defines the Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
maxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverName is used to verify the hostname for the targets.
kumaSDConfigs defines a list of Kuma service discovery configurations.
No Additional ItemsKumaSDConfig allow retrieving scrape targets from Kuma's control plane.
See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#kumasdconfig
basicAuth defines information to use on every scrape request.
password defines a key of a Secret containing the password for
authentication.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
username defines a key of a Secret containing the username for
authentication.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
clientID is used by Kuma Control Plane to compute Monitoring Assignment for specific Prometheus backend.
It requires Prometheus >= v2.50.0.
Must be at least 1 characters long
enableHTTP2 defines whether to enable HTTP2.
fetchTimeout defines the time after which the monitoring assignments are refreshed.
Must match regular expression:^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
followRedirects defines whether HTTP requests follow HTTP 3xx redirects.
oauth2 defines the configuration to use on every scrape request.
clientId defines a key of a Secret or ConfigMap containing the
OAuth2 client's ID.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
clientSecret defines a key of a Secret containing the OAuth2
client's secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
endpointParams configures the HTTP parameters to append to the token
URL.
Each additional property must conform to the following schema
Type: stringproxyConnectHeader 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.
Each additional property must conform to the following schema
Type: array of objectSecretKeySelector selects a key of a Secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrl defines the HTTP proxy server to use.
Must match regular expression:^(http|https|socks5)://.+$
scopes defines the OAuth2 scopes used for the token request.
No Additional ItemstlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.
It requires Prometheus >= v2.43.0.
ca defines the Certificate authority used when verifying server certificates.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
cert defines the Client certificate to present when doing client-authentication.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
insecureSkipVerify defines how to disable target certificate validation.
keySecret defines the Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
maxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverName is used to verify the hostname for the targets.
tokenUrl defines the URL to fetch the token from.
Must be at least 1 characters long
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.
Each additional property must conform to the following schema
Type: array of objectSecretKeySelector selects a key of a Secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrl defines the HTTP proxy server to use.
Must match regular expression:^(http|https|socks5)://.+$
refreshInterval defines the time after which the provided names are refreshed.
If not set, Prometheus uses its default value.
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
server defines the address of the Kuma Control Plane's MADS xDS server.
Must match regular expression:^https?://.+$
tlsConfig defines the TLS configuration to connect to the Consul API.
ca defines the Certificate authority used when verifying server certificates.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
cert defines the Client certificate to present when doing client-authentication.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
insecureSkipVerify defines how to disable target certificate validation.
keySecret defines the Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
maxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverName is used to verify the hostname for the targets.
labelLimit defines the per-scrape limit on number of labels that will be accepted for a sample.
Only valid in Prometheus versions 2.27.0 and newer.
labelNameLengthLimit defines the 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.
labelValueLengthLimit defines the 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.
lightSailSDConfigs defines a list of Lightsail service discovery configurations.
No Additional ItemsLightSailSDConfig configurations allow retrieving scrape targets from AWS Lightsail instances.
See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#lightsailsdconfig
accessKey defines the AWS API key.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
basicAuth defines information to use on every scrape request.
Cannot be set at the same time as authorization, or oauth2.
password defines a key of a Secret containing the password for
authentication.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
username defines a key of a Secret containing the username for
authentication.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
enableHTTP2 defines whether to enable HTTP2.
endpoint defines the custom endpoint to be used.
Must be at least 1 characters long
followRedirects defines whether HTTP requests follow HTTP 3xx redirects.
oauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint.
Cannot be set at the same time as authorization, or basicAuth.
clientId defines a key of a Secret or ConfigMap containing the
OAuth2 client's ID.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
clientSecret defines a key of a Secret containing the OAuth2
client's secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
endpointParams configures the HTTP parameters to append to the token
URL.
Each additional property must conform to the following schema
Type: stringproxyConnectHeader 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.
Each additional property must conform to the following schema
Type: array of objectSecretKeySelector selects a key of a Secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrl defines the HTTP proxy server to use.
Must match regular expression:^(http|https|socks5)://.+$
scopes defines the OAuth2 scopes used for the token request.
No Additional ItemstlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.
It requires Prometheus >= v2.43.0.
ca defines the Certificate authority used when verifying server certificates.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
cert defines the Client certificate to present when doing client-authentication.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
insecureSkipVerify defines how to disable target certificate validation.
keySecret defines the Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
maxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverName is used to verify the hostname for the targets.
tokenUrl defines the URL to fetch the token from.
Must be at least 1 characters long
port defines the port to scrape metrics from. If using the public IP address, this must
Value must be greater or equal to 0 and lesser or equal to 65535
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.
Each additional property must conform to the following schema
Type: array of objectSecretKeySelector selects a key of a Secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrl defines the HTTP proxy server to use.
Must match regular expression:^(http|https|socks5)://.+$
refreshInterval defines the time after which the provided names are refreshed.
If not set, Prometheus uses its default value.
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
region defines the AWS region.
Must be at least 1 characters long
roleARN defines the AWS Role ARN, an alternative to using AWS API keys.
secretKey defines the AWS API secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
tlsConfig defines the TLS configuration to connect to the Consul API.
ca defines the Certificate authority used when verifying server certificates.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
cert defines the Client certificate to present when doing client-authentication.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
insecureSkipVerify defines how to disable target certificate validation.
keySecret defines the Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
maxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverName is used to verify the hostname for the targets.
linodeSDConfigs defines a list of Linode service discovery configurations.
No Additional ItemsLinodeSDConfig configurations allow retrieving scrape targets from Linode's Linode APIv4.
See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#linodesdconfig
enableHTTP2 defines whether to enable HTTP2.
followRedirects defines whether HTTP requests follow HTTP 3xx redirects.
oauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint.
Cannot be set at the same time as authorization, or basicAuth.
clientId defines a key of a Secret or ConfigMap containing the
OAuth2 client's ID.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
clientSecret defines a key of a Secret containing the OAuth2
client's secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
endpointParams configures the HTTP parameters to append to the token
URL.
Each additional property must conform to the following schema
Type: stringproxyConnectHeader 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.
Each additional property must conform to the following schema
Type: array of objectSecretKeySelector selects a key of a Secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrl defines the HTTP proxy server to use.
Must match regular expression:^(http|https|socks5)://.+$
scopes defines the OAuth2 scopes used for the token request.
No Additional ItemstlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.
It requires Prometheus >= v2.43.0.
ca defines the Certificate authority used when verifying server certificates.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
cert defines the Client certificate to present when doing client-authentication.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
insecureSkipVerify defines how to disable target certificate validation.
keySecret defines the Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
maxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverName is used to verify the hostname for the targets.
tokenUrl defines the URL to fetch the token from.
Must be at least 1 characters long
port defines the port to scrape metrics from. If using the public IP address, this must
Value must be greater or equal to 0 and lesser or equal to 65535
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.
Each additional property must conform to the following schema
Type: array of objectSecretKeySelector selects a key of a Secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrl defines the HTTP proxy server to use.
Must match regular expression:^(http|https|socks5)://.+$
refreshInterval defines the time after which the provided names are refreshed.
If not set, Prometheus uses its default value.
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
region defines the region to filter on.
Must be at least 1 characters long
tagSeparator defines the string by which Linode Instance tags are joined into the tag label.el.
Must be at least 1 characters long
tlsConfig defines the TLS configuration to connect to the Consul API.
ca defines the Certificate authority used when verifying server certificates.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
cert defines the Client certificate to present when doing client-authentication.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
insecureSkipVerify defines how to disable target certificate validation.
keySecret defines the Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
maxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverName is used to verify the hostname for the targets.
metricRelabelings defines the metricRelabelings to apply to samples before ingestion.
Must contain a minimum of 1 items
RelabelConfig allows dynamic rewriting of the label set for targets, alerts,
scraped samples and remote write samples.
More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
action to perform based on the regex matching.
Uppercase and Lowercase actions require Prometheus >= v2.36.0.
DropEqual and KeepEqual actions require Prometheus >= v2.41.0.
Default: "Replace"
modulus to take of the hash of the source label values.
Only applicable when the action is HashMod.
regex defines the regular expression against which the extracted value is matched.
replacement value against which a Replace action is performed if the
regular expression matches.
Regex capture groups are available.
separator defines the string between concatenated SourceLabels.
sourceLabels defines the source labels select values from existing labels. Their content is
concatenated using the configured Separator and matched against the
configured regular expression.
LabelName is a valid Prometheus label name.
For Prometheus 3.x, a label name is valid if it contains UTF-8 characters.
For Prometheus 2.x, a label name is only valid if it contains ASCII characters, letters, numbers, as well as underscores.
metricsPath defines the HTTP path to scrape for metrics. If empty, Prometheus uses the default value (e.g. /metrics).
Must be at least 1 characters long
nameEscapingScheme defines the metric name escaping mode to request through content negotiation.
It requires Prometheus >= v3.4.0.
nameValidationScheme defines the validation scheme for metric and label names.
It requires Prometheus >= v3.0.0.
nativeHistogramBucketLimit defines ff there are more than this many buckets in a native histogram,
buckets will be merged to stay within the limit.
It requires Prometheus >= v2.45.0.
nativeHistogramMinBucketFactor defines if the growth factor of one bucket to the next is smaller than this,
buckets will be merged to increase the factor sufficiently.
It requires Prometheus >= v2.50.0.
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
nomadSDConfigs defines a list of Nomad service discovery configurations.
No Additional ItemsNomadSDConfig configurations allow retrieving scrape targets from Nomad's Service API.
See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#nomadsdconfig
allowStale defines the information to access the Nomad API. It is to be defined
as the Nomad documentation requires.
basicAuth defines information to use on every scrape request.
password defines a key of a Secret containing the password for
authentication.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
username defines a key of a Secret containing the username for
authentication.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
enableHTTP2 defines whether to enable HTTP2.
followRedirects defines whether HTTP requests follow HTTP 3xx redirects.
namespace defines the Nomad namespace to query for service discovery.
When specified, only resources within this namespace will be discovered.
oauth2 defines the configuration to use on every scrape request.
clientId defines a key of a Secret or ConfigMap containing the
OAuth2 client's ID.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
clientSecret defines a key of a Secret containing the OAuth2
client's secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
endpointParams configures the HTTP parameters to append to the token
URL.
Each additional property must conform to the following schema
Type: stringproxyConnectHeader 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.
Each additional property must conform to the following schema
Type: array of objectSecretKeySelector selects a key of a Secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrl defines the HTTP proxy server to use.
Must match regular expression:^(http|https|socks5)://.+$
scopes defines the OAuth2 scopes used for the token request.
No Additional ItemstlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.
It requires Prometheus >= v2.43.0.
ca defines the Certificate authority used when verifying server certificates.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
cert defines the Client certificate to present when doing client-authentication.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
insecureSkipVerify defines how to disable target certificate validation.
keySecret defines the Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
maxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverName is used to verify the hostname for the targets.
tokenUrl defines the URL to fetch the token from.
Must be at least 1 characters long
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.
Each additional property must conform to the following schema
Type: array of objectSecretKeySelector selects a key of a Secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrl defines the HTTP proxy server to use.
Must match regular expression:^(http|https|socks5)://.+$
refreshInterval defines the time after which the provided names are refreshed.
If not set, Prometheus uses its default value.
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
region defines the Nomad region to query for service discovery.
When specified, only resources within this region will be discovered.
server defines the Nomad server address to connect to for service discovery.
This should be the full URL including protocol (e.g., "https://nomad.example.com:4646").
Must be at least 1 characters long
tagSeparator defines the separator used to join multiple tags.
This determines how Nomad service tags are concatenated into Prometheus labels.
tlsConfig defines the TLS configuration to connect to the Consul API.
ca defines the Certificate authority used when verifying server certificates.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
cert defines the Client certificate to present when doing client-authentication.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
insecureSkipVerify defines how to disable target certificate validation.
keySecret defines the Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
maxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverName is used to verify the hostname for the targets.
oauth2 defines the configuration to use on every scrape request.
clientId defines a key of a Secret or ConfigMap containing the
OAuth2 client's ID.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
clientSecret defines a key of a Secret containing the OAuth2
client's secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
endpointParams configures the HTTP parameters to append to the token
URL.
Each additional property must conform to the following schema
Type: stringproxyConnectHeader 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.
Each additional property must conform to the following schema
Type: array of objectSecretKeySelector selects a key of a Secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrl defines the HTTP proxy server to use.
Must match regular expression:^(http|https|socks5)://.+$
scopes defines the OAuth2 scopes used for the token request.
No Additional ItemstlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.
It requires Prometheus >= v2.43.0.
ca defines the Certificate authority used when verifying server certificates.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
cert defines the Client certificate to present when doing client-authentication.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
insecureSkipVerify defines how to disable target certificate validation.
keySecret defines the Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
maxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverName is used to verify the hostname for the targets.
tokenUrl defines the URL to fetch the token from.
Must be at least 1 characters long
openstackSDConfigs defines a list of OpenStack service discovery configurations.
No Additional ItemsOpenStackSDConfig allow retrieving scrape targets from OpenStack Nova instances.
See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#openstacksdconfig
allTenants defines whether the service discovery should list all instances for all projects.
It is only relevant for the 'instance' role and usually requires admin permissions.
applicationCredentialId defines the OpenStack applicationCredentialId.
applicationCredentialName defines the ApplicationCredentialID or ApplicationCredentialName fields are
required if using an application credential to authenticate. Some providers
allow you to create an application credential to authenticate rather than a
password.
Must be at least 1 characters long
applicationCredentialSecret defines the required field if using an application
credential to authenticate.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
availability defines the availability of the endpoint to connect to.
domainID defines The OpenStack domainID.
Must be at least 1 characters long
domainName defines at most one of domainId and domainName that must be provided if using username
with Identity V3. Otherwise, either are optional.
Must be at least 1 characters long
identityEndpoint defines the HTTP endpoint that is required to work with
the Identity API of the appropriate version.
^http(s)?:\/\/.+$
password defines the password for the Identity V2 and V3 APIs. Consult with your provider's
control panel to discover your account's preferred method of authentication.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
port defines the port to scrape metrics from. If using the public IP address, this must
instead be specified in the relabeling rule.
Value must be greater or equal to 0 and lesser or equal to 65535
projectID defines the OpenStack projectID.
Must be at least 1 characters long
projectName defines an optional field for the Identity V2 API.
Some providers allow you to specify a ProjectName instead of the ProjectId.
Some require both. Your provider's authentication policies will determine
how these fields influence authentication.
Must be at least 1 characters long
refreshInterval defines the time after which the provided names are refreshed.
If not set, Prometheus uses its default value.
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
region defines the OpenStack Region.
Must be at least 1 characters long
role defines the OpenStack role of entities that should be discovered.
Note: The LoadBalancer role requires Prometheus >= v3.2.0.
tlsConfig defines the TLS configuration applying to the target HTTP endpoint.
ca defines the Certificate authority used when verifying server certificates.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
cert defines the Client certificate to present when doing client-authentication.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
insecureSkipVerify defines how to disable target certificate validation.
keySecret defines the Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
maxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverName is used to verify the hostname for the targets.
userid defines the OpenStack userid.
Must be at least 1 characters long
username defines the username required if using Identity V2 API. Consult with your provider's
control panel to discover your account's username.
In Identity V3, either userid or a combination of username
and domainId or domainName are needed
Must be at least 1 characters long
ovhcloudSDConfigs defines a list of OVHcloud service discovery configurations.
No Additional ItemsOVHCloudSDConfig configurations allow retrieving scrape targets from OVHcloud's dedicated servers and VPS using their API.
See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#ovhcloudsdconfig
applicationKey defines the access key to use for OVHCloud API authentication.
This is obtained from the OVHCloud API credentials at https://api.ovh.com.
Must be at least 1 characters long
applicationSecret defines the secret key for OVHCloud API authentication.
This contains the application secret obtained during OVHCloud API credential creation.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
consumerKey defines the consumer key for OVHCloud API authentication.
This is the third component of OVHCloud's three-key authentication system.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
endpoint defines a custom API endpoint to be used.
When not specified, defaults to the standard OVHCloud API endpoint for the region.
Must be at least 1 characters long
refreshInterval defines the time after which the provided names are refreshed.
If not set, Prometheus uses its default value.
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
service defines the service type of the targets to retrieve.
Must be either VPS or DedicatedServer to specify which OVHCloud resources to discover.
params defines optional HTTP URL parameters
Each additional property must conform to the following schema
Type: array of stringproxyConnectHeader 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.
Each additional property must conform to the following schema
Type: array of objectSecretKeySelector selects a key of a Secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrl defines the HTTP proxy server to use.
Must match regular expression:^(http|https|socks5)://.+$
puppetDBSDConfigs defines a list of PuppetDB service discovery configurations.
No Additional ItemsPuppetDBSDConfig configurations allow retrieving scrape targets from PuppetDB resources.
See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#puppetdbsdconfig
basicAuth defines information to use on every scrape request.
Cannot be set at the same time as authorization, or oauth2.
password defines a key of a Secret containing the password for
authentication.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
username defines a key of a Secret containing the username for
authentication.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
enableHTTP2 defines whether to enable HTTP2.
followRedirects defines whether HTTP requests follow HTTP 3xx redirects.
includeParameters defines whether to include the parameters as meta labels.
Note: Enabling this exposes parameters in the Prometheus UI and API. Make sure
that you don't have secrets exposed as parameters if you enable this.
oauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint.
Cannot be set at the same time as authorization, or basicAuth.
clientId defines a key of a Secret or ConfigMap containing the
OAuth2 client's ID.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
clientSecret defines a key of a Secret containing the OAuth2
client's secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
endpointParams configures the HTTP parameters to append to the token
URL.
Each additional property must conform to the following schema
Type: stringproxyConnectHeader 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.
Each additional property must conform to the following schema
Type: array of objectSecretKeySelector selects a key of a Secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrl defines the HTTP proxy server to use.
Must match regular expression:^(http|https|socks5)://.+$
scopes defines the OAuth2 scopes used for the token request.
No Additional ItemstlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.
It requires Prometheus >= v2.43.0.
ca defines the Certificate authority used when verifying server certificates.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
cert defines the Client certificate to present when doing client-authentication.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
insecureSkipVerify defines how to disable target certificate validation.
keySecret defines the Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
maxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverName is used to verify the hostname for the targets.
tokenUrl defines the URL to fetch the token from.
Must be at least 1 characters long
port defines the port to scrape metrics from. If using the public IP address, this must
Value must be greater or equal to 0 and lesser or equal to 65535
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.
Each additional property must conform to the following schema
Type: array of objectSecretKeySelector selects a key of a Secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrl defines the HTTP proxy server to use.
Must match regular expression:^(http|https|socks5)://.+$
query defines the Puppet Query Language (PQL) query. Only resources are supported.
https://puppet.com/docs/puppetdb/latest/api/query/v4/pql.html
Must be at least 1 characters long
refreshInterval defines the time after which the provided names are refreshed.
If not set, Prometheus uses its default value.
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
tlsConfig defines the TLS configuration to connect to the Consul API.
ca defines the Certificate authority used when verifying server certificates.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
cert defines the Client certificate to present when doing client-authentication.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
insecureSkipVerify defines how to disable target certificate validation.
keySecret defines the Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
maxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverName is used to verify the hostname for the targets.
url defines the URL of the PuppetDB root query endpoint.
Must match regular expression:^http(s)?://.+$
Must be at least 1 characters long
relabelings 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
Must contain a minimum of 1 items
RelabelConfig allows dynamic rewriting of the label set for targets, alerts,
scraped samples and remote write samples.
More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
action to perform based on the regex matching.
Uppercase and Lowercase actions require Prometheus >= v2.36.0.
DropEqual and KeepEqual actions require Prometheus >= v2.41.0.
Default: "Replace"
modulus to take of the hash of the source label values.
Only applicable when the action is HashMod.
regex defines the regular expression against which the extracted value is matched.
replacement value against which a Replace action is performed if the
regular expression matches.
Regex capture groups are available.
separator defines the string between concatenated SourceLabels.
sourceLabels defines the source labels select values from existing labels. Their content is
concatenated using the configured Separator and matched against the
configured regular expression.
LabelName is a valid Prometheus label name.
For Prometheus 3.x, a label name is valid if it contains UTF-8 characters.
For Prometheus 2.x, a label name is only valid if it contains ASCII characters, letters, numbers, as well as underscores.
sampleLimit defines per-scrape limit on number of scraped samples that will be accepted.
scalewaySDConfigs defines a list of Scaleway instances and baremetal service discovery configurations.
No Additional ItemsScalewaySDConfig configurations allow retrieving scrape targets from Scaleway instances and baremetal services.
See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scalewaysdconfig
accessKey defines the access key to use. https://console.scaleway.com/project/credentials
Must be at least 1 characters long
apiURL defines the API URL to use when doing the server listing requests.
Must match regular expression:^http(s)?://.+$
enableHTTP2 defines whether to enable HTTP2.
followRedirects defines whether HTTP requests follow HTTP 3xx redirects.
nameFilter defines a name filter (works as a LIKE) to apply on the server listing request.
Must be at least 1 characters long
port defines the port to scrape metrics from. If using the public IP address, this must
Value must be greater or equal to 0 and lesser or equal to 65535
projectID defines the Project ID of the targets.
Must be at least 1 characters long
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.
Each additional property must conform to the following schema
Type: array of objectSecretKeySelector selects a key of a Secret.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrl defines the HTTP proxy server to use.
Must match regular expression:^(http|https|socks5)://.+$
refreshInterval defines the time after which the provided names are refreshed.
If not set, Prometheus uses its default value.
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
role defines the service of the targets to retrieve. Must be Instance or Baremetal.
secretKey defines the secret key to use when listing targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
tlsConfig defines the TLS configuration to connect to the Consul API.
ca defines the Certificate authority used when verifying server certificates.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
cert defines the Client certificate to present when doing client-authentication.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
insecureSkipVerify defines how to disable target certificate validation.
keySecret defines the Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
maxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverName is used to verify the hostname for the targets.
zone defines the availability zone of your targets (e.g. fr-par-1).
Must be at least 1 characters long
scheme defines the protocol scheme used for requests.
scrapeClass defines the scrape class to apply.
Must be at least 1 characters long
scrapeClassicHistograms defines whether to scrape a classic histogram that is also exposed as a native histogram.
It requires Prometheus >= v2.45.0.
Notice: scrapeClassicHistograms corresponds to the always_scrape_classic_histograms field in the Prometheus configuration.
scrapeInterval defines the interval between consecutive scrapes.
Must match regular expression:^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
scrapeNativeHistograms defines whether to enable scraping of native histograms.
It requires Prometheus >= v3.8.0.
scrapeProtocols defines the protocols to negotiate during a scrape. It tells clients the
protocols supported by Prometheus in order of preference (from most to least preferred).
If unset, Prometheus uses its default value.
It requires Prometheus >= v2.49.0.
Must contain a minimum of 1 items
ScrapeProtocol represents a protocol used by Prometheus for scraping metrics.
Supported values are:
* OpenMetricsText0.0.1
* OpenMetricsText1.0.0
* PrometheusProto
* PrometheusText0.0.4
* PrometheusText1.0.0
scrapeTimeout defines the number of seconds to wait until a scrape request times out.
The value cannot be greater than the scrape interval otherwise the operator will reject the resource.
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
staticConfigs defines a list of static targets with a common label set.
No Additional ItemsStaticConfig defines a Prometheus static configuration.
See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config
labels defines labels assigned to all metrics scraped from the targets.
Each additional property must conform to the following schema
Type: stringtargets defines the list of targets for this static configuration.
Must contain a minimum of 1 items
Target represents a target for Prometheus to scrape
kubebuilder:validation:MinLength:=1
targetLimit defines a limit on the number of scraped targets that will be accepted.
tlsConfig defines the TLS configuration to use on every scrape request
ca defines the Certificate authority used when verifying server certificates.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
cert defines the Client certificate to present when doing client-authentication.
configMap defines the ConfigMap containing data to use for the targets.
The key to select.
Specify whether the ConfigMap or its key must be defined
secret defines the Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
insecureSkipVerify defines how to disable target certificate validation.
keySecret defines the Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Specify whether the Secret or its key must be defined
maxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverName is used to verify the hostname for the targets.
trackTimestampsStaleness defines whether Prometheus tracks staleness of
the metrics that have an explicit timestamp present in scraped data.
Has no effect if honorTimestamps is false.
It requires Prometheus >= v2.48.0.
status defines the status subresource. It is under active development and is updated only when the
"StatusForConfigurationResources" feature gate is enabled.
Most recent observed status of the ScrapeConfig. Read-only.
More info:
https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
bindings defines the list of workload resources (Prometheus, PrometheusAgent, ThanosRuler or Alertmanager) which select the configuration resource.
No Additional ItemsWorkloadBinding is a link between a configuration resource and a workload resource.
conditions defines the current state of the configuration resource when bound to the referenced Workload object.
No Additional ItemsConfigResourceCondition describes the status of configuration resources linked to Prometheus, PrometheusAgent, Alertmanager or ThanosRuler.
lastTransitionTime defines the time of the last update to the current status property.
message defines the human-readable message indicating details for the condition's last transition.
observedGeneration defines the .metadata.generation that the
condition was set based upon. For instance, if .metadata.generation is
currently 12, but the .status.conditions[].observedGeneration is 9, the
condition is out of date with respect to the current state of the object.
reason for the condition's last transition.
status of the condition.
Must be at least 1 characters long
type of the condition being reported.
Currently, only "Accepted" is supported.
group defines the group of the referenced resource.
name defines the name of the referenced object.
Must be at least 1 characters long
namespace defines the namespace of the referenced object.
Must be at least 1 characters long
resource defines the type of resource being referenced (e.g. Prometheus, PrometheusAgent, ThanosRuler or Alertmanager).