28.9. FlowCollector 配置参数

agent

object

流提取的代理配置。

consolePlugin

object

ConsolePlugin 定义与 OpenShift Container Platform 控制台插件相关的设置（如果可用）。

deploymentModel

字符串

deploymentModel 定义所需的用于流处理的部署类型。可能的值有：
- DIRECT （默认）使流处理器直接从代理侦听。
- KAFKA - KAFKA 在处理器消耗前发送到 Kafka 管道。
Kafka 可以提供更好的可扩展性、弹性和高可用性（更多详情，请参阅 https://www.redhat.com/en/topics/integration/what-is-apache-kafka）。

exporters

数组

exporters 为自定义消耗或存储定义了额外的可选导出器。

kafka

object

Kafka 配置，允许使用 Kafka 作为流集合管道的一部分。当 spec.deploymentModel 为 KAFKA 时可用。

loki

object

Loki，流存储、客户端设置。

namespace

字符串

部署 NetObserv pod 的命名空间。如果为空，则将使用 Operator 的命名空间。

processor

object

processor 定义从代理接收流的组件设置，增强它们，生成指标，并将它们转发到 Loki 持久层和/或任何可用的导出器。

ebpf

object

ebpf 描述了当 spec.agent.type 设置为 EBPF 时，与基于 eBPF 的流报告程序相关的设置。

ipfix

object

ipfix - 已弃用 (*) - 描述了当 spec.agent.type 设置为 IPFIX 时，与基于 IPFIX 的流报告程序相关的设置。

type

字符串

type 选择流追踪代理。可能的值有：
- EBPF （默认）使用 NetObserv eBPF 代理。
- IPFIX - 已弃用 (*) - 使用旧的 IPFIX 收集器。
建议使用 EBPF，因为它提供更好的性能，并应该可以正常工作，无论集群中是否安装了 CNI。IPFIX 与 OVN-Kubernetes CNI 一起工作（如果支持导出 IPFIX，则其他 CNI 可以正常工作，但需要手动配置）。

cacheActiveTimeout

字符串

cacheActiveTimeout 是报告者在发送前聚合流的最大周期。增加 cacheMaxFlows 和 cacheActiveTimeout 可能会降低网络流量开销和 CPU 负载，但您可以预期更高的内存消耗和流集合中的延迟增加。

cacheMaxFlows

整数

cacheMaxFlows 是聚合中的最大流数；达到时，报告者会发送流。增加 cacheMaxFlows 和 cacheActiveTimeout 可能会降低网络流量开销和 CPU 负载，但您可以预期更高的内存消耗和流集合中的延迟增加。

debug

object

debug 允许设置 eBPF 代理的内部配置的一些方面。本节专门用于调试和精细的性能优化，如 GOGC 和 GOMAXPROCS env vars。用户设置其值会自行承担任何风险。

excludeInterfaces

数组（字符串）

excludeInterfaces 包含从流追踪中排除的接口名称。条目用斜杠括起，如 /br-/，与正则表达式匹配。否则，它将匹配为区分大小写的字符串。

imagePullPolicy

字符串

imagePullPolicy 是上面定义的镜像的 Kubernetes pull 策略

interfaces

数组（字符串）

interfaces 包含从中收集流的接口名称。如果为空，代理将获取系统中的所有接口，但 ExcludeInterfaces 中列出的接口除外。条目用斜杠括起，如 /br-/，与正则表达式匹配。否则，它将匹配为区分大小写的字符串。

kafkaBatchSize

整数

kafkaBatchSize 在发送到分区前限制请求的最大大小（以字节为单位）。如果不使用 Kafka，则忽略。默认：10MB。

logLevel

字符串

logLevel 定义 NetObserv eBPF 代理的日志级别

privileged

布尔值

eBPF Agent 容器的特权模式。通常，此设置可以忽略或设置为 false：在这种情况下，Operator 会将粒度功能(BPF、PERFMON、NET_ADMIN、SYS_RESOURCE)设置为容器，以启用其正确的操作。如果出于某种原因而无法设置这些功能，例如，如果旧的内核版本不知道 CAP_BPF，那么您可以打开此模式以获取更多全局权限。

资源

object

resources 是此容器所需的计算资源。更多信息： https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

sampling

整数

流报告器的抽样率。100 表示发送 100 个流中的一个。0 或 1 表示所有流都是抽样的。

env

对象（字符串）

env 允许将自定义环境变量传递给底层组件。对于传递一些非常严格的性能调整选项（如 GOGC、GOMAXPROCS ）非常有用，它们不应作为 FlowCollector 描述符的一部分公开，因为它们仅在边缘调试或支持场景中有用。

limits

integer-or-string

限制描述了允许的最大计算资源量。更多信息： https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

requests

integer-or-string

Requests 描述了所需的最少计算资源。如果容器省略了 Requests，则默认为 Limits （如果明确指定），否则默认为实现定义的值。更多信息： https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

cacheActiveTimeout

字符串

cacheActiveTimeout 是报告者在发送前聚合流的最大周期

cacheMaxFlows

整数

cacheMaxFlows 是聚合中的最大流数；达到时，报告者会发送流

clusterNetworkOperator

object

clusterNetworkOperator 定义与 OpenShift Container Platform Cluster Network Operator 相关的设置（如果可用）。

forceSampleAll

布尔值

forceSampleAll 允许在基于 IPFIX 的流报告程序中禁用抽样。不建议通过 IPFIX 对所有流量进行抽样，因为它可能会生成集群不稳定。如果 REALLY 希望这样做，请将此标志设置为 true。自行使用风险。当设为 true 时， sampling 的值将被忽略。

ovnKubernetes

object

ovnKubernetes 定义 OVN-Kubernetes CNI 的设置（如果可用）。在没有 OpenShift Container Platform 的情况下使用 OVN 的 IPFIX 导出时使用此配置。使用 OpenShift Container Platform 时，请参阅 clusterNetworkOperator 属性。

sampling

整数

sampling 是 reporter 的抽样率。100 表示发送 100 个流中的一个。为确保集群稳定性，它不能设置为低于 2 的值。如果您真正希望对影响集群稳定性的每个数据包进行抽样，请参阅 forceSampleAll。或者，您可以使用 eBPF 代理而不是 IPFIX。

namespace

字符串

部署配置映射的命名空间。

containerName

字符串

containerName 定义要为 IPFIX 配置的容器的名称。

daemonSetName

字符串

daemonSetName 定义控制 OVN-Kubernetes pod 的 DaemonSet 的名称。

namespace

字符串

部署 OVN-Kubernetes pod 的命名空间。

autoscaler

object

Pod 横向自动扩展的 autoscaler 规格来为插件部署设置。请参阅 HorizontalPodAutoscaler 文档(autoscaling/v2)。

imagePullPolicy

字符串

imagePullPolicy 是上面定义的镜像的 Kubernetes pull 策略

logLevel

字符串

控制台插件后端的 logLevel

端口

整数

port 是插件服务端口。不要使用 9002，它为指标保留。

portNaming

object

portNaming 定义端口到服务名称转换的配置

quickFilters

数组

quickFilters 为 Console 插件配置快速过滤器预设置

register

布尔值

register 允许（设置为 true 时），在 OpenShift Container Platform Console Operator 中自动注册提供的控制台插件。当设置为 false 时，您仍然可以使用以下命令编辑 console.operator.openshift.io/cluster 来手动注册它： oc patch console.operator.openshift.io cluster --type='json' -p '[{"op": "add", "path": "/spec/plugins/-", "value": "netobserv-plugin"}]'

replicas

整数

replicas 定义要启动的副本（pod）数。

资源

object

resources，根据此容器所需的计算资源。更多信息： https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

enable

布尔值

启用 console 插件端口到服务名称转换

portNames

对象（字符串）

portNames 定义了在控制台中使用的额外端口名称，例如 portNames: {"3100": "loki"}。

default

布尔值

default 定义默认是否应激活此过滤器

filter

对象（字符串）

filter 是一组在选择此过滤器时要设置的键和值。每个键都可以与使用组合字符串的值列表相关，例如 filter: {"src_namespace": "namespace1,namespace2"}。

name

字符串

过滤器的名称，它将在控制台中显示

limits

integer-or-string

限制描述了允许的最大计算资源量。更多信息： https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

requests

integer-or-string

Requests 描述了所需的最少计算资源。如果容器省略了 Requests，则默认为 Limits （如果明确指定），否则默认为实现定义的值。更多信息： https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

ipfix

object

IPFIX 配置，如 IP 地址和端口，以将增强的 IPFIX 流发送到。不支持 (*)。

kafka

object

Kafka 配置（如地址和主题）将增强的流发送到。

type

字符串

type 选择导出器类型。可用的选项有 KAFKA 和 IPFIX。IPFIX 不被支持 (*)。

targetHost

字符串

IPFIX 外部接收器的地址

targetPort

整数

IPFIX 外部接收器的端口

传输

字符串

用于 IPFIX 连接的传输协议(TCP 或 UDP)，默认为 TCP。

address

字符串

Kafka 服务器的地址

tls

object

TLS 客户端配置。在使用 TLS 时，验证地址是否与用于 TLS 的 Kafka 端口匹配，通常为 9093。请注意，当使用 eBPF 代理时，Kafka 证书需要复制到代理命名空间中（默认为 netobserv-privileged）。

topic

字符串

要使用的 Kafka 主题。它必须存在，NetObserv 将不会创建它。

caCert

object

caCert 定义证书颁发机构的证书引用

enable

布尔值

启用 TLS

insecureSkipVerify

布尔值

insecureSkipVerify 允许跳过服务器证书的客户端验证。如果设置为 true，则忽略 caCert 字段。

userCert

object

userCert 定义用户证书引用，用于 mTLS （您可以在使用单向 TLS 时忽略它）

certFile

字符串

certFile 定义配置映射或 secret 中证书文件名的路径

certKey

字符串

certKey 定义配置映射 / Secret 中证书私钥文件名的路径。当不需要键时会省略。

name

字符串

包含证书的配置映射或 Secret 的名称

namespace

字符串

包含证书的配置映射或 secret 的命名空间。如果省略，假设与部署 NetObserv 的命名空间相同。如果命名空间不同，则会复制配置映射或 secret，以便可以根据需要挂载它。

type

字符串

证书引用的类型：configmap 或 secret

certFile

字符串

certFile 定义配置映射或 secret 中证书文件名的路径

certKey

字符串

certKey 定义配置映射 / Secret 中证书私钥文件名的路径。当不需要键时会省略。

name

字符串

包含证书的配置映射或 Secret 的名称

namespace

字符串

包含证书的配置映射或 secret 的命名空间。如果省略，假设与部署 NetObserv 的命名空间相同。如果命名空间不同，则会复制配置映射或 secret，以便可以根据需要挂载它。

type

字符串

证书引用的类型：configmap 或 secret

address

字符串

Kafka 服务器的地址

tls

object

TLS 客户端配置。在使用 TLS 时，验证地址是否与用于 TLS 的 Kafka 端口匹配，通常为 9093。请注意，当使用 eBPF 代理时，Kafka 证书需要复制到代理命名空间中（默认为 netobserv-privileged）。

topic

字符串

要使用的 Kafka 主题。它必须存在，NetObserv 将不会创建它。

caCert

object

caCert 定义证书颁发机构的证书引用

enable

布尔值

启用 TLS

insecureSkipVerify

布尔值

insecureSkipVerify 允许跳过服务器证书的客户端验证。如果设置为 true，则忽略 caCert 字段。

userCert

object

userCert 定义用户证书引用，用于 mTLS （您可以在使用单向 TLS 时忽略它）

certFile

字符串

certFile 定义配置映射或 secret 中证书文件名的路径

certKey

字符串

certKey 定义配置映射 / Secret 中证书私钥文件名的路径。当不需要键时会省略。

name

字符串

包含证书的配置映射或 Secret 的名称

namespace

字符串

包含证书的配置映射或 secret 的命名空间。如果省略，假设与部署 NetObserv 的命名空间相同。如果命名空间不同，则会复制配置映射或 secret，以便可以根据需要挂载它。

type

字符串

证书引用的类型：configmap 或 secret

certFile

字符串

certFile 定义配置映射或 secret 中证书文件名的路径

certKey

字符串

certKey 定义配置映射 / Secret 中证书私钥文件名的路径。当不需要键时会省略。

name

字符串

包含证书的配置映射或 Secret 的名称

namespace

字符串

包含证书的配置映射或 secret 的命名空间。如果省略，假设与部署 NetObserv 的命名空间相同。如果命名空间不同，则会复制配置映射或 secret，以便可以根据需要挂载它。

type

字符串

证书引用的类型：configmap 或 secret

authToken

字符串

authToken 描述了获取向 Loki 进行身份验证的令牌。
- DISABLED 不会发送带有请求的任何令牌。
- FORWARD 将转发授权的用户令牌。
- HOST - 弃用 (*) RTT - 将使用本地 pod 服务帐户向 Loki 进行身份验证。
使用 Loki Operator 时，必须设置为 FORWARD。

batchSize

整数

batchSize 是发送前要积累的日志的最大批处理大小（以字节为单位）。

batchWait

字符串

batchWait 是发送批处理前等待的最长时间。

maxBackoff

字符串

maxBackoff 是重试之间客户端连接的最大 backoff 时间。

maxRetries

整数

maxRetries 是客户端连接的最大重试次数。

minBackoff

字符串

minBackoff 是重试之间客户端连接的初始 backoff 时间。

querierUrl

字符串

querierUrl 指定 Loki querier 服务的地址，如果它与 Loki ingester URL 不同。如果为空，则使用 URL 值（假设 Loki ingester 和 querier 位于同一服务器中）。使用 Loki Operator 时，请不要设置它，因为 ingestion 和 query 使用 Loki 网关。

staticLabels

对象（字符串）

staticLabels 是每个流上设置的通用标签映射。

statusTls

object

Loki 状态 URL 的 TLS 客户端配置。

statusUrl

字符串

statusUrl 指定 Loki /ready、/metrics 和 /config 端点的地址，如果它与 Loki querier URL 不同。如果为空，则使用 querierURL 值。这可用于在前端中显示错误消息和一些上下文。使用 Loki Operator 时，将其设置为 Loki HTTP 查询前端服务，例如 https://loki-query-frontend-http.netobserv.svc:3100/。当设置 statusUrl 时，将使用 statusTLS 配置。

tenantID

字符串

tenantId 是 Loki X-Scope-OrgID，用于标识每个请求的租户。使用 Loki Operator 时，将其设置为 network，这对应于一个特殊的租户模式。

timeout

字符串

timeout 是最大时间连接/请求限制。超时值为零表示没有超时。

tls

object

Loki URL 的 TLS 客户端配置。

url

字符串

url 是要推送流至的现有 Loki 服务的地址。使用 Loki Operator 时，使用路径中设置的 network 租户将其设置为 Loki 网关服务，例如 https://loki-gateway-http.netobserv.svc:8080/api/logs/v1/network。

caCert

object

caCert 定义证书颁发机构的证书引用

enable

布尔值

启用 TLS

insecureSkipVerify

布尔值

insecureSkipVerify 允许跳过服务器证书的客户端验证。如果设置为 true，则忽略 caCert 字段。

userCert

object

userCert 定义用户证书引用，用于 mTLS （您可以在使用单向 TLS 时忽略它）

certFile

字符串

certFile 定义配置映射或 secret 中证书文件名的路径

certKey

字符串

certKey 定义配置映射 / Secret 中证书私钥文件名的路径。当不需要键时会省略。

name

字符串

包含证书的配置映射或 Secret 的名称

namespace

字符串

包含证书的配置映射或 secret 的命名空间。如果省略，假设与部署 NetObserv 的命名空间相同。如果命名空间不同，则会复制配置映射或 secret，以便可以根据需要挂载它。

type

字符串

证书引用的类型：configmap 或 secret

certFile

字符串

certFile 定义配置映射或 secret 中证书文件名的路径

certKey

字符串

certKey 定义配置映射 / Secret 中证书私钥文件名的路径。当不需要键时会省略。

name

字符串

包含证书的配置映射或 Secret 的名称

namespace

字符串

包含证书的配置映射或 secret 的命名空间。如果省略，假设与部署 NetObserv 的命名空间相同。如果命名空间不同，则会复制配置映射或 secret，以便可以根据需要挂载它。

type

字符串

证书引用的类型：configmap 或 secret

caCert

object

caCert 定义证书颁发机构的证书引用

enable

布尔值

启用 TLS

insecureSkipVerify

布尔值

insecureSkipVerify 允许跳过服务器证书的客户端验证。如果设置为 true，则忽略 caCert 字段。

userCert

object

userCert 定义用户证书引用，用于 mTLS （您可以在使用单向 TLS 时忽略它）

certFile

字符串

certFile 定义配置映射或 secret 中证书文件名的路径

certKey

字符串

certKey 定义配置映射 / Secret 中证书私钥文件名的路径。当不需要键时会省略。

name

字符串

包含证书的配置映射或 Secret 的名称

namespace

字符串

包含证书的配置映射或 secret 的命名空间。如果省略，假设与部署 NetObserv 的命名空间相同。如果命名空间不同，则会复制配置映射或 secret，以便可以根据需要挂载它。

type

字符串

证书引用的类型：configmap 或 secret

certFile

字符串

certFile 定义配置映射或 secret 中证书文件名的路径

certKey

字符串

certKey 定义配置映射 / Secret 中证书私钥文件名的路径。当不需要键时会省略。

name

字符串

包含证书的配置映射或 Secret 的名称

namespace

字符串

包含证书的配置映射或 secret 的命名空间。如果省略，假设与部署 NetObserv 的命名空间相同。如果命名空间不同，则会复制配置映射或 secret，以便可以根据需要挂载它。

type

字符串

证书引用的类型：configmap 或 secret

conversationEndTimeout

字符串

conversationEndTimeout 是收到网络流后等待的时间，请考虑对话结束的时间。为 TCP 流收集 FIN 数据包时会忽略此延迟（请参阅 conversationTerminatingTimeout）。

conversationHeartbeatInterval

字符串

conversationHeartbeatInterval 是对话的 "tick" 事件间的等待时间

conversationTerminatingTimeout

字符串

conversationTerminatingTimeout 是从检测到的 FIN 标志到对话结束间的等待时间。只适用于 TCP 流。

debug

object

debug 允许设置流处理器的内部配置。本节专门用于调试和精细的性能优化，如 GOGC 和 GOMAXPROCS env vars。用户设置其值会自行承担任何风险。

dropUnusedFields

布尔值

dropUnusedFields 允许，当设为 true 时，可以丢弃由 OVS 未使用的字段，以节省存储空间。

enableKubeProbes

布尔值

enableKubeProbes 是一个用于启用或禁用 Kubernetes 存活度和就绪度探测的标志

healthPort

整数

healthPort 是 Pod 中的收集器 HTTP 端口，用于公开健康检查 API

imagePullPolicy

字符串

imagePullPolicy 是上面定义的镜像的 Kubernetes pull 策略

kafkaConsumerAutoscaler

object

kafkaConsumerAutoscaler 是 Pod 横向自动扩展的 spec，用于 flowlogs-pipeline-transformer，它使用 Kafka 信息。当 Kafka 被禁用时，会忽略此设置。请参阅 HorizontalPodAutoscaler 文档(autoscaling/v2)。

kafkaConsumerBatchSize

整数

kafkaConsumerBatchSize 表示代理消费者将接受的最大批处理大小（以字节为单位）。如果不使用 Kafka，则忽略。默认：10MB。

kafkaConsumerQueueCapacity

整数

kafkaConsumerQueueCapacity 定义 Kafka 消费者客户端中使用的内部消息队列的容量。如果不使用 Kafka，则忽略。

kafkaConsumerReplicas

整数

kafkaConsumerReplicas 定义了为 flowlogs-pipeline-transformer 启动的副本数，它使用 Kafka 信息。当 Kafka 被禁用时，会忽略此设置。

logLevel

字符串

处理器运行时的 logLevel

logTypes

字符串

logTypes 定义要生成的记录类型。可能的值有：
- FLOWS （默认）导出常规网络流
- CONVERSATIONS，生成用于开始对话的事件、结束对话以及定期的"tick"更新
- ENDED_CONVERSATIONS 以仅生成终止的对话事件
- ALL 以生成网络流和所有对话事件

metrics

object

Metrics 定义有关指标的处理器配置

端口

整数

流收集器（主机端口）的端口。按照惯例，一些值会被禁止。它必须大于 1024，且不能是 4500、4789 和 6081。

profilePort

整数

profilePort 允许设置侦听此端口的 Go pprof profiler

资源

object

resources 是此容器所需的计算资源。更多信息： https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

env

对象（字符串）

env 允许将自定义环境变量传递给底层组件。对于传递一些非常严格的性能调整选项（如 GOGC、GOMAXPROCS ）非常有用，它们不应作为 FlowCollector 描述符的一部分公开，因为它们仅在边缘调试或支持场景中有用。

disableAlerts

数组（字符串）

disableAlerts 是应禁用的警报列表。可能的值是：
NetObservNoFlows，它会在特定时间段内没有观察到流时触发。
NetObservLokiError，它会在因为 Loki 错误而丢弃流时触发。

ignoreTags

数组（字符串）

ignoreTags 是标签列表，用于指定要忽略哪些指标。每个指标都与一个标签列表关联。更多详情包括在 https://github.com/netobserv/network-observability-operator/tree/main/controllers/flowlogspipeline/metrics_definitions。可用标签有：egress, ingress, flows, bytes, packets, namespaces, nodes, workloads。

server

object

Prometheus scraper 的指标服务器端点配置

端口

整数

prometheus HTTP 端口

tls

object

TLS 配置。

provided

object

当 type 设置为 PROVIDED 时，TLS 的配置。

type

字符串

选择 TLS 配置类型：
- DISABLED （默认）来为端点配置 TLS。- PROVIDED 以手动提供证书文件和密钥文件。- AUTO 使用注解使用 OpenShift Container Platform 自动生成的证书。

certFile

字符串

certFile 定义配置映射或 secret 中证书文件名的路径

certKey

字符串

certKey 定义配置映射 / Secret 中证书私钥文件名的路径。当不需要键时会省略。

name

字符串

包含证书的配置映射或 Secret 的名称

namespace

字符串

包含证书的配置映射或 secret 的命名空间。如果省略，假设与部署 NetObserv 的命名空间相同。如果命名空间不同，则会复制配置映射或 secret，以便可以根据需要挂载它。

type

字符串

证书引用的类型：configmap 或 secret

limits

integer-or-string

限制描述了允许的最大计算资源量。更多信息： https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

requests

integer-or-string

Requests 描述了所需的最少计算资源。如果容器省略了 Requests，则默认为 Limits （如果明确指定），否则默认为实现定义的值。更多信息： https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/