第 6 章 PodMonitor [monitoring.coreos.com/v1]

attachMetadata

object

attachMetadata 定义添加到发现的目标中的其他元数据。

它需要 Prometheus >= v2.35.0。

bodySizeLimit

string

定义后，bodySizeLimit 指定 Prometheus 接受的未压缩响应正文大小的作业级别限制。

它需要 Prometheus >= v2.28.0。

fallbackScrapeProtocol

string

如果提取返回空白、无法解析或无效 Content-Type，则使用协议。

它需要 Prometheus >= v3.0.0。

jobLabel

字符串

用于从中检索作业名称的标签。jobLabel 从关联的 Kubernetes Pod 对象中选择标签，它将用作所有指标 的作业 标签。

例如，如果 jobLabel 设置为 foo，并且 Kubernetes Pod 对象标记为 foo: bar，则 Prometheus 会将 job="bar" 标签添加到所有 ingested 指标中。

如果此字段的值为空，则指标 的作业 标签默认为 PodMonitor 对象的命名空间和名称（如 <namespace>/&lt ;name>）。

keepDroppedTargets

整数

通过重新标记将在内存中保留的目标数量来按scrape 限制。0 表示没有限制。

它需要 Prometheus >= v2.47.0。

labelLimit

整数

对示例接受的标签数的 per-scrape 限制。

它需要 Prometheus >= v2.27.0。

labelNameLengthLimit

整数

对示例接受的标签名称长度的 per-scrape 限制。

它需要 Prometheus >= v2.27.0。

labelValueLengthLimit

整数

对示例接受的标签值长度的 per-scrape 限制。

它需要 Prometheus >= v2.27.0。

namespaceSelector

object

namespaceSelector 定义 Prometheus 应该发现 pod 的命名空间。默认情况下，pod 在与 PodMonitor 对象相同的命名空间中发现，但可以在不同的/所有命名空间中选择 pod。

nativeHistogramBucketLimit

整数

如果原生直方中有多个存储桶，则存储桶将合并以保持在限值内。它需要 Prometheus >= v2.45.0。

nativeHistogramMinBucketFactor

integer-or-string

如果一个存储桶的增长因素小于这个存储桶，则存储桶将足够合并，以足够增加因素。它需要 Prometheus >= v2.50.0。

podMetricsEndpoints

数组

定义如何从所选 pod 中提取指标。

podMetricsEndpoints[]

object

PodMetricsEndpoint 定义了一个端点，供 Prometheus 提取 Prometheus 指标。

podTargetLabels

数组（字符串）

podTargetLabels 定义从关联的 Kubernetes Pod 对象传输到最接近的指标的标签。

sampleLimit

整数

SampleLimit 对接受的提取示例数量定义了一个 per-scrape 限制。

scrapeClass

string

要应用的提取类。

scrapeClassicHistograms

布尔值

是否提取作为原生直方公开的经典直方图。它需要 Prometheus >= v2.45.0。

scrapeProtocols

数组（字符串）

scrapeProtocols 定义提取期间要协商的协议。它根据首选顺序告知客户端 Prometheus 支持的协议（从最先到最首选）。

如果未设置，Prometheus 将使用其默认值。

它需要 Prometheus >= v2.49.0。

selector

object

选择要提取指标的 Kubernetes Pod 对象的标签选择器。

selectorMechanism

string

用于选择要提取的端点的机制。默认情况下，选择过程依赖于重新标记配置来过滤发现的目标。另外，您可以选择在大型集群中提供更好的效率的节点选择器。需要对您的用例进行仔细评估，哪个策略最适合您的用例。

它需要 Prometheus >= v2.17.0。

targetLimit

整数

TargetLimit 定义了接受的提取目标数量的限制。

node

布尔值

当设置为 true 时，Prometheus 会将节点元数据附加到发现的目标。

Prometheus 服务帐户必须具有 节点对象的列表 和监视 权限。

any

布尔值

布尔值描述是否都选择了所有命名空间，而不是列表限制它们。

matchNames

数组（字符串）

要从中选择的命名空间名称列表。

授权

object

授权 将 Authorization 标头凭据配置为在提取目标时使用。

不可与 basicAuth 或 oauth2 同时设置。

basicAuth

object

basicAuth 将基本身份验证凭据配置为在提取目标时使用。

不可 与授权 （或 oauth2） 同时设置。

bearerTokenSecret

object

bearerTokenSecret 指定包含用于提取目标的 bearer 令牌的 Secret 的密钥。secret 需要与 PodMonitor 对象位于同一个命名空间中，并可由 Prometheus Operator 读取。

deprecated: 使用 authorization 替代。

enableHttp2

布尔值

enableHttp2 可用于在提取目标时禁用 HTTP2。

filterRunning

布尔值

为 true 时，在目标发现过程中丢弃没有运行（如 Failed 或 Succeeded 状态）的 pod。

如果未设置，则启用过滤。

更多信息： https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-phase

followRedirects

布尔值

followRedirects 定义提取请求是否应跟随 HTTP 3xx 重定向。

honorLabels

布尔值

为 true 时，当指标标签与目标标签冲突时，honorLabels 会保留指标的标签。

honorTimestamps

布尔值

honorTimestamps 控制 Prometheus 在由目标公开时是否保留时间戳。

interval

string

Prometheus 从目标中提取指标的间隔。

如果为空，Prometheus 将使用全局提取间隔。

metricRelabelings

数组

metricRelabelings 配置重新标记规则，以便在 ingestion 前应用到示例。

metricRelabelings[]

object

RelabelConfig 允许为目标、警报、提取示例和远程写入示例动态重写标签。

更多信息： https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

oauth2

object

oauth2 将 OAuth2 设置配置为在提取目标时使用。

它需要 Prometheus >= 2.27.0。

不可与授权同时设置，或者 basicAuth。

params

object

参数定义 可选的 HTTP URL 参数。

params{}

数组（字符串）

path

string

从中提取指标的 HTTP 路径。

如果为空，Prometheus 将使用默认值（如 /metrics）。

port

string

公开端点的 Pod 端口名称。

它优先于 portNumber 和 targetPort 字段。

portNumber

整数

公开端点的 Pod 端口号。

proxyUrl

string

proxy Url 配置 HTTP 代理 URL （如 "http://proxyserver:2195"）以便在提取目标时进行。

重新标记

数组

重新标记 配置重新标记规则以应用目标的元数据标签。

Operator 会自动为几个标准 Kubernetes 字段添加重新标记。

原始提取作业的名称可以通过 \__tmp_prometheus_job_name 标签获得。

更多信息： https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

relabelings[]

object

RelabelConfig 允许为目标、警报、提取示例和远程写入示例动态重写标签。

更多信息： https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

scheme

字符串

用于提取的 HTTP 方案。

HTTP 和 https 是预期的值，除非您通过重新标记重写 scheme 标签。

如果为空，Prometheus 将使用默认值 http。

scrapeTimeout

string

Prometheus 将提取视为失败超时。

如果为空，Prometheus 将使用全局提取超时，除非它小于使用后者的目标提取间隔值。该值不能超过提取间隔，否则 operator 将拒绝该资源。

targetPort

integer-or-string

在 Service 后面的 Pod 对象的目标端口的名称或号，必须使用容器端口属性指定端口。

deprecated: 使用 'port' 或 'portNumber'。

tlsConfig

object

提取目标时使用的 TLS 配置。

trackTimestampsStaleness

布尔值

trackTimestampsStaleness 定义 Prometheus 是否跟踪提取数据中存在显式时间戳的指标的过时。如果 honorTimestamps 为 false，则无效。

它需要 Prometheus >= v2.48.0。

credentials

object

选择命名空间中包含用于身份验证的凭证的 Secret 的键。

type

string

定义身份验证类型。该值不区分大小写。

"basic"不是受支持的值。

默认："Bearer"

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。有效地需要此字段，但因为允许向后兼容为空。这里具有空值的此类实例几乎是错误的。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

布尔值

指定是否需要定义 Secret 还是其密钥

password

object

password 指定包含用于身份验证的密码的 Secret 的键。

username

object

username 指定包含用于身份验证的用户名的 Secret 的键。

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。有效地需要此字段，但因为允许向后兼容为空。这里具有空值的此类实例几乎是错误的。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

布尔值

指定是否需要定义 Secret 还是其密钥

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。有效地需要此字段，但因为允许向后兼容为空。这里具有空值的此类实例几乎是错误的。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

布尔值

指定是否需要定义 Secret 还是其密钥

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。有效地需要此字段，但因为允许向后兼容为空。这里具有空值的此类实例几乎是错误的。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

布尔值

指定是否需要定义 Secret 还是其密钥

action

string

根据正则表达式匹配要执行的操作。

大写 和低 大小 操作需要 Prometheus >= v2.36.0。DropEqual 和 KeepEqual 操作需要 Prometheus >= v2.41.0。

默认："Replace"

modulus

整数

modulus 采用 source 标签值的哈希。

仅在操作为 HashMod 时适用。

regex

字符串

匹配提取值的正则表达式。

替换

string

如果正则表达式匹配，则执行 replace 操作的替换值。

正则表达式捕获组可用。

分隔符

string

分隔符是串联的 SourceLabels 之间的字符串。

sourceLabels

数组（字符串）

source 标签从现有标签中选择值。其内容使用配置的 Separator 连接，并与配置的正则表达式匹配。

targetLabel

string

生成的字符串写入替换标签。

对于 替换,HashMod,Lowercase,Uppercase,KeepEqual 和 DropEqual 操作是必须的。

正则表达式捕获组可用。

clientId

object

clientId 指定包含 OAuth2 客户端 ID 的 Secret 或 ConfigMap 的键。

clientSecret

object

clientSecret 指定包含 OAuth2 客户端 secret 的 Secret 的密钥。

endpointParams

对象（字符串）

endpointParams 配置 HTTP 参数以附加到令牌 URL。

noProxy

string

noProxy 是一个以逗号分隔的字符串，可以包含 IP、CIDR 表示法、应在代理中排除的域名。IP 和域名可以包含端口号。

它需要 Prometheus >= v2.43.0 或 Alertmanager >= 0.25.0。

proxyConnectHeader

object

ProxyConnectHeader （可选）指定在 CONNECT 请求期间发送到代理的标头。

它需要 Prometheus >= v2.43.0 或 Alertmanager >= 0.25.0。

proxyConnectHeader{}

数组

proxyConnectHeader{}[]

object

SecretKeySelector 选择 Secret 的密钥。

proxyFromEnvironment

布尔值

是否使用由环境变量(HTTP_PROXY、HTTPS_PROXY 和 NO_PROXY)定义的代理配置。

它需要 Prometheus >= v2.43.0 或 Alertmanager >= 0.25.0。

proxyUrl

string

proxy Url 定义要使用的 HTTP 代理服务器。

scopes

数组（字符串）

范围 定义用于令牌请求的 OAuth2 范围。

tlsConfig

object

连接到 OAuth2 服务器时要使用的 TLS 配置。它需要 Prometheus >= v2.43.0。

tokenUrl

string

token Url 配置用于从中获取令牌的 URL。

configMap

对象

包含用于目标的数据的 ConfigMap。

secret

对象

包含用于目标的数据的 secret。

key

字符串

要选择的密钥。

name

字符串

引用的名称。有效地需要此字段，但因为允许向后兼容为空。这里具有空值的此类实例几乎是错误的。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

布尔值

指定是否必须定义 ConfigMap 还是其键

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。有效地需要此字段，但因为允许向后兼容为空。这里具有空值的此类实例几乎是错误的。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

布尔值

指定是否需要定义 Secret 还是其密钥

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。有效地需要此字段，但因为允许向后兼容为空。这里具有空值的此类实例几乎是错误的。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

布尔值

指定是否需要定义 Secret 还是其密钥

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。有效地需要此字段，但因为允许向后兼容为空。这里具有空值的此类实例几乎是错误的。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

布尔值

指定是否需要定义 Secret 还是其密钥

ca

object

验证服务器证书时使用的证书颁发机构。

cert

object

执行 client-authentication 时要出现的客户端证书。

insecureSkipVerify

布尔值

禁用目标证书验证。

keySecret

对象

包含目标客户端密钥文件的 secret。

maxVersion

string

最大可接受的 TLS 版本。

它需要 Prometheus >= v2.41.0。

minVersion

string

最低可接受的 TLS 版本。

它需要 Prometheus >= v2.35.0。

serverName

字符串

用于验证目标的主机名。

configMap

对象

包含用于目标的数据的 ConfigMap。

secret

对象

包含用于目标的数据的 secret。

key

字符串

要选择的密钥。

name

字符串

引用的名称。有效地需要此字段，但因为允许向后兼容为空。这里具有空值的此类实例几乎是错误的。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

布尔值

指定是否必须定义 ConfigMap 还是其键

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。有效地需要此字段，但因为允许向后兼容为空。这里具有空值的此类实例几乎是错误的。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

布尔值

指定是否需要定义 Secret 还是其密钥

configMap

对象

包含用于目标的数据的 ConfigMap。

secret

对象

包含用于目标的数据的 secret。

key

字符串

要选择的密钥。

name

字符串

引用的名称。有效地需要此字段，但因为允许向后兼容为空。这里具有空值的此类实例几乎是错误的。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

布尔值

指定是否必须定义 ConfigMap 还是其键

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。有效地需要此字段，但因为允许向后兼容为空。这里具有空值的此类实例几乎是错误的。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

布尔值

指定是否需要定义 Secret 还是其密钥

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。有效地需要此字段，但因为允许向后兼容为空。这里具有空值的此类实例几乎是错误的。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

布尔值

指定是否需要定义 Secret 还是其密钥

action

string

根据正则表达式匹配要执行的操作。

大写 和低 大小 操作需要 Prometheus >= v2.36.0。DropEqual 和 KeepEqual 操作需要 Prometheus >= v2.41.0。

默认："Replace"

modulus

整数

modulus 采用 source 标签值的哈希。

仅在操作为 HashMod 时适用。

regex

字符串

匹配提取值的正则表达式。

替换

string

如果正则表达式匹配，则执行 replace 操作的替换值。

正则表达式捕获组可用。

分隔符

string

分隔符是串联的 SourceLabels 之间的字符串。

sourceLabels

数组（字符串）

source 标签从现有标签中选择值。其内容使用配置的 Separator 连接，并与配置的正则表达式匹配。

targetLabel

string

生成的字符串写入替换标签。

对于 替换,HashMod,Lowercase,Uppercase,KeepEqual 和 DropEqual 操作是必须的。

正则表达式捕获组可用。

ca

object

验证服务器证书时使用的证书颁发机构。

cert

object

执行 client-authentication 时要出现的客户端证书。

insecureSkipVerify

布尔值

禁用目标证书验证。

keySecret

对象

包含目标客户端密钥文件的 secret。

maxVersion

string

最大可接受的 TLS 版本。

它需要 Prometheus >= v2.41.0。

minVersion

string

最低可接受的 TLS 版本。

它需要 Prometheus >= v2.35.0。

serverName

字符串

用于验证目标的主机名。

configMap

对象

包含用于目标的数据的 ConfigMap。

secret

对象

包含用于目标的数据的 secret。

key

字符串

要选择的密钥。

name

字符串

引用的名称。有效地需要此字段，但因为允许向后兼容为空。这里具有空值的此类实例几乎是错误的。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

布尔值

指定是否必须定义 ConfigMap 还是其键

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。有效地需要此字段，但因为允许向后兼容为空。这里具有空值的此类实例几乎是错误的。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

布尔值

指定是否需要定义 Secret 还是其密钥

configMap

对象

包含用于目标的数据的 ConfigMap。

secret

对象

包含用于目标的数据的 secret。

key

字符串

要选择的密钥。

name

字符串

引用的名称。有效地需要此字段，但因为允许向后兼容为空。这里具有空值的此类实例几乎是错误的。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

布尔值

指定是否必须定义 ConfigMap 还是其键

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。有效地需要此字段，但因为允许向后兼容为空。这里具有空值的此类实例几乎是错误的。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

布尔值

指定是否需要定义 Secret 还是其密钥

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。有效地需要此字段，但因为允许向后兼容为空。这里具有空值的此类实例几乎是错误的。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

布尔值

指定是否需要定义 Secret 还是其密钥

matchExpressions

array

matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。

matchExpressions[]

对象

标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。

matchLabels

对象（字符串）

matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素，其 key 字段是 "key"，运算符是 "In"，值数组仅包含 "value"。要求的逻辑关系是 AND。

key

字符串

key 是选择器应用到的标签键。

operator

字符串

运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。

值

数组（字符串）

值是字符串值的数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。这个数组会在策略性合并补丁中被替换。