第 8 章 ServiceMonitor [monitoring.coreos.com/v1]

attachMetadata

object

将节点元数据附加到发现的目标。需要 Prometheus v2.37.0 及更高版本。

端点

array

此 ServiceMonitor 中允许的端点列表。

endpoints[]

对象

端点定义提供 Prometheus 指标的可提取端点。

jobLabel

string

JobLabel 从关联的 Kubernetes 服务中选择标签，该服务将用作所有指标 的作业 标签。例如：如果在 ServiceMonitor.spec.jobLabel: foo 和 Service.metadata.labels.foo: bar 中，则 job="bar" 标签添加到所有指标。如果此字段的值为空，或者标签不存在，则指标 的作业 标签默认为 Kubernetes Service 的名称。

labelLimit

整数

对示例接受的标签数的 per-scrape 限制。仅在 Prometheus 版本 2.27.0 及更新版本中有效。

labelNameLengthLimit

整数

对示例接受的标签名称长度的 per-scrape 限制。仅在 Prometheus 版本 2.27.0 及更新版本中有效。

labelValueLengthLimit

整数

对示例接受的标签值长度的 per-scrape 限制。仅在 Prometheus 版本 2.27.0 及更新版本中有效。

namespaceSelector

对象

选择从哪些命名空间发现 Kubernetes Endpoints 对象的选择器。

podTargetLabels

数组（字符串）

PodTargetLabels 将 Kubernetes Pod 上的标签传送到创建的指标。

sampleLimit

整数

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

selector

对象

选择 Endpoints 对象的选择器。

targetLabels

数组（字符串）

TargetLabels 将标签从 Kubernetes 服务 传输到创建的指标。

targetLimit

整数

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

node

布尔值

当设置为 true 时，Prometheus 必须有权限才能获取节点。

授权

对象

此端点的授权部分

basicAuth

对象

basicAuth 允许端点通过基本身份验证了解更多信息进行验证 ：https://prometheus.io/docs/operating/configuration/#endpoints

bearerTokenFile

字符串

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

bearerTokenSecret

对象

要挂载以读取用于提取目标的 bearer 令牌的机密。secret 需要与服务监控器位于同一个命名空间中，并可以被 Prometheus Operator 访问。

enableHttp2

布尔值

是否启用 HTTP2。

filterRunning

布尔值

丢弃没有运行的 pod。(failed, Succeeded)。默认启用此选项。更多信息： https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-phase

followRedirects

布尔值

FollowRedirects 配置提取请求是否遵循 HTTP 3xx 重定向。

honorLabels

布尔值

HonorLabels 选择指标的标签与目标标签冲突。

honorTimestamps

布尔值

honorTimestamps 控制 Prometheus 是否遵循提取数据中存在的时间戳。

interval

string

如果使用了 Prometheus 的全局提取间隔，则应提取指标的时间间隔。

metricRelabelings

array

MetricRelabelConfigs 在 ingestion 前应用到示例。

metricRelabelings[]

对象

RelabelConfig 允许动态重写标签集，在 ingestion 前被应用到示例。它定义 Prometheus 配置的 <metric_relabel_configs>-section。更多信息： https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs

oauth2

对象

URL 的 OAuth2。仅在 Prometheus 版本 2.27.0 及更新版本中有效。

params

对象

可选的 HTTP URL 参数

params{}

数组（字符串）

path

字符串

提取指标的 HTTP 路径。如果为空，Prometheus 将使用默认值（如 /metrics）。

port

字符串

此端点所引用的服务端口的名称。与 targetPort 相互排斥。

proxyUrl

字符串

proxyUrl eg http://proxyserver:2195 Directs scrapes to proxy via this endpoint.

重新标记

array

在提取前，重新labelConfigs 应用到示例。Prometheus Operator 会自动为几个标准 Kubernetes 字段添加重新标记。原始提取作业的名称可以通过 \__tmp_prometheus_job_name 标签获得。更多信息： https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

relabelings[]

对象

RelabelConfig 允许动态重写标签集，在 ingestion 前被应用到示例。它定义 Prometheus 配置的 <metric_relabel_configs>-section。更多信息： https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs

scheme

字符串

用于提取的 HTTP 方案。

scrapeTimeout

string

如果没有指定提取的超时时间，会使用 Prometheus 全局提取超时，除非它小于使用后者的间隔。

targetPort

integer-or-string

在 Service 后面的 Pod 的目标端口的名称或号，必须使用容器端口属性指定端口。与端口相互排斥。

tlsConfig

对象

提取端点时使用的 TLS 配置

credentials

对象

包含请求凭证的 secret 密钥

type

字符串

设置身份验证类型。默认为 Bearer，Basic 将导致错误

key

字符串

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

name

字符串

引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: 添加其他有用的字段。apiVersion、kind、uid？

optional

布尔值

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

password

对象

服务监控器命名空间中的 secret，其中包含用于身份验证的密码。

username

对象

服务监控器命名空间中的 secret，其中包含用于身份验证的用户名。

key

字符串

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

name

字符串

引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: 添加其他有用的字段。apiVersion、kind、uid？

optional

布尔值

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

key

字符串

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

name

字符串

引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: 添加其他有用的字段。apiVersion、kind、uid？

optional

布尔值

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

key

字符串

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

name

字符串

引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: 添加其他有用的字段。apiVersion、kind、uid？

optional

布尔值

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

action

字符串

根据正则表达式匹配要执行的操作。默认为 'replace'。大写，小写操作需要 Prometheus >= 2.36。

modulus

整数

modulus 采用 source 标签值的哈希。

regex

字符串

匹配提取值的正则表达式。默认为 '(configured)'

replacement

字符串

如果正则表达式匹配，则执行 regex 替换的替换值。正则表达式捕获组可用。默认为 '$1'

分隔符

字符串

在串联的源标签值之间放置分隔符。默认为 ';'。

sourceLabels

数组（字符串）

source 标签从现有标签中选择值。其内容使用配置的分隔符连接，并与为替换、keep 和 drop 操作配置的正则表达式匹配。

targetLabel

字符串

生成的值以 replace 操作写入的标签。对于 replace 操作是必需的。正则表达式捕获组可用。

clientId

对象

包含 OAuth2 客户端 ID 的 secret 或 configmap

clientSecret

对象

包含 OAuth2 客户端 secret 的 secret

endpointParams

对象（字符串）

附加到令牌 URL 的参数

scopes

数组（字符串）

用于令牌请求的 OAuth2 范围

tokenUrl

字符串

从中获取令牌的 URL

configMap

对象

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

secret

对象

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

key

字符串

要选择的密钥。

name

字符串

引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: 添加其他有用的字段。apiVersion、kind、uid？

optional

布尔值

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

key

字符串

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

name

字符串

引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: 添加其他有用的字段。apiVersion、kind、uid？

optional

布尔值

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

key

字符串

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

name

字符串

引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: 添加其他有用的字段。apiVersion、kind、uid？

optional

布尔值

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

action

字符串

根据正则表达式匹配要执行的操作。默认为 'replace'。大写，小写操作需要 Prometheus >= 2.36。

modulus

整数

modulus 采用 source 标签值的哈希。

regex

字符串

匹配提取值的正则表达式。默认为 '(configured)'

replacement

字符串

如果正则表达式匹配，则执行 regex 替换的替换值。正则表达式捕获组可用。默认为 '$1'

分隔符

字符串

在串联的源标签值之间放置分隔符。默认为 ';'。

sourceLabels

数组（字符串）

source 标签从现有标签中选择值。其内容使用配置的分隔符连接，并与为替换、keep 和 drop 操作配置的正则表达式匹配。

targetLabel

字符串

生成的值以 replace 操作写入的标签。对于 replace 操作是必需的。正则表达式捕获组可用。

ca

object

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

caFile

字符串

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

cert

object

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

certFile

字符串

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

insecureSkipVerify

布尔值

禁用目标证书验证。

keyFile

字符串

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

keySecret

对象

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

serverName

字符串

用于验证目标的主机名。

configMap

对象

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

secret

对象

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

key

字符串

要选择的密钥。

name

字符串

引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: 添加其他有用的字段。apiVersion、kind、uid？

optional

布尔值

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

key

字符串

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

name

字符串

引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: 添加其他有用的字段。apiVersion、kind、uid？

optional

布尔值

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

configMap

对象

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

secret

对象

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

key

字符串

要选择的密钥。

name

字符串

引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: 添加其他有用的字段。apiVersion、kind、uid？

optional

布尔值

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

key

字符串

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

name

字符串

引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: 添加其他有用的字段。apiVersion、kind、uid？

optional

布尔值

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

key

字符串

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

name

字符串

引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: 添加其他有用的字段。apiVersion、kind、uid？

optional

布尔值

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

any

布尔值

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

matchNames

数组（字符串）

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

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，则值数组必须为空。这个数组会在策略性合并补丁中被替换。