第 5 章 Probe [monitoring.coreos.com/v1]

授权

对象

此端点的授权部分

basicAuth

对象

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

bearerTokenSecret

对象

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

interval

字符串

使用配置的探测器探测目标的时间间隔。如果没有指定 Prometheus 的全局提取间隔。

jobName

字符串

默认分配给提取指标的作业名称。

labelLimit

整数

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

labelNameLengthLimit

整数

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

labelValueLengthLimit

整数

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

metricRelabelings

array

MetricRelabelConfigs 在 ingestion 前应用到示例。

metricRelabelings[]

对象

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

module

字符串

用于探测到目标的模块。在 blackbox 导出器中配置的模块示例： https://github.com/prometheus/blackbox_exporter/blob/master/example.yml

oauth2

对象

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

prober

对象

用于探测目标的探测器规格。prober.URL 参数是必需的。如果留空，则无法探测目标。

sampleLimit

整数

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

scrapeTimeout

字符串

从 Prometheus exporter 提取指标的超时。如果没有指定，则使用 Prometheus 全局提取间隔。

targetLimit

整数

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

目标

object

目标定义一组静态或动态发现的目标来探测。

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'

separator

字符串

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

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 或其密钥

path

字符串

从中收集指标的路径。默认为 /probe。

proxyUrl

字符串

可选 ProxyURL。

scheme

字符串

用于提取的 HTTP 方案。默认为 http。

url

字符串

探测器的强制 URL。

ingress

object

Ingress 定义要探测和重新标记配置的 Ingress 对象。如果也定义了 staticConfig，staticConfig 将具有优先权。

staticConfig

object

staticConfig 定义要探测和重新标记配置的静态列表。如果也定义了 ingress，staticConfig 将具有优先权。更多信息： https://prometheus.io/docs/prometheus/latest/configuration/configuration/#static_config。

namespaceSelector

object

从哪些命名空间中选择 Ingress 对象。

relabelingConfigs

数组

在提取前，重新labelConfigs 应用到目标的标签集合。原始入口地址可以通过 \__tmp_prometheus_ingress_address 标签获得。它可用于自定义探测的 URL。原始提取作业的名称可以通过 \\__tmp_prometheus_job_name 标签获得。更多信息： https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

relabelingConfigs[]

对象

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

selector

object

选择 Ingress 对象的选择器。

any

布尔值

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

matchNames

数组（字符串）

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

action

字符串

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

modulus

整数

modulus 采用 source 标签值的哈希。

regex

字符串

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

replacement

字符串

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

separator

字符串

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

sourceLabels

数组（字符串）

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

targetLabel

字符串

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

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

labels

对象（字符串）

分配给从目标中提取的所有指标的标签。

relabelingConfigs

数组

在提取前，重新labelConfigs 应用到目标的标签集合。更多信息： https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

relabelingConfigs[]

对象

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

static

数组（字符串）

要探测的主机列表。

action

字符串

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

modulus

整数

modulus 采用 source 标签值的哈希。

regex

字符串

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

replacement

字符串

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

separator

字符串

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

sourceLabels

数组（字符串）

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

targetLabel

字符串

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

ca

对象

包含用于目标的 CA 证书的结构。

cert

对象

包含目标的客户端证书文件的结构。

insecureSkipVerify

布尔值

禁用目标证书验证。

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 或其密钥