第14章 FlowMetric 設定パラメーター

buckets

array (string)

type が "Histogram" の場合に使用するバケットのリスト。このリストは、浮動小数点数として解析可能である必要があります。設定されていない場合は、Prometheus のデフォルトのバケットが使用されます。

charts

array

管理者ビューの Dashboards メニューにある OpenShift Container Platform コンソールのチャート設定。

direction

string

Ingress、Egress、または任意の方向のフローをフィルタリングします。Ingress に設定すると、FlowDirection に正規表現フィルター 0|2 を追加した場合と同じになります。Egress に設定すると、FlowDirection に正規表現フィルター 1|2 を追加した場合と同じになります。

divider

string

ゼロ以外の場合、値の換算係数 (除数)。メトリクス値 = フロー値/除数。

filters

array

filters は、考慮されるフローを制限するために使用するフィールドと値のリストです。多くの場合、重複を排除するために、Duplicate != "true" および FlowDirection = "0" というフィルターを使用する必要があります。使用可能なフィールドのリストについては、ドキュメント https://docs.openshift.com/container-platform/latest/observability/network_observability/json-flows-format-reference.html を参照してください。

labels

array (string)

labels は、Prometheus ラベル (ディメンションとも呼ばれます) として使用するフィールドのリストです。ラベルを選択すると、このメトリクスの粒度レベルと、クエリー時に使用可能な集計が決定されます。これは、メトリクスのカーディナリティーに影響するため、慎重に行う必要があります (https://rhobs-handbook.netlify.app/products/openshiftmonitoring/telemetry.md/#what-is-the-cardinality-of-a-metric を参照)。一般に、IP アドレスや MAC アドレスなど、カーディナリティーが非常に高いラベルを設定することは避けてください。可能な限り、"SrcK8S_OwnerName" または "DstK8S_OwnerName" を、"SrcK8S_Name" または "DstK8S_Name" よりも優先してください。使用可能なフィールドのリストについては、ドキュメント https://docs.openshift.com/container-platform/latest/observability/network_observability/json-flows-format-reference.html を参照してください。

metricName

string

メトリクスの名前。Prometheus では、自動的に "netobserv_" という接頭辞が付けられます。

remap

object (string)

生成されるメトリクスラベルにフローフィールドとは異なる名前を使用するには、remap プロパティーを設定します。元のフローフィールドをキーとして使用し、目的のラベル名を値として使用します。

type

string

メトリクスタイプ ("Counter" または "Histogram")。"Counter" は、バイト数やパケット数など、時間の経過とともに増加し、レートを計算できる値に使用します。"Histogram" は、遅延など、個別にサンプリングする必要がある値に使用します。

valueField

string

valueField は、このメトリクスの値として使用する必要のあるフローフィールドです。このフィールドには数値を入力する必要があります。フロー数をカウントするには、フローごとに特定の値を指定するのではなく、空のままにします。使用可能なフィールドのリストについては、ドキュメント https://docs.openshift.com/container-platform/latest/observability/network_observability/json-flows-format-reference.html を参照してください。

dashboardName

string

配置先のダッシュボードの名前。この名前が既存のダッシュボードを示すものでない場合は、新しいダッシュボードが作成されます。

queries

array

このグラフに表示するクエリーのリスト。type が SingleStat で、複数のクエリーが指定されている場合、このグラフは複数のパネル (クエリーごとに 1 つ) に自動的に展開されます。

sectionName

string

配置先のダッシュボードセクションの名前。この名前が既存のセクションを示すものでない場合は、新しいセクションが作成されます。sectionName が省略されているか空の場合、グラフはグローバルトップセクションに配置されます。

title

string

グラフのタイトル。

type

string

グラフの種類。

unit

string

このグラフの単位。現在サポートされている単位はごく少数です。一般的な数字を使用する場合は空白のままにします。

legend

string

このグラフに表示する各時系列に適用するクエリーの凡例。複数の時系列を表示する場合は、それぞれを区別する凡例を設定する必要があります。これは {{ Label }} という形式で設定できます。たとえば、promQL でラベルごとに時系列をグループ化する場合 (例: sum(rate($METRIC[2m])) by (Label1, Label2))、凡例として Label1={{ Label1 }}, Label2={{ Label2 }} と記述します。

promQL

string

Prometheus に対して実行する promQL クエリー。グラフの type が SingleStat の場合、このクエリーは単一の時系列のみを返します。その他のタイプの場合、上位 7 つが表示されます。このリソースで定義されたメトリクスを参照するには、$METRIC を使用できます。たとえば、sum(rate($METRIC[2m])) です。promQL の詳細は、Prometheus のドキュメント https://prometheus.io/docs/prometheus/latest/querying/basics/ を参照してください。

top

integer

タイムスタンプごとに表示する上位 N 個の系列。SingleStat グラフタイプには適用されません。

field

string

フィルタリングするフィールドの名前

matchType

string

適用するマッチングのタイプ

value

string

フィルタリングする値。matchType が Equal または NotEqual の場合、$(SomeField) を使用したフィールドインジェクションを使用して、フロー内の他のフィールドを参照できます。