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

endpoints

array

この ServiceMonitor の一部として許可されているエンドポイントのリスト。

endpoints[]

object

Endpoint は、Prometheus メトリックを提供するスクレイプ可能なエンドポイントを定義します。

jobLabel

string

jobLabel は、関連付けられた Kubernetes Service オブジェクトからラベルを選択します。このラベルは、すべてのメトリクスの job ラベルとして使用されます。例： ServiceMonitor.spec.jobLabel: foo および Service.metadata.labels.foo: bar で、job="bar" ラベルがすべてのメトリクスに追加されます。このフィールドの値が空の場合、または指定されたサービスにそのラベルが存在しない場合、メトリクスの job ラベルのデフォルトは、関連付けられている Kubernetes Service の名前になります。

labelLimit

integer

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

labelNameLengthLimit

integer

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

labelValueLengthLimit

integer

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

namespaceSelector

object

KubernetesEndpoints オブジェクトが検出される名前空間を選択するためのセレクター。

podTargetLabels

array (string)

PodTargetLabels は、Kubernetes Pod のラベルを作成されたメトリックに転送します。

sampleLimit

integer

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

selector

object

エンドポイントオブジェクトを選択するためのセレクター。

targetLabels

array (string)

TargetLabels は、ラベルを Kubernetes サービス から作成されたメトリックに転送します。

targetLimit

integer

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

authorization

object

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

basicAuth

object

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

bearerTokenFile

string

ターゲットをスクレイピングするためのベアラトークンを読み取るためのファイル。

bearerTokenSecret

object

ターゲットをスクレイピングするためのベアラトークンを読み取るためにマウントする秘密。シークレットは、サービスモニターと同じ名前空間にあり、PrometheusOperator がアクセスできる必要があります。

enableHttp2

boolean

HTTP2 を有効にするかどうか。

followRedirects

boolean

FollowRedirects は、収集リクエストが HTTP 3xx リダイレクトされるかどうかを設定します。

honorLabels

ブール値

HonorLabels は、ターゲットラベルとの衝突時にメトリックのラベルを選択します。

honorTimestamps

ブール値

HonorTimestamps は、Prometheus がスクレイピングされたデータに存在するタイムスタンプを尊重するかどうかを制御します。

interval

string

指定されていない場合に Prometheus のグローバルスクレイプ間隔が使用される場合にスクレイプする間隔。

metricRelabelings

array

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

metricRelabelings[]

object

RelabelConfig を使用すると、取り込み前にサンプルに適用されたラベルセットの動的な書き換えが可能になります。Prometheus 設定の <metric_relabel_configs> セクションを定義します。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs

oauth2

object

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

params

object

オプションの HTTPURL パラメーター

params{}

array (string)

path

string

メトリックをスクレイプするための HTTP パス。空の場合、Prometheus はデフォルト値 (例: /metrics) を使用します。

port

string

このエンドポイントが参照するサービスポートの名前。targetPort と相互に排他的です。

proxyUrl

string

ProxyURL 例: http://proxyserver:2195 このエンドポイントを介してスクレイプをプロキシーに送信します。

relabelings

array

スクレイピングする前にサンプルに適用する RelabelConfigs。Operator は、いくつかの標準 Kubernetes フィールドのラベルの再設定を自動的に追加します。元のスクレイプジョブの名前は、\__tmp_prometheus_job_name ラベルから取得できます。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

relabelings[]

object

RelabelConfig を使用すると、取り込み前にサンプルに適用されたラベルセットの動的な書き換えが可能になります。Prometheus 設定の <metric_relabel_configs> セクションを定義します。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs

scheme

string

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

scrapeTimeout

string

スクレイプが終了した後のタイムアウト。指定されていない場合、Prometheus グローバルスクレイプのタイムアウトは、後者が使用される Interval 未満でない限り使用されます。

targetPort

integer-or-string

サービスの背後にある Pod のターゲットポートの名前または番号。ポートはコンテナーポートプロパティーで指定する必要があります。ポートと相互に排他的です。

tlsConfig

object

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

credentials

object

リクエストのクレデンシャルを含むシークレットのキー

type

string

認証タイプを設定します。デフォルトは Bearer で、Basic はエラーを引き起こします

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

正規表現のマッチングに基づいて実行するアクション。デフォルトは置換です。大文字および小文字のアクションには、Prometheus >= 2.36 が必要です。

modulus

integer

ソースラベル値のハッシュを取得するためのモジュラス。

regex

string

抽出された値が一致する正規表現。デフォルトは (.*) です。

replacement

string

正規表現が一致する場合に正規表現置換が実行される置換値。正規表現キャプチャグループが利用可能です。デフォルトは $1 です。

separator

string

連結されたソースラベル値の間に配置されたセパレータ。デフォルトは ';' です。

sourceLabels

array (string)

ソースラベルは、既存のラベルから値を選択します。それらのコンテンツは、設定されたセパレーターを使用して連結され、置換、保持、および削除アクションの設定された正規表現と照合されます。

targetLabel

string

結果の値が置換アクションで書き込まれるラベル。置換アクションには必須です。正規表現キャプチャグループが利用可能です。

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

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

action

string

正規表現のマッチングに基づいて実行するアクション。デフォルトは置換です。大文字および小文字のアクションには、Prometheus >= 2.36 が必要です。

modulus

integer

ソースラベル値のハッシュを取得するためのモジュラス。

regex

string

抽出された値が一致する正規表現。デフォルトは (.*) です。

replacement

string

正規表現が一致する場合に正規表現置換が実行される置換値。正規表現キャプチャグループが利用可能です。デフォルトは $1 です。

separator

string

連結されたソースラベル値の間に配置されたセパレータ。デフォルトは ';' です。

sourceLabels

array (string)

ソースラベルは、既存のラベルから値を選択します。それらのコンテンツは、設定されたセパレーターを使用して連結され、置換、保持、および削除アクションの設定された正規表現と照合されます。

targetLabel

string

結果の値が置換アクションで書き込まれるラベル。置換アクションには必須です。正規表現キャプチャグループが利用可能です。

ca

object

ターゲットに使用する CA 証明書を含む構造体。

caFile

string

ターゲットに使用する Prometheus コンテナー内の CA 証明書へのパス。

cert

object

ターゲットのクライアント証明書ファイルを含む構造体。

certFile

string

ターゲットの Prometheus コンテナー内のクライアント証明書ファイルへのパス。

insecureSkipVerify

boolean

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

keyFile

string

ターゲットの Prometheus コンテナー内のクライアントキーファイルへのパス。

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

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

any

boolean

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

matchNames

array (string)

選択する namespace 名のリスト。

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