第 13 章 FlowMetric 配置参数
FlowMetric
是允许从收集的流日志创建自定义指标的 API。
13.1. FlowMetric [flows.netobserv.io/v1alpha1]
- 描述
- FlowMetric 是允许从收集的流日志创建自定义指标的 API。
- 类型
-
object
属性 | 类型 | 描述 |
---|---|---|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准对象元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
|
|
FlowMetricSpec 定义所需的 FlowMetric。提供的 API 允许您根据您的需要自定义这些指标。
在添加新指标或修改现有标签时,您必须仔细监控 Prometheus 工作负载的内存用量,因为这可能会产生重大影响。Cf https://rhobs-handbook.netlify.app/products/openshiftmonitoring/telemetry.md/#what-is-the-cardinality-of-a-metric
要检查所有 Network Observability 指标的基数(cardinality), |
13.1.1. .metadata
- 描述
- 标准对象元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- 类型
-
object
13.1.2. .spec
- 描述
FlowMetricSpec 定义所需的 FlowMetric。提供的 API 允许您根据您的需要自定义这些指标。
在添加新指标或修改现有标签时,您必须仔细监控 Prometheus 工作负载的内存用量,因为这可能会产生重大影响。Cf https://rhobs-handbook.netlify.app/products/openshiftmonitoring/telemetry.md/#what-is-the-cardinality-of-a-metric
要检查所有 Network Observability 指标的基数(cardinality),
promql
:count({name=~"netobserv.*"}) by (name)
。- 类型
-
object
- 必填
-
metricName
-
type
-
属性 | 类型 | 描述 |
---|---|---|
|
|
当 |
|
| 管理员视图中的 OpenShift Container Platform 控制台图表配置 Dashboards 菜单。 |
|
|
过滤入口、出口或任何方向流。当设置为 |
|
| 当非零时,缩放因素 (divider) 的值。指标值 = Flow value / Divider。 |
|
|
|
|
|
|
|
| 指标的名称。在 Prometheus 中,它会自动带有 "netobserv_" 前缀。 |
|
| 指标类型: "Counter" 或 "Histogram"。使用 "Counter",对随时间增加的任何值以及您可以计算速率(如 Bytes 或 Packets)的任何值。对于需要独立抽样的任何值(如延迟),使用 "Histogram"。 |
|
|
|
13.1.3. .spec.charts
- 描述
- 管理员视图中的 OpenShift Container Platform 控制台图表配置 Dashboards 菜单。
- 类型
-
数组
13.1.4. .spec.charts[]
- 描述
- 配置与一个指标关联的图表/仪表板的生成
- 类型
-
object
- 必填
-
dashboardName
-
queries
-
title
-
type
-
属性 | 类型 | 描述 |
---|---|---|
|
| 包含仪表板的名称。如果此名称没有引用现有仪表板,则会创建一个新仪表板。 |
|
|
要在此图表中显示的查询列表。如果 |
|
|
包含仪表板部分的名称。如果此名称没有引用现有部分,则会创建一个新部分。如果省略 |
|
| 图表的标题。 |
|
| 图表的类型。 |
|
| 此图表的单元。目前只支持几个单元。如果保留为空,则使用通用数字。 |
13.1.5. .spec.charts[].queries
- 描述
-
要在此图表中显示的查询列表。如果
type
是SingleStat
,并提供了多个查询,则在多个面板中会自动扩展此图表(每个查询一个)。 - 类型
-
数组
13.1.6. .spec.charts[].queries[]
- 描述
- 配置 PromQL 查询
- 类型
-
object
- 必填
-
图例
-
promQL
-
top
-
属性 | 类型 | 描述 |
---|---|---|
|
|
适用于此图表中每个时间序列的查询图例。显示多个时间序列时,您应该设置一个可区分每个时间序列的图例。它可以使用以下格式: |
|
|
要针对 Prometheus 运行 |
|
|
每个时间戳显示的最大 N 系列。不适用于 |
13.1.7. .spec.filters
- 描述
-
filters
是用于限制考虑哪些流的字段和值列表。通常,需要使用这些过滤消除重复项:Duplicate != "true"
和FlowDirection = "0"
有关可用字段列表,请参阅相关文档 :https://docs.openshift.com/container-platform/latest/observability/network_observability/json-flows-format-reference.html。 - 类型
-
数组
13.1.8. .spec.filters[]
- 描述
- 类型
-
object
- 必填
-
field
-
matchType
-
属性 | 类型 | 描述 |
---|---|---|
|
| 要过滤的字段名称 |
|
| 要应用的匹配类型 |
|
|
要过滤的值。当 |