ScrapeConfig defines a namespaced Prometheus scrape_config to be aggregated across multiple namespaces into the Prometheus configuration.
Last changed in Prometheus Operator v0.74.0
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
ScrapeConfigSpec is a specification of the desired configuration for a scrape configuration.
NomadSDConfigs defines a list of Nomad service discovery configurations.
The information to access the Nomad API. It is to be defined as the Nomad documentation requires.
Authorization header to use on every scrape request.
Selects a key of a Secret in the namespace that contains the credentials for authentication.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer"
BasicAuth information to use on every scrape request.
`password` specifies a key of a Secret containing the password for authentication.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
`username` specifies a key of a Secret containing the username for authentication.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Whether to enable HTTP2.
Configure whether HTTP requests follow HTTP 3xx redirects.
`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0.
Optional OAuth 2.0 configuration. Cannot be set at the same time as `authorization` or `basic_auth`.
`clientId` specifies a key of a Secret or ConfigMap containing the OAuth2 client's ID.
ConfigMap containing data to use for the targets.
The key to select.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the ConfigMap or its key must be defined
Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
`clientSecret` specifies 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.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
`endpointParams` configures the HTTP parameters to append to the token URL.
`scopes` defines the OAuth2 scopes used for the token request.
`tokenURL` configures the URL to fetch the token from.
ProxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). If unset, Prometheus uses its default value. It requires Prometheus >= v2.43.0.
`proxyURL` defines the HTTP proxy server to use. It requires Prometheus >= v2.43.0.
Duration is a valid time duration that can be parsed by Prometheus model.ParseDuration() function. Supported units: y, w, d, h, m, s, ms Examples: `30s`, `1m`, `1h20m15s`, `15d`
TLS configuration applying to the target HTTP endpoint.
Certificate authority used when verifying server certificates.
ConfigMap containing data to use for the targets.
The key to select.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the ConfigMap or its key must be defined
Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Client certificate to present when doing client-authentication.
ConfigMap containing data to use for the targets.
The key to select.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the ConfigMap or its key must be defined
Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Disable target certificate validation.
Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Used to verify the hostname for the targets.
Authorization header to use on every scrape request.
Selects a key of a Secret in the namespace that contains the credentials for authentication.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer"
AzureSDConfigs defines a list of Azure service discovery configurations.
# 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
Optional client ID. Only required with the OAuth authentication method.
Optional client secret. Only required with the OAuth authentication method.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
The Azure environment.
The port to scrape metrics from. If using the public IP address, this must instead be specified in the relabeling rule.
RefreshInterval configures the refresh interval at which Prometheus will re-read the instance list.
Optional resource group name. Limits discovery to this resource group.
The subscription ID. Always required.
Optional tenant ID. Only required with the OAuth authentication method.
BasicAuth information to use on every scrape request.
`password` specifies a key of a Secret containing the password for authentication.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
`username` specifies a key of a Secret containing the username for authentication.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
ConsulSDConfigs defines a list of Consul service discovery configurations.
Allow stale Consul results (see https://www.consul.io/api/features/consistency.html). Will reduce load on Consul. If unset, Prometheus uses its default value.
Authorization header configuration to authenticate against the Consul Server.
Selects a key of a Secret in the namespace that contains the credentials for authentication.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer"
BasicAuth information to authenticate against the Consul Server. More info: https://prometheus.io/docs/operating/configuration/#endpoints
`password` specifies a key of a Secret containing the password for authentication.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
`username` specifies a key of a Secret containing the username for authentication.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Consul Datacenter name, if not provided it will use the local Consul Agent Datacenter.
Whether to enable HTTP2. If unset, Prometheus uses its default value.
Configure whether HTTP requests follow HTTP 3xx redirects. If unset, Prometheus uses its default value.
Namespaces are only supported in Consul Enterprise.
`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0.
Node metadata key/value pairs to filter nodes for a given service.
Optional OAuth 2.0 configuration.
`clientId` specifies a key of a Secret or ConfigMap containing the OAuth2 client's ID.
ConfigMap containing data to use for the targets.
The key to select.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the ConfigMap or its key must be defined
Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
`clientSecret` specifies 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.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
`endpointParams` configures the HTTP parameters to append to the token URL.
`scopes` defines the OAuth2 scopes used for the token request.
`tokenURL` configures the URL to fetch the token from.
Admin Partitions are only supported in Consul Enterprise.
ProxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). If unset, Prometheus uses its default value. It requires Prometheus >= v2.43.0.
`proxyURL` defines the HTTP proxy server to use. It requires Prometheus >= v2.43.0.
The time after which the provided names are refreshed. On large setup it might be a good idea to increase this value because the catalog will change all the time. If unset, Prometheus uses its default value.
HTTP Scheme default "http"
A valid string consisting of a hostname or IP followed by an optional port number.
A list of services for which targets are retrieved. If omitted, all services are scraped.
The string by which Consul tags are joined into the tag label. If unset, Prometheus uses its default value.
An optional list of tags used to filter nodes for a given service. Services must contain all tags in the list.
TLS Config
Certificate authority used when verifying server certificates.
ConfigMap containing data to use for the targets.
The key to select.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the ConfigMap or its key must be defined
Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Client certificate to present when doing client-authentication.
ConfigMap containing data to use for the targets.
The key to select.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the ConfigMap or its key must be defined
Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Disable target certificate validation.
Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Used to verify the hostname for the targets.
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.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
DigitalOceanSDConfigs defines a list of DigitalOcean service discovery configurations.
Authorization header configuration to authenticate against the DigitalOcean API. Cannot be set at the same time as `oauth2`.
Selects a key of a Secret in the namespace that contains the credentials for authentication.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer"
Whether to enable HTTP2.
Configure whether HTTP requests follow HTTP 3xx redirects.
`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0.
Optional OAuth 2.0 configuration. Cannot be set at the same time as `authorization`.
`clientId` specifies a key of a Secret or ConfigMap containing the OAuth2 client's ID.
ConfigMap containing data to use for the targets.
The key to select.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the ConfigMap or its key must be defined
Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
`clientSecret` specifies 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.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
`endpointParams` configures the HTTP parameters to append to the token URL.
`scopes` defines the OAuth2 scopes used for the token request.
`tokenURL` configures the URL to fetch the token from.
The port to scrape metrics from.
ProxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). If unset, Prometheus uses its default value. It requires Prometheus >= v2.43.0.
`proxyURL` defines the HTTP proxy server to use. It requires Prometheus >= v2.43.0.
Refresh interval to re-read the instance list.
TLS configuration applying to the target HTTP endpoint.
Certificate authority used when verifying server certificates.
ConfigMap containing data to use for the targets.
The key to select.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the ConfigMap or its key must be defined
Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Client certificate to present when doing client-authentication.
ConfigMap containing data to use for the targets.
The key to select.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the ConfigMap or its key must be defined
Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Disable target certificate validation.
Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Used to verify the hostname for the targets.
DNSSDConfigs defines a list of DNS service discovery configurations.
A list of DNS domain names to be queried.
The port number used if the query type is not SRV Ignored for SRV records
RefreshInterval configures the time after which the provided names are refreshed. If not set, Prometheus uses its default value.
The type of DNS query to perform. One of SRV, A, AAAA, MX or NS. If not set, Prometheus uses its default value. When set to NS, It requires Prometheus >= 2.49.0.
DockerSDConfigs defines a list of Docker service discovery configurations.
Authorization header configuration to authenticate against the Docker API. Cannot be set at the same time as `oauth2`.
Selects a key of a Secret in the namespace that contains the credentials for authentication.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer"
BasicAuth information to use on every scrape request.
`password` specifies a key of a Secret containing the password for authentication.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
`username` specifies a key of a Secret containing the username for authentication.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Whether to enable HTTP2.
Optional filters to limit the discovery process to a subset of the available resources.
Configure whether HTTP requests follow HTTP 3xx redirects.
Address of the docker daemon
The host to use if the container is in host networking mode.
`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0.
Optional OAuth 2.0 configuration. Cannot be set at the same time as `authorization`.
`clientId` specifies a key of a Secret or ConfigMap containing the OAuth2 client's ID.
ConfigMap containing data to use for the targets.
The key to select.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the ConfigMap or its key must be defined
Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
`clientSecret` specifies 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.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
`endpointParams` configures the HTTP parameters to append to the token URL.
`scopes` defines the OAuth2 scopes used for the token request.
`tokenURL` configures the URL to fetch the token from.
The port to scrape metrics from.
ProxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). If unset, Prometheus uses its default value. It requires Prometheus >= v2.43.0.
`proxyURL` defines the HTTP proxy server to use. It requires Prometheus >= v2.43.0.
Time after which the container is refreshed.
TLS configuration applying to the target HTTP endpoint.
Certificate authority used when verifying server certificates.
ConfigMap containing data to use for the targets.
The key to select.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the ConfigMap or its key must be defined
Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Client certificate to present when doing client-authentication.
ConfigMap containing data to use for the targets.
The key to select.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the ConfigMap or its key must be defined
Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Disable target certificate validation.
Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Used to verify the hostname for the targets.
EC2SDConfigs defines a list of EC2 service discovery configurations.
AccessKey is the AWS API key.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
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/API_DescribeInstances.html Filter API documentation: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Filter.html
The port to scrape metrics from. If using the public IP address, this must instead be specified in the relabeling rule.
RefreshInterval configures the refresh interval at which Prometheus will re-read the instance list.
The AWS region
AWS Role ARN, an alternative to using AWS API keys.
SecretKey is the AWS API secret.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
When false, Prometheus will request uncompressed response from the scraped target. It requires Prometheus >= v2.49.0. If unset, Prometheus uses true by default.
EurekaSDConfigs defines a list of Eureka service discovery configurations.
Authorization header to use on every scrape request.
Selects a key of a Secret in the namespace that contains the credentials for authentication.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer"
BasicAuth information to use on every scrape request.
`password` specifies a key of a Secret containing the password for authentication.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
`username` specifies a key of a Secret containing the username for authentication.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Whether to enable HTTP2.
Configure whether HTTP requests follow HTTP 3xx redirects.
`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0.
Optional OAuth 2.0 configuration. Cannot be set at the same time as `authorization` or `basic_auth`.
`clientId` specifies a key of a Secret or ConfigMap containing the OAuth2 client's ID.
ConfigMap containing data to use for the targets.
The key to select.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the ConfigMap or its key must be defined
Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
`clientSecret` specifies 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.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
`endpointParams` configures the HTTP parameters to append to the token URL.
`scopes` defines the OAuth2 scopes used for the token request.
`tokenURL` configures the URL to fetch the token from.
ProxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). If unset, Prometheus uses its default value. It requires Prometheus >= v2.43.0.
`proxyURL` defines the HTTP proxy server to use. It requires Prometheus >= v2.43.0.
Refresh interval to re-read the instance list.
The URL to connect to the Eureka server.
TLS configuration applying to the target HTTP endpoint.
Certificate authority used when verifying server certificates.
ConfigMap containing data to use for the targets.
The key to select.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the ConfigMap or its key must be defined
Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Client certificate to present when doing client-authentication.
ConfigMap containing data to use for the targets.
The key to select.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the ConfigMap or its key must be defined
Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Disable target certificate validation.
Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Used to verify the hostname for the targets.
FileSDConfigs defines a list of file service discovery configurations.
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.
RefreshInterval configures the refresh interval at which Prometheus will reload the content of the files.
GCESDConfigs defines a list of GCE service discovery configurations.
Filter 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
The port to scrape metrics from. If using the public IP address, this must instead be specified in the relabeling rule.
The Google Cloud Project ID
RefreshInterval configures the refresh interval at which Prometheus will re-read the instance list.
The tag separator is used to separate the tags on concatenation
The zone of the scrape targets. If you need multiple zones use multiple GCESDConfigs.
HetznerSDConfigs defines a list of Hetzner service discovery configurations.
Authorization header configuration, required when role is hcloud. Role robot does not support bearer token authentication.
Selects a key of a Secret in the namespace that contains the credentials for authentication.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer"
BasicAuth information to use on every scrape request, required when role is robot. Role hcloud does not support basic auth.
`password` specifies a key of a Secret containing the password for authentication.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
`username` specifies a key of a Secret containing the username for authentication.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Whether to enable HTTP2.
Configure whether HTTP requests follow HTTP 3xx redirects.
`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0.
Optional OAuth 2.0 configuration. Cannot be used at the same time as `basic_auth` or `authorization`.
`clientId` specifies a key of a Secret or ConfigMap containing the OAuth2 client's ID.
ConfigMap containing data to use for the targets.
The key to select.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the ConfigMap or its key must be defined
Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
`clientSecret` specifies 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.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
`endpointParams` configures the HTTP parameters to append to the token URL.
`scopes` defines the OAuth2 scopes used for the token request.
`tokenURL` configures the URL to fetch the token from.
The port to scrape metrics from.
ProxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). If unset, Prometheus uses its default value. It requires Prometheus >= v2.43.0.
`proxyURL` defines the HTTP proxy server to use. It requires Prometheus >= v2.43.0.
The time after which the servers are refreshed.
The Hetzner role of entities that should be discovered.
TLS configuration to use on every scrape request.
Certificate authority used when verifying server certificates.
ConfigMap containing data to use for the targets.
The key to select.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the ConfigMap or its key must be defined
Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Client certificate to present when doing client-authentication.
ConfigMap containing data to use for the targets.
The key to select.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the ConfigMap or its key must be defined
Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Disable target certificate validation.
Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Used to verify the hostname for the targets.
HonorLabels chooses the metric's labels on collisions with target labels.
HonorTimestamps controls whether Prometheus respects the timestamps present in scraped data.
HTTPSDConfigs defines a list of HTTP service discovery configurations.
Authorization header configuration to authenticate against the target HTTP endpoint.
Selects a key of a Secret in the namespace that contains the credentials for authentication.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer"
BasicAuth information to authenticate against the target HTTP endpoint. More info: https://prometheus.io/docs/operating/configuration/#endpoints
`password` specifies a key of a Secret containing the password for authentication.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
`username` specifies a key of a Secret containing the username for authentication.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0.
ProxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). If unset, Prometheus uses its default value. It requires Prometheus >= v2.43.0.
`proxyURL` defines the HTTP proxy server to use. It requires Prometheus >= v2.43.0.
RefreshInterval configures the refresh interval at which Prometheus will re-query the endpoint to update the target list.
TLS configuration applying to the target HTTP endpoint.
Certificate authority used when verifying server certificates.
ConfigMap containing data to use for the targets.
The key to select.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the ConfigMap or its key must be defined
Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Client certificate to present when doing client-authentication.
ConfigMap containing data to use for the targets.
The key to select.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the ConfigMap or its key must be defined
Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Disable target certificate validation.
Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Used to verify the hostname for the targets.
URL from which the targets are fetched.
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.
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/.
Optional metadata to attach to discovered targets. It requires Prometheus >= v2.35.0 for `pod` role and Prometheus >= v2.37.0 for `endpoints` and `endpointslice` roles.
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.
Authorization header to use on every scrape request. Cannot be set at the same time as `basicAuth`, or `oauth2`.
Selects a key of a Secret in the namespace that contains the credentials for authentication.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer"
BasicAuth information to use on every scrape request. Cannot be set at the same time as `authorization`, or `oauth2`.
`password` specifies a key of a Secret containing the password for authentication.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
`username` specifies a key of a Secret containing the username for authentication.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Whether to enable HTTP2.
Configure whether HTTP requests follow HTTP 3xx redirects.
Optional namespace discovery. If omitted, Prometheus discovers targets across all namespaces.
List of namespaces where to watch for resources. If empty and `ownNamespace` isn't true, Prometheus watches for resources in all namespaces.
Includes the namespace in which the Prometheus pod exists to the list of watched namesapces.
`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0.
Optional OAuth 2.0 configuration. Cannot be set at the same time as `authorization`, or `basicAuth`.
`clientId` specifies a key of a Secret or ConfigMap containing the OAuth2 client's ID.
ConfigMap containing data to use for the targets.
The key to select.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the ConfigMap or its key must be defined
Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
`clientSecret` specifies 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.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
`endpointParams` configures the HTTP parameters to append to the token URL.
`scopes` defines the OAuth2 scopes used for the token request.
`tokenURL` configures the URL to fetch the token from.
ProxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). If unset, Prometheus uses its default value. It requires Prometheus >= v2.43.0.
`proxyURL` defines the HTTP proxy server to use. It requires Prometheus >= v2.43.0.
Role of the Kubernetes entities that should be discovered.
Selector to select objects.
Role is role of the service in Kubernetes.
TLS configuration to use on every scrape request.
Certificate authority used when verifying server certificates.
ConfigMap containing data to use for the targets.
The key to select.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the ConfigMap or its key must be defined
Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Client certificate to present when doing client-authentication.
ConfigMap containing data to use for the targets.
The key to select.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the ConfigMap or its key must be defined
Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Disable target certificate validation.
Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Used to verify the hostname for the targets.
KumaSDConfigs defines a list of Kuma service discovery configurations.
Authorization header to use on every scrape request.
Selects a key of a Secret in the namespace that contains the credentials for authentication.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer"
BasicAuth information to use on every scrape request.
`password` specifies a key of a Secret containing the password for authentication.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
`username` specifies a key of a Secret containing the username for authentication.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Client id is used by Kuma Control Plane to compute Monitoring Assignment for specific Prometheus backend.
Whether to enable HTTP2.
The time after which the monitoring assignments are refreshed.
Configure whether HTTP requests follow HTTP 3xx redirects.
`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0.
Optional OAuth 2.0 configuration. Cannot be set at the same time as `authorization`, or `basicAuth`.
`clientId` specifies a key of a Secret or ConfigMap containing the OAuth2 client's ID.
ConfigMap containing data to use for the targets.
The key to select.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the ConfigMap or its key must be defined
Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
`clientSecret` specifies 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.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
`endpointParams` configures the HTTP parameters to append to the token URL.
`scopes` defines the OAuth2 scopes used for the token request.
`tokenURL` configures the URL to fetch the token from.
ProxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). If unset, Prometheus uses its default value. It requires Prometheus >= v2.43.0.
`proxyURL` defines the HTTP proxy server to use. It requires Prometheus >= v2.43.0.
The time to wait between polling update requests.
Address of the Kuma Control Plane's MADS xDS server.
TLS configuration to use on every scrape request
Certificate authority used when verifying server certificates.
ConfigMap containing data to use for the targets.
The key to select.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the ConfigMap or its key must be defined
Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Client certificate to present when doing client-authentication.
ConfigMap containing data to use for the targets.
The key to select.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the ConfigMap or its key must be defined
Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Disable target certificate validation.
Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Used to verify the hostname for the targets.
Per-scrape limit on number of labels that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer.
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.
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.
MetricRelabelConfigs to apply to samples before ingestion.
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`.
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 is the string between concatenated SourceLabels.
The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression.
Label to which the resulting string is written in a replacement. It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. Regex capture groups are available.
MetricsPath HTTP path to scrape for metrics. If empty, Prometheus uses the default value (e.g. /metrics).
`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0.
OpenStackSDConfigs defines a list of OpenStack service discovery configurations.
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
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.
The applicationCredentialSecret field is required if using an application credential to authenticate.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Availability of the endpoint to connect to.
DomainID
At most one of domainId and domainName must be provided if using username with Identity V3. Otherwise, either are optional.
IdentityEndpoint specifies the HTTP endpoint that is required to work with the Identity API of the appropriate version.
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.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
The port to scrape metrics from. If using the public IP address, this must instead be specified in the relabeling rule.
ProjectID
The ProjectId and ProjectName fields are optional 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.
Refresh interval to re-read the instance list.
The OpenStack Region.
The OpenStack role of entities that should be discovered.
TLS configuration applying to the target HTTP endpoint.
Certificate authority used when verifying server certificates.
ConfigMap containing data to use for the targets.
The key to select.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the ConfigMap or its key must be defined
Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Client certificate to present when doing client-authentication.
ConfigMap containing data to use for the targets.
The key to select.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the ConfigMap or its key must be defined
Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Disable target certificate validation.
Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Used to verify the hostname for the targets.
UserID
Username is 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
Optional HTTP URL parameters
ProxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). If unset, Prometheus uses its default value. It requires Prometheus >= v2.43.0.
`proxyURL` defines the HTTP proxy server to use. It requires Prometheus >= v2.43.0.
RelabelConfigs defines how to rewrite the target's labels before scraping. Prometheus Operator automatically adds relabelings for a few standard Kubernetes fields. The original scrape job's name is available via the `__tmp_prometheus_job_name` label. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
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`.
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 is the string between concatenated SourceLabels.
The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression.
Label to which the resulting string is written in a replacement. It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. Regex capture groups are available.
SampleLimit defines per-scrape limit on number of scraped samples that will be accepted.
Configures the protocol scheme used for requests. If empty, Prometheus uses HTTP by default.
The scrape class to apply.
ScrapeInterval is the interval between consecutive scrapes.
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.
ScrapeTimeout is the number of seconds to wait until a scrape request times out.
StaticConfigs defines a list of static targets with a common label set.
Labels assigned to all metrics scraped from the targets.
List of targets for this static configuration.
TargetLimit defines a limit on the number of scraped targets that will be accepted.
TLS configuration to use on every scrape request
Certificate authority used when verifying server certificates.
ConfigMap containing data to use for the targets.
The key to select.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the ConfigMap or its key must be defined
Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Client certificate to present when doing client-authentication.
ConfigMap containing data to use for the targets.
The key to select.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the ConfigMap or its key must be defined
Secret containing data to use for the targets.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Disable target certificate validation.
Secret containing the client key file for the targets.
The key of the secret to select from. Must be a valid secret key.
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
Specify whether the Secret or its key must be defined
Used to verify the hostname for the targets.
TrackTimestampsStaleness 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.
Source: bundle.yaml
Changes to ScrapeConfig (monitoring.coreos.com/v1alpha1) in each Prometheus Operator version, compared to the version before it.
1 property has been added
9 properties have changed type
The description of ScrapeConfig has changed
258 properties have changed the description
Released · View ScrapeConfig in v0.74.0
4 properties have been added
Released · View ScrapeConfig in v0.73.0
4 properties have been added
1 property has changed the description
Released · View ScrapeConfig in v0.72.0
22 properties have been added
4 properties have changed the description
Released · View ScrapeConfig in v0.71.0
13 properties have been added
10 properties have been removed
12 properties have changed the description
Released · View ScrapeConfig in v0.70.0
2 properties have been added
1 property has changed the description
Released · View ScrapeConfig in v0.69.0
3 properties have been added
Released · View ScrapeConfig in v0.68.0
13 properties have been added
11 properties have changed the description
Released · View ScrapeConfig in v0.67.0
4 properties have been added
Released · View ScrapeConfig in v0.66.0
ScrapeConfig was first seen on this version of Prometheus Operator
Released · View ScrapeConfig in v0.65.0
No examples of ScrapeConfig yet. Contribute one on GitHub.
kubespec.dev