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

authorization

object

このエンドポイントの承認セクション

basicAuth

object

BasicAuth を使用すると、エンドポイントは基本認証を介して認証できます。詳細: https://prometheus.io/docs/operating/configuration/#endpoint

bearerTokenSecret

object

ターゲットをスクレイピングするためのベアラトークンを読み取るためにマウントする秘密。シークレットは、プローブと同じ namespace にあり、Prometheus Operator からアクセスできる必要があります。

interval

string

設定されたプローバーを使用してターゲットがプローブされる間隔。指定しない場合、Prometheus のグローバルスクレイプ間隔が使用されます。

jobName

string

デフォルトでスクレイプされたメトリックに割り当てられたジョブ名。

labelLimit

integer

サンプルに受け入れられるラベルの数のスクレープごとの制限。Prometheus バージョン 2.27.0 以降でのみ有効です。

labelNameLengthLimit

integer

サンプルで受け入れられるラベル名の長さのスクレープごとの制限。Prometheus バージョン 2.27.0 以降でのみ有効です。

labelValueLengthLimit

integer

サンプルに受け入れられるラベル値の長さのスクレープごとの制限。Prometheus バージョン 2.27.0 以降でのみ有効です。

metricRelabelings

array

取り込み前にサンプルに適用する MetricRelabelConfigs。

metricRelabelings[]

object

RelabelConfig を使用すると、ターゲット、アラート、スクレイピングされたサンプル、リモート書き込みサンプルのラベルセットを動的に書き換えることができます。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

module

string

ターゲットをプローブする方法を指定するプローブに使用するモジュール。ブラックボックスエクスポーターでのモジュール設定の例: https://github.com/prometheus/blackbox_exporter/blob/master/example.yml

oauth2

object

URL の OAuth2。Prometheus バージョン 2.27.0 以降でのみ有効です。

prober

object

ターゲットのプロービングに使用するプローバーの仕様。prober.URL パラメーターは必須です。空のままにすると、ターゲットをプローブできません。

sampleLimit

integer

SampleLimit は、受け入れられるスクレイプされたサンプルの数に対するスクレイプごとの制限を定義します。

scrapeTimeout

string

Prometheus エクスポーターからメトリックをスクレイピングするためのタイムアウト。指定されていない場合、Prometheus のグローバルスクレイプタイムアウトが使用されます。

targetLimit

integer

TargetLimit は、受け入れられるスクレイプされたターゲットの数の制限を定義します。

ターゲット

object

targets は、プローブする静的または動的に検出されたターゲットのセットを定義します。

tlsConfig

object

エンドポイントをスクレイピングするときに使用する TLS 設定。

credentials

object

認証の認証情報を含む、namespace 内の Secret のキーを選択します。

type

string

認証タイプを定義します。この値は大文字と小文字を区別しません。"Basic" はサポートされている値ではありません。デフォルト: "Bearer"

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

password

object

認証用のパスワードを含むサービスモニター名前空間のシークレット。

username

object

認証用のユーザー名を含むサービスモニター名前空間のシークレット。

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

action

string

正規表現の一致に基づいて実行するアクション。Uppercase および Lowercase アクションには Prometheus v2.36.0 以降が必要です。DropEqual および KeepEqual アクションには Prometheus v2.41.0 以降が必要です。デフォルト: "Replace"

modulus

integer

ソースラベル値のハッシュを取得するためのモジュラス。アクションが HashMod の場合にのみ適用されます。

regex

string

抽出された値が一致する正規表現。

replacement

string

正規表現が一致する場合に置き換えアクションが実施される置換値。正規表現キャプチャグループが利用可能です。

separator

string

separator は連結された SourceLabel 間の文字列です。

sourceLabels

array (string)

ソースラベルは、既存のラベルから値を選択します。それらのコンテンツは、設定されたセパレータを使用して連結され、設定された正規表現と照合されます。

targetLabel

string

結果の文字列が置換で書き込まれるラベル。Replace、HashMod、Lowercase、Uppercase、KeepEqual、DropEqual アクションでは必須です。正規表現キャプチャグループが利用可能です。

clientId

object

OAuth2 クライアント ID を含むシークレットまたは設定マップ

clientSecret

object

OAuth2 クライアントシークレットを含むシークレット

endpointParams

object (string)

トークン URL に追加するパラメーター

scopes

array (string)

トークンリクエストに使用される OAuth2 スコープ

tokenUrl

string

トークンをフェッチする URL

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

key

string

選択するキー。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

ConfigMap かそのキーを定義する必要があるかどうかを指定します。

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

path

string

メトリックを収集するためのパス。デフォルトは /probe です。

proxyUrl

string

オプションの ProxyURL。

scheme

string

スクレイピングに使用する HTTP スキーム。ラベルを再設定することで scheme ラベルを書き換えた場合を除き、http と https は期待される値になります。空の場合、Prometheus はデフォルト値 http を使用します。

url

string

プローバーの必須 URL。

ingress

object

ingress は、プローブする Ingress オブジェクトとラベル再設定の設定を定義します。staticConfig も定義されている場合は、staticConfig が優先されます。

staticConfig

object

staticConfig は、プローブするターゲットの静的リストとラベル再設定の設定を定義します。ingress も定義されている場合は、staticConfig が優先されます。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#statuc_config

namespaceSelector

object

Ingress オブジェクトの選択元となる namespace。

relabelingConfigs

array

スクレイピングされる前にターゲットのラベルセットに適用する RelabelConfigs。元の ingress アドレスは、__tmp_prometheus_ingress_address ラベルから取得できます。プローブ対象の URL をカスタマイズするために使用できます。元のスクレイプジョブの名前は、__tmp_prometheus_job_name ラベルから入手できます。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

relabelingConfigs[]

object

RelabelConfig を使用すると、ターゲット、アラート、スクレイピングされたサンプル、リモート書き込みサンプルのラベルセットを動的に書き換えることができます。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

selector

object

Ingress オブジェクトを選択するためのセレクター。

any

boolean

それらを制限するリストとは対照的に、すべての namespace が選択されているかどうかを説明するブール値。

matchNames

array (string)

選択する namespace 名のリスト。

action

string

正規表現の一致に基づいて実行するアクション。Uppercase および Lowercase アクションには Prometheus v2.36.0 以降が必要です。DropEqual および KeepEqual アクションには Prometheus v2.41.0 以降が必要です。デフォルト: "Replace"

modulus

integer

ソースラベル値のハッシュを取得するためのモジュラス。アクションが HashMod の場合にのみ適用されます。

regex

string

抽出された値が一致する正規表現。

replacement

string

正規表現が一致する場合に置き換えアクションが実施される置換値。正規表現キャプチャグループが利用可能です。

separator

string

separator は連結された SourceLabel 間の文字列です。

sourceLabels

array (string)

ソースラベルは、既存のラベルから値を選択します。それらのコンテンツは、設定されたセパレータを使用して連結され、設定された正規表現と照合されます。

targetLabel

string

結果の文字列が置換で書き込まれるラベル。Replace、HashMod、Lowercase、Uppercase、KeepEqual、DropEqual アクションでは必須です。正規表現キャプチャグループが利用可能です。

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

labels

object (string)

ターゲットからスクレイプされたすべてのメトリックに割り当てられたラベル。

relabelingConfigs

array

スクレイピングされる前にターゲットのラベルセットに適用する RelabelConfigs。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

relabelingConfigs[]

object

RelabelConfig を使用すると、ターゲット、アラート、スクレイピングされたサンプル、リモート書き込みサンプルのラベルセットを動的に書き換えることができます。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

static

array (string)

プローブ対象のホストのリスト。

action

string

正規表現の一致に基づいて実行するアクション。Uppercase および Lowercase アクションには Prometheus v2.36.0 以降が必要です。DropEqual および KeepEqual アクションには Prometheus v2.41.0 以降が必要です。デフォルト: "Replace"

modulus

integer

ソースラベル値のハッシュを取得するためのモジュラス。アクションが HashMod の場合にのみ適用されます。

regex

string

抽出された値が一致する正規表現。

replacement

string

正規表現が一致する場合に置き換えアクションが実施される置換値。正規表現キャプチャグループが利用可能です。

separator

string

separator は連結された SourceLabel 間の文字列です。

sourceLabels

array (string)

ソースラベルは、既存のラベルから値を選択します。それらのコンテンツは、設定されたセパレータを使用して連結され、設定された正規表現と照合されます。

targetLabel

string

結果の文字列が置換で書き込まれるラベル。Replace、HashMod、Lowercase、Uppercase、KeepEqual、DropEqual アクションでは必須です。正規表現キャプチャグループが利用可能です。

ca

object

サーバー証明書の検証に使用される認証局。

cert

object

クライアント認証を行うときに提示するクライアント証明書。

insecureSkipVerify

boolean

ターゲット証明書の検証を無効にします。

keySecret

object

ターゲットのクライアントキーファイルを含むシークレット。

serverName

string

ターゲットのホスト名を確認するために使用されます。

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

key

string

選択するキー。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

ConfigMap かそのキーを定義する必要があるかどうかを指定します。

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

key

string

選択するキー。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

ConfigMap かそのキーを定義する必要があるかどうかを指定します。

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。