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

attachMetadata

object

attachMetadata は、検出されたターゲットに追加される追加メタデータを定義します。

Prometheus v2.35.0 以降が必要です。

bodySizeLimit

string

bodySizeLimit が定義されている場合、Prometheus が受け入れる非圧縮形式のレスポンスボディーに対するジョブレベルの制限が指定されます。

Prometheus v2.28.0 以降が必要です。

jobLabel

string

ジョブ名の取得に使用するラベル。jobLabel は、関連付けられた Kubernetes Pod オブジェクトからラベルを選択します。このラベルは、すべてのメトリクスの job ラベルとして使用されます。

たとえば、jobLabel が foo に設定され、Kubernetes Pod オブジェクトが foo: bar でラベル付けされている場合、Prometheus は取り込まれたすべてのメトリクスに job="bar" ラベルを追加します。

このフィールドの値が空の場合、メトリクスの job ラベルはデフォルトで PodMonitor オブジェクトの namespace と名前 (例: <namespace>/<name>) になります。

keepDroppedTargets

integer

再ラベル付けによって削除され、メモリーに保持されるターゲットの数に対するスクレイプごとの制限。0 は制限がないことを意味します。

Prometheus v2.47.0 以降が必要です。

labelLimit

integer

サンプルに受け入れられるラベルの数のスクレープごとの制限。

Prometheus v2.27.0 以降が必要です。

labelNameLengthLimit

integer

サンプルで受け入れられるラベル名の長さのスクレープごとの制限。

Prometheus v2.27.0 以降が必要です。

labelValueLengthLimit

integer

サンプルに受け入れられるラベル値の長さのスクレープごとの制限。

Prometheus v2.27.0 以降が必要です。

namespaceSelector

object

namespaceSelector は、Prometheus が Pod を検出する namespace を定義します。デフォルトでは、Pod は PodMonitor オブジェクトと同じ namespace で検出されます。ただし、異なるまたはすべての namespace で Pod を選択することもできます。

nativeHistogramBucketLimit

integer

ネイティブヒストグラムにこの数を超えるバケットがある場合、制限内に収まるようにバケットがマージされます。Prometheus 2.45.0 以降が必要です。

nativeHistogramMinBucketFactor

integer-or-string

あるバケットから次のバケットへの増加係数がこれより小さい場合、係数が十分に大きくなるようにバケットがマージされます。Prometheus v2.50.0 以降が必要です。

podMetricsEndpoints

array

選択した Pod からメトリクスをスクレイピングする方法を定義します。

podMetricsEndpoints[]

object

podMetricsEndpoint は、Prometheus によってスクレイピングされる Prometheus メトリクスを提供するエンドポイントを定義します。

podTargetLabels

array (string)

podTargetLabels は、関連付けられた Kubernetes Pod オブジェクトから取り込まれたメトリクスに転送されるラベルを定義します。

sampleLimit

integer

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

scrapeClass

string

適用するスクレイプクラス。

scrapeClassicHistograms

boolean

ネイティブヒストグラムとしても公開されているクラシックヒストグラムをスクレイピングするかどうか。Prometheus 2.45.0 以降が必要です。

scrapeProtocols

array (string)

scrapeProtocols は、スクレイピング中にネゴシエートするプロトコルを定義します。これは、Prometheus でサポートされているプロトコルを (優先度が高いものから低いものへ) 優先度順にクライアントに通知します。

設定されていない場合、Prometheus はデフォルト値を使用します。

Prometheus v2.49.0 以降が必要です。

selector

object

メトリクスをスクレイピングする Kubernetes Pod オブジェクトを選択するためのラベルセレクター。

targetLimit

integer

targetLimit は、スクレイピングされたターゲットの受け入れ数に対する制限を定義します。

node

boolean

true に設定すると、Prometheus が検出されたターゲットにノードメタデータをアタッチします。

Prometheus サービスアカウントに、Nodes オブジェクトに対する list および watch 権限が必要です。

any

boolean

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

matchNames

array (string)

選択する namespace 名のリスト。

authorization

object

authorization は、ターゲットをスクレイピングするときに使用する認証ヘッダーの認証情報を設定します。

basicAuth または oauth2 と同時に設定することはできません。

basicAuth

object

basicAuth は、ターゲットをスクレイピングするときに使用する Basic 認証の認証情報を設定します。

authorization または oauth2 と同時に設定することはできません。

bearerTokenSecret

object

bearerTokenSecret は、スクレイピング対象のベアラートークンを含む Secret のキーを指定します。シークレットは PodMonitor オブジェクトと同じ namespace にあり、Prometheus Operator によって読み取り可能である必要があります。

非推奨: 代替として authorization を使用します。

enableHttp2

boolean

enableHttp2 を使用して、ターゲットのスクレイピング時に HTTP2 を無効にできます。

filterRunning

boolean

true の場合、実行されていない Pod (Failed または Succeeded などの状態) はターゲット検出中にドロップされます。

設定されていない場合、フィルタリングが有効になります。

詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-phase

followRedirects

boolean

followRedirects は、スクレイプ要求が HTTP 3xx リダイレクトに従うかどうかを定義します。

honorLabels

boolean

true の場合、honorLabels はターゲットのラベルと競合する場合もメトリクスのラベルを保持します。

honorTimestamps

boolean

honorTimestamps は、ターゲットが公開した場合に Prometheus がタイムスタンプを保持するかどうかを制御します。

interval

string

Prometheus がターゲットからメトリクスをスクレイピングする間隔。

空の場合、Prometheus はグローバルのスクレイピング間隔を使用します。

metricRelabelings

array

metricRelabelings は、取り込み前にサンプルに適用するラベルの再設定ルールを設定します。

metricRelabelings[]

object

RelabelConfig を使用すると、ターゲット、アラート、スクレイピングされたサンプル、リモート書き込みサンプルのラベルセットを動的に書き換えることができます。

詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

oauth2

object

oauth2 は、ターゲットをスクレイピングする際に使用する OAuth2 設定を設定します。

Prometheus 2.27.0 以降が必要です。

authorization または basicAuth と同時に設定することはできません。

params

object

params は、オプションの HTTP URL パラメーターを定義します。

params{}

array (string)

path

string

メトリクスをスクレイピングする HTTP パス。

空の場合、Prometheus はデフォルト値 (例: /metrics) を使用します。

port

string

このエンドポイントが参照する Pod ポートの名前。

targetPort よりも優先されます。

proxyUrl

string

proxyURL は、ターゲットをスクレイピングする際に通過する HTTP プロキシー URL (例: "http://proxyserver:2195") を設定します。

relabelings

array

relabelings は、ターゲットのメタデータラベルを適用するためのラベルの再設定ルールを設定します。

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

string

スクレイピングに使用する HTTP スキーム。

ラベルを再設定することで scheme ラベルを書き換えた場合を除き、http と https は期待される値になります。

空の場合、Prometheus はデフォルト値 http を使用します。

scrapeTimeout

string

このタイムアウトの後、Prometheus はスクレイプを失敗として判断します。

空の場合、Prometheus はグローバルのスクレイプタイムアウトを使用します。ただし、ターゲットのスクレイプ間隔値の方が短い場合はそちらが使用されます。

targetPort

integer-or-string

サービスの背後にある Pod オブジェクトのターゲットポートの名前または番号。ポートはコンテナーポートプロパティーで指定する必要があります。

非推奨: 代わりに 'port' を使用します。

tlsConfig

object

ターゲットをスクレイピングするときに使用する TLS 設定。

trackTimestampsStaleness

boolean

trackTimestampsStaleness は、スクレイピングされたデータ内に明示的なタイムスタンプが存在するメトリクスが古くなっていないかどうかを Prometheus が追跡するか定義します。honorTimestamps が false の場合は効果がありません。

Prometheus v2.48.0 以降が必要です。

credentials

object

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

type

string

認証タイプを定義します。この値は大文字と小文字を区別しません。

"Basic" はサポートされている値ではありません。

デフォルト: "Bearer"

key

string

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

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

boolean

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

password

object

password は、認証用のパスワードを含むシークレットのキーを指定します。

username

object

username は、認証用のユーザー名を含むシークレットのキーを指定します。

key

string

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

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

boolean

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

key

string

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

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

boolean

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

key

string

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

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

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

clientId は、OAuth2 クライアントの ID を含む Secret または ConfigMap のキーを指定します。

clientSecret

object

clientSecret は、OAuth2 クライアントのシークレットを含む Secret のキーを指定します。

endpointParams

object (string)

endpointParams は、トークン URL に追加する HTTP パラメーターを設定します。

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{}

array

proxyConnectHeader{}[]

object

SecretKeySelector は、シークレットのキーを選択します。

proxyFromEnvironment

boolean

環境変数 (HTTP_PROXY、HTTPS_PROXY、NO_PROXY) によって定義されたプロキシー設定を使用するかどうか。

Prometheus v2.43.0 以降または Alertmanager 0.25.0 以降が必要です。

proxyUrl

string

proxyURL は、使用する HTTP プロキシーサーバーを定義します。

scopes

array (string)

scopes は、トークン要求に使用される OAuth2 スコープを定義します。

tlsConfig

object

OAuth2 サーバーに接続するときに使用する TLS 設定。Prometheus v2.43.0 以降が必要です。

tokenUrl

string

tokenURL は、トークンを取得する URL を設定します。

configMap

object

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

secret

object

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

key

string

選択するキー。

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

boolean

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

key

string

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

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

boolean

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

key

string

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

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

boolean

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

key

string

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

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

boolean

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

ca

object

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

cert

object

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

insecureSkipVerify

boolean

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

keySecret

object

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

maxVersion

string

許容可能な最大 TLS バージョン。

Prometheus v2.41.0 以降が必要です。

minVersion

string

許容可能な最小 TLS バージョン。

Prometheus v2.35.0 以降が必要です。

serverName

string

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

configMap

object

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

secret

object

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

key

string

選択するキー。

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

boolean

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

key

string

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

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

boolean

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

configMap

object

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

secret

object

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

key

string

選択するキー。

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

boolean

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

key

string

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

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

boolean

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

key

string

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

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

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 アクションでは必須です。

正規表現キャプチャグループが利用可能です。

ca

object

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

cert

object

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

insecureSkipVerify

boolean

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

keySecret

object

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

maxVersion

string

許容可能な最大 TLS バージョン。

Prometheus v2.41.0 以降が必要です。

minVersion

string

許容可能な最小 TLS バージョン。

Prometheus v2.35.0 以降が必要です。

serverName

string

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

configMap

object

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

secret

object

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

key

string

選択するキー。

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

boolean

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

key

string

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

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

boolean

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

configMap

object

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

secret

object

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

key

string

選択するキー。

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

boolean

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

key

string

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

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

boolean

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

key

string

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

name

string

参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

boolean

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

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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。