ServiceMonitor [monitoring.coreos.com/v1]

attachMetadata

对象

attachMetadata 定义了添加到已发现目标的额外元数据。

它需要 Prometheus >= v2.37.0。

bodySizeLimit

字符串

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

它需要 Prometheus >= v2.28.0。

endpoints

数组

此ServiceMonitor的一部分端点列表。

endpoints[]

对象

Endpoint 定义了由Prometheus抓取的提供Prometheus指标的服务端点。

jobLabel

字符串

jobLabel 从关联的Kubernetes Service 对象中选择标签，该标签将用作所有指标的job标签。

例如，如果jobLabel设置为foo，并且Kubernetes Service 对象用foo: bar标记，则Prometheus将job="bar"标签添加到所有摄取的指标。

如果此字段的值为空，或者给定Service不存在该标签，则指标的job标签默认为关联的Kubernetes Service的名称。

keepDroppedTargets

整数

每次抓取时，通过重新标记而丢弃的目标数量的限制将保存在内存中。0 表示无限制。

它需要 Prometheus >= v2.47.0。

labelLimit

整数

每次抓取时，将为样本接受的标签数量的限制。

它需要 Prometheus >= v2.27.0。

labelNameLengthLimit

整数

每次抓取时，将为样本接受的标签名称长度的限制。

它需要 Prometheus >= v2.27.0。

labelValueLengthLimit

整数

每次抓取时，将为样本接受的标签值长度的限制。

它需要 Prometheus >= v2.27.0。

namespaceSelector

对象

选择器，用于选择从中发现Kubernetes Endpoints 对象的命名空间。

podTargetLabels

数组（字符串）

podTargetLabels 定义了从关联的Kubernetes Pod 对象转移到已摄取指标的标签。

sampleLimit

整数

sampleLimit 定义了每次抓取时将接受的已抓取样本数量的限制。

scrapeClass

字符串

要应用的抓取类。

scrapeProtocols

数组（字符串）

scrapeProtocols 定义了在抓取过程中协商的协议。它告诉客户端Prometheus支持的协议，按优先级排序（从最优先到最不优先）。

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

它需要 Prometheus >= v2.49.0。

selector

对象

标签选择器，用于选择Kubernetes Endpoints 对象。

targetLabels

数组（字符串）

targetLabels 定义了从关联的Kubernetes Service 对象转移到已摄取指标的标签。

targetLimit

整数

targetLimit 定义了将被接受的已抓取目标数量的限制。

node

布尔值

设置为 true 时，Prometheus 必须对 Nodes 对象具有 get 权限。

authorization

对象

authorization 配置在抓取目标时要使用的授权头凭据。

不能与 basicAuth 或 oauth2 同时设置。

basicAuth

对象

basicAuth 配置在抓取目标时要使用的基本身份验证凭据。

不能与 authorization 或 oauth2 同时设置。

bearerTokenFile

字符串

读取用于抓取目标的 bearer 令牌的文件。

已弃用：请改用 authorization。

bearerTokenSecret

对象

bearerTokenSecret 指定一个 Secret 的密钥，该 Secret 包含用于抓取目标的 bearer 令牌。该 Secret 需要与 ServiceMonitor 对象位于相同的命名空间中，并且可以被 Prometheus Operator 读取。

已弃用：请改用 authorization。

enableHttp2

布尔值

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

filterRunning

布尔值

设置为 true 时，在目标发现期间，将丢弃未运行的 Pod（例如，处于 Failed 或 Succeeded 状态的 Pod）。

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

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

followRedirects

布尔值

followRedirects 定义抓取请求是否应遵循 HTTP 3xx 重定向。

honorLabels

布尔值

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

honorTimestamps

布尔值

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

interval

字符串

Prometheus 从目标抓取指标的间隔。

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

metricRelabelings

数组

metricRelabelings 配置应用于摄取前样本的重命名规则。

metricRelabelings[]

对象

RelabelConfig 允许动态重写目标、警报、已抓取样本和远程写入样本的标签集。

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

oauth2

对象

oauth2 配置在抓取目标时要使用的 OAuth2 设置。

需要 Prometheus >= 2.27.0。

不能与 authorization 或 basicAuth 同时设置。

params

对象

params 定义可选的 HTTP URL 参数。

params{}

数组（字符串）

path

字符串

从中抓取指标的 HTTP 路径。

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

port

字符串

此端点引用的服务端口的名称。

它优先于 targetPort。

proxyUrl

字符串

proxyURL 配置在抓取目标时要经过的 HTTP 代理 URL（例如，“http://proxyserver:2195”）。

relabelings

数组

relabelings 配置应用于目标的元数据标签的重命名规则。

操作员会自动为一些标准的 Kubernetes 字段添加重命名规则。

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

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

relabelings[]

对象

RelabelConfig 允许动态重写目标、警报、已抓取样本和远程写入样本的标签集。

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

scheme

字符串

用于抓取的 HTTP 方案。

除非您通过重命名重写了scheme 标签，否则预期值为http 和 https。

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

scrapeTimeout

字符串

Prometheus 将抓取视为失败的超时时间。

如果为空，Prometheus 将使用全局抓取超时，除非它小于目标的抓取间隔值，在这种情况下使用后者。

targetPort

整数或字符串

服务背后Pod 对象的目标端口的名称或编号。必须使用容器的端口属性指定端口。

tlsConfig

对象

在抓取目标时要使用的 TLS 配置。

trackTimestampsStaleness

布尔值

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

需要 Prometheus >= v2.48.0。

credentials

对象

选择命名空间中包含身份验证凭据的 Secret 的密钥。

type

字符串

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

"Basic" 不是受支持的值。

默认值：“Bearer”

key

字符串

要从中选择的密钥的名称。必须是有效的密钥。

name

字符串

引用的名称。此字段实际上是必需的，但由于向后兼容性，允许为空。此类型的实例在此处为空值几乎肯定是错误的。待办事项：添加其他有用的字段。apiVersion、kind、uid？更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#names 待办事项：当 controller-gen 不需要时删除 kubebuilder:default https://github.com/kubernetes-sigs/kubebuilder/issues/3896。

optional

布尔值

指定是否必须定义 Secret 或其密钥

password

对象

password 指定包含身份验证密码的 Secret 的密钥。

username

对象

username 指定包含身份验证用户名的一个 Secret 的密钥。

key

字符串

要从中选择的密钥的名称。必须是有效的密钥。

name

字符串

引用的名称。此字段实际上是必需的，但由于向后兼容性，允许为空。此类型的实例在此处为空值几乎肯定是错误的。待办事项：添加其他有用的字段。apiVersion、kind、uid？更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#names 待办事项：当 controller-gen 不需要时删除 kubebuilder:default https://github.com/kubernetes-sigs/kubebuilder/issues/3896。

optional

布尔值

指定是否必须定义 Secret 或其密钥

key

字符串

要从中选择的密钥的名称。必须是有效的密钥。

name

字符串

引用的名称。此字段实际上是必需的，但由于向后兼容性，允许为空。此类型的实例在此处为空值几乎肯定是错误的。待办事项：添加其他有用的字段。apiVersion、kind、uid？更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#names 待办事项：当 controller-gen 不需要时删除 kubebuilder:default https://github.com/kubernetes-sigs/kubebuilder/issues/3896。

optional

布尔值

指定是否必须定义 Secret 或其密钥

key

字符串

要从中选择的密钥的名称。必须是有效的密钥。

name

字符串

引用的名称。此字段实际上是必需的，但由于向后兼容性，允许为空。此类型的实例在此处为空值几乎肯定是错误的。待办事项：添加其他有用的字段。apiVersion、kind、uid？更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#names 待办事项：当 controller-gen 不需要时删除 kubebuilder:default https://github.com/kubernetes-sigs/kubebuilder/issues/3896。

optional

布尔值

指定是否必须定义 Secret 或其密钥

action

字符串

基于正则表达式匹配执行的操作。

Uppercase 和 Lowercase 操作需要 Prometheus >= v2.36.0。DropEqual 和 KeepEqual 操作需要 Prometheus >= v2.41.0。

默认值：“Replace”

modulus

整数

对源标签值的哈希进行取模。

仅当操作为 HashMod 时适用。

regex

字符串

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

replacement

字符串

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

正则表达式捕获组可用。

separator

字符串

分隔符是连接的 SourceLabels 之间的字符串。

sourceLabels

数组（字符串）

源标签从现有标签中选择值。它们的内容使用配置的分隔符连接，并与配置的正则表达式匹配。

目标标签

字符串

替换操作中写入结果字符串的标签。

对于Replace、HashMod、Lowercase、Uppercase、KeepEqual和DropEqual操作，此项是必需的。

正则表达式捕获组可用。

客户端ID

对象

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

客户端密钥

对象

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

endpointParams

对象 (字符串)

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

作用域

数组（字符串）

scopes 定义用于令牌请求的 OAuth2 作用域。

令牌URL

字符串

tokenURL 配置用于获取令牌的 URL。

ConfigMap

对象

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

Secret

对象

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

key

字符串

要选择的键。

name

字符串

引用的名称。此字段实际上是必需的，但由于向后兼容性，允许为空。此类型的实例在此处为空值几乎肯定是错误的。待办事项：添加其他有用的字段。apiVersion、kind、uid？更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#names 待办事项：当 controller-gen 不需要时删除 kubebuilder:default https://github.com/kubernetes-sigs/kubebuilder/issues/3896。

optional

布尔值

指定是否必须定义 ConfigMap 或其键。

key

字符串

要从中选择的密钥的名称。必须是有效的密钥。

name

字符串

引用的名称。此字段实际上是必需的，但由于向后兼容性，允许为空。此类型的实例在此处为空值几乎肯定是错误的。待办事项：添加其他有用的字段。apiVersion、kind、uid？更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#names 待办事项：当 controller-gen 不需要时删除 kubebuilder:default https://github.com/kubernetes-sigs/kubebuilder/issues/3896。

optional

布尔值

指定是否必须定义 Secret 或其密钥

key

字符串

要从中选择的密钥的名称。必须是有效的密钥。

name

字符串

引用的名称。此字段实际上是必需的，但由于向后兼容性，允许为空。此类型的实例在此处为空值几乎肯定是错误的。待办事项：添加其他有用的字段。apiVersion、kind、uid？更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#names 待办事项：当 controller-gen 不需要时删除 kubebuilder:default https://github.com/kubernetes-sigs/kubebuilder/issues/3896。

optional

布尔值

指定是否必须定义 Secret 或其密钥

action

字符串

基于正则表达式匹配执行的操作。

Uppercase 和 Lowercase 操作需要 Prometheus >= v2.36.0。DropEqual 和 KeepEqual 操作需要 Prometheus >= v2.41.0。

默认值：“Replace”

modulus

整数

对源标签值的哈希进行取模。

仅当操作为 HashMod 时适用。

regex

字符串

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

replacement

字符串

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

正则表达式捕获组可用。

separator

字符串

分隔符是连接的 SourceLabels 之间的字符串。

sourceLabels

数组（字符串）

源标签从现有标签中选择值。它们的内容使用配置的分隔符连接，并与配置的正则表达式匹配。

目标标签

字符串

替换操作中写入结果字符串的标签。

对于Replace、HashMod、Lowercase、Uppercase、KeepEqual和DropEqual操作，此项是必需的。

正则表达式捕获组可用。

CA

对象

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

caFile

字符串

Prometheus 容器中用于目标的 CA 证书路径。

证书

对象

进行客户端身份验证时要提供的客户端证书。

certFile

字符串

Prometheus 容器中用于目标的客户端证书文件路径。

insecureSkipVerify

布尔值

禁用目标证书验证。

keyFile

字符串

Prometheus 容器中用于目标的客户端密钥文件路径。

keySecret

对象

包含用于目标的客户端密钥文件的 Secret。

服务器名称

字符串

用于验证目标的主机名。

ConfigMap

对象

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

Secret

对象

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

key

字符串

要选择的键。

name

字符串

引用的名称。此字段实际上是必需的，但由于向后兼容性，允许为空。此类型的实例在此处为空值几乎肯定是错误的。待办事项：添加其他有用的字段。apiVersion、kind、uid？更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#names 待办事项：当 controller-gen 不需要时删除 kubebuilder:default https://github.com/kubernetes-sigs/kubebuilder/issues/3896。

optional

布尔值

指定是否必须定义 ConfigMap 或其键。

key

字符串

要从中选择的密钥的名称。必须是有效的密钥。

name

字符串

引用的名称。此字段实际上是必需的，但由于向后兼容性，允许为空。此类型的实例在此处为空值几乎肯定是错误的。待办事项：添加其他有用的字段。apiVersion、kind、uid？更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#names 待办事项：当 controller-gen 不需要时删除 kubebuilder:default https://github.com/kubernetes-sigs/kubebuilder/issues/3896。

optional

布尔值

指定是否必须定义 Secret 或其密钥

ConfigMap

对象

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

Secret

对象

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

key

字符串

要选择的键。

name

字符串

引用的名称。此字段实际上是必需的，但由于向后兼容性，允许为空。此类型的实例在此处为空值几乎肯定是错误的。待办事项：添加其他有用的字段。apiVersion、kind、uid？更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#names 待办事项：当 controller-gen 不需要时删除 kubebuilder:default https://github.com/kubernetes-sigs/kubebuilder/issues/3896。

optional

布尔值

指定是否必须定义 ConfigMap 或其键。

key

字符串

要从中选择的密钥的名称。必须是有效的密钥。

name

字符串

引用的名称。此字段实际上是必需的，但由于向后兼容性，允许为空。此类型的实例在此处为空值几乎肯定是错误的。待办事项：添加其他有用的字段。apiVersion、kind、uid？更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#names 待办事项：当 controller-gen 不需要时删除 kubebuilder:default https://github.com/kubernetes-sigs/kubebuilder/issues/3896。

optional

布尔值

指定是否必须定义 Secret 或其密钥

key

字符串

要从中选择的密钥的名称。必须是有效的密钥。

name

字符串

引用的名称。此字段实际上是必需的，但由于向后兼容性，允许为空。此类型的实例在此处为空值几乎肯定是错误的。待办事项：添加其他有用的字段。apiVersion、kind、uid？更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#names 待办事项：当 controller-gen 不需要时删除 kubebuilder:default https://github.com/kubernetes-sigs/kubebuilder/issues/3896。

optional

布尔值

指定是否必须定义 Secret 或其密钥

全部

布尔值

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

matchNames

数组（字符串）

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

matchExpressions

数组

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

matchExpressions[]

对象

标签选择器要求是一个选择器，它包含值、键和一个关联键和值的运算符。

matchLabels

对象 (字符串)

matchLabels 是 {key,value} 对的映射。matchLabels 映射中的单个 {key,value} 等效于 matchExpressions 的一个元素，其 key 字段为“key”，运算符为“In”，而 values 数组仅包含“value”。这些要求是 AND 关系。

key

字符串

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

运算符

字符串

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

值

数组（字符串）

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

200 - OK

ServiceMonitorList 模式

401 - 未授权

空

200 - OK

Status 模式

401 - 未授权

空

200 - OK

ServiceMonitorList 模式

401 - 未授权

空

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略从对象中静默删除的任何未知字段，并将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中删除的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，则这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

主体

ServiceMonitor 模式

200 - OK

ServiceMonitor 模式

201 - 已创建

ServiceMonitor 模式

202 - 已接受

ServiceMonitor 模式

401 - 未授权

空

name

字符串

ServiceMonitor 的名称

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

200 - OK

Status 模式

202 - 已接受

Status 模式

401 - 未授权

空

200 - OK

ServiceMonitor 模式

401 - 未授权

空

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略从对象中静默删除的任何未知字段，并将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中删除的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，则这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

200 - OK

ServiceMonitor 模式

401 - 未授权

空

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略从对象中静默删除的任何未知字段，并将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中删除的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，则这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

主体

ServiceMonitor 模式

200 - OK

ServiceMonitor 模式

201 - 已创建

ServiceMonitor 模式

401 - 未授权

空