第 20 章 API 参考

输入

数组

（可选） 输入被命名过滤器，用于转发日志消息。

outputDefaults

对象

（可选） DEPRECATED OutputDefaults 为默认存储明确指定 forwarder 配置。

输出

数组

（可选） 输出的名称是日志消息的目的地。

pipelines

数组

Pipelines 将一组输入选择的消息转发到一组输出。

application

对象

（可选） 如果存在，应用程序启用命名的应用程序日志集合

name

字符串

用于引用管道输入的名称。

命名空间

数组

（可选） 从中收集应用程序日志的命名空间。

selector

对象

（可选） 匹配标签的 pod 的日志的 Selector。

matchLabels

对象

（可选） matchLabels 是 {key,value} 对的映射。matchLabels 中的单个 {key,value}

elasticsearch

对象

（可选） Elasticsearch OutputSpec 默认值

enableStructuredContainerLogs

bool

（可选） 启用StructuredContainerLogs 启用多容器结构化日志来允许

structuredTypeKey

字符串

（可选） StructuredTypeKey 指定要用作 elasticsearch 索引名称的元数据键

structuredTypeName

字符串

（可选） StructuredTypeName 指定 elasticsearch 模式的名称

syslog

对象

（可选）

fluentdForward

对象

（可选）

elasticsearch

对象

（可选）

kafka

对象

（可选）

cloudwatch

对象

（可选）

loki

对象

（可选）

googleCloudLogging

对象

（可选）

splunk

对象

（可选）

name

字符串

用于引用来自管道的输出的名称。

secret

对象

（可选） 用于身份验证的 Secret。

tls

对象

TLS 包含控制 TLS 客户端连接上的选项的设置。

type

字符串

输出插件的类型。

url

字符串

（可选） 将日志记录发送到的 URL。

name

字符串

为日志转发器 secret 配置的命名空间中 secret 的名称。

insecureSkipVerify

bool

如果 InsecureSkipVerify 为 true，则将配置 TLS 客户端来忽略证书的错误。

detectMultilineErrors

bool

（可选） DetectMultilineErrors 启用容器日志的多行错误检测

inputRefs

数组

inputRefs 列出此管道输入的名称 (input.name)。

labels

对象

（可选） 应用于通过此管道传递的记录的标签。

name

字符串

（可选） 名称是可选的，但如果提供，则必须在 pipelines 列表中唯一。

outputRefs

数组

outputRefs 列出此管道输出的名称(output.name)。

parse

字符串

（可选） Parse 允许将日志条目解析为结构化日志中

conditions

对象

日志转发器的条件。

输入

Conditions

输入将输入名称映射到输入条件。

输出

Conditions

输出将输出名称映射到输出的条件。

pipelines

Conditions

Pipelines 将管道名称映射到管道的条件。

spec

对象

ClusterLogging 所需的行为规格

status

对象

Status 定义 ClusterLogging 的观察状态

集合

对象

集群的 Collection 组件的规格

curation

对象

(已弃用) （可选） 已弃用。集群的 Curation 组件的规格

forwarder

对象

(已弃用) （可选） 已弃用。集群的 Forwarder 组件的规格

logStore

对象

（可选） 集群的日志存储组件的规格

managementState

字符串

（可选） 如果 Operator 是 'Managed' 或 'Unmanaged'，则查询

visualization

对象

（可选） 集群的可视化组件的规格

资源

对象

（可选） 收集器的资源要求

nodeSelector

对象

（可选） 定义 Pod 调度到哪些节点上。

容限（tolerations）

数组

（可选） 定义 Pod 将接受的容限

fluentd

对象

（可选） Fluentd 代表类型为 fluentd 的转发器的配置。

logs

对象

(已弃用) （可选） 已弃用。集群的 Log Collection 规格

type

字符串

（可选） 要配置的 Log Collection 类型

buffer

对象

inFile

对象

chunkLimitSize

字符串

（可选） ChunkLimitSize 代表每个块的最大大小。事件将是

flushInterval

字符串

（可选） FlushInterval 代表两个连续清除之间等待的时长

flushMode

字符串

（可选） FlushMode 代表要写入块的清除线程的模式。模式

flushThreadCount

int

（可选） FlushThreadCount reprents 缓冲区使用的线程数量

overflowAction

字符串

（可选） OverflowAction 代表 fluentd 缓冲插件的操作

retryMaxInterval

字符串

（可选） RetryMaxInterval 代表 exponential backoff 的最大时间间隔

retryTimeout

字符串

（可选） RetryTimeout 代表在放弃前尝试重试的最长时间

retryType

字符串

（可选） RetryType 代表重试清除操作的类型。flush 操作可以

retryWait

字符串

（可选） RetryWait 代表两个连续重试刷新之间的持续时间

totalLimitSize

字符串

（可选） TotalLimitSize 代表每个 fluentd 允许的节点空间阈值

readLinesLimit

int

（可选） ReadlinesLimit 代表要随每个 I/O 操作读取的行数

fluentd

对象

Fluentd Log Collection 组件的规格

type

字符串

要配置的日志集合类型

nodeSelector

对象

（可选） 定义 Pod 调度到哪些节点上。

资源

对象

（可选） 收集器的资源要求

容限（tolerations）

数组

（可选） 定义 Pod 将接受的容限

limits

对象

（可选） 限制描述了允许的最大计算资源量。

requests

对象

（可选） 请求描述了所需的最少计算资源。

effect

字符串

（可选） 效果表示要匹配的污点效果。空意味着匹配所有污点效果。

key

字符串

（可选） key 是容限应用到的污点键。empty 表示与所有污点键匹配。

operator

字符串

（可选） Operator 代表键与值的关系。

tolerationSeconds

int

（可选） TolerationSeconds 代表容限的期间（必须是

value

字符串

（可选） 值是容限匹配的污点值。

curator

对象

要配置的策展规格

type

字符串

要配置的策展类型

nodeSelector

对象

定义 Pod 调度到哪些节点上。

资源

对象

（可选） Curator 的资源要求

调度

字符串

Curator 作业运行的 cron 调度。默认为 "30 3 * * *"

容限（tolerations）

数组

limits

对象

（可选） 限制描述了允许的最大计算资源量。

requests

对象

（可选） 请求描述了所需的最少计算资源。

effect

字符串

（可选） 效果表示要匹配的污点效果。空意味着匹配所有污点效果。

key

字符串

（可选） key 是容限应用到的污点键。empty 表示与所有污点键匹配。

operator

字符串

（可选） Operator 代表键与值的关系。

tolerationSeconds

int

（可选） TolerationSeconds 代表容限的期间（必须是

value

字符串

（可选） 值是容限匹配的污点值。

fluentd

对象

buffer

对象

inFile

对象

chunkLimitSize

字符串

（可选） ChunkLimitSize 代表每个块的最大大小。事件将是

flushInterval

字符串

（可选） FlushInterval 代表两个连续清除之间等待的时长

flushMode

字符串

（可选） FlushMode 代表要写入块的清除线程的模式。模式

flushThreadCount

int

（可选） FlushThreadCount reprents 缓冲区使用的线程数量

overflowAction

字符串

（可选） OverflowAction 代表 fluentd 缓冲插件的操作

retryMaxInterval

字符串

（可选） RetryMaxInterval 代表 exponential backoff 的最大时间间隔

retryTimeout

字符串

（可选） RetryTimeout 代表在放弃前尝试重试的最长时间

retryType

字符串

（可选） RetryType 代表重试清除操作的类型。flush 操作可以

retryWait

字符串

（可选） RetryWait 代表两个连续重试刷新之间的持续时间

totalLimitSize

字符串

（可选） TotalLimitSize 代表每个 fluentd 允许的节点空间阈值

readLinesLimit

int

（可选） ReadlinesLimit 代表要随每个 I/O 操作读取的行数

elasticsearch

对象

Elasticsearch 日志存储组件的规格

lokistack

对象

LokiStack 包含有关当 Type 设置为 LogStoreTypeLokiStack 时用于日志存储的信息。

retentionPolicy

对象

（可选） 保留策略定义了应删除它的索引的最长期限

type

字符串

要配置的日志存储的类型。Operator 目前支持使用 ElasticSearch

nodeCount

int

为 Elasticsearch 部署的节点数量

nodeSelector

对象

定义 Pod 调度到哪些节点上。

proxy

对象

Elasticsearch Proxy 组件的规格

redundancyPolicy

字符串

（可选）

资源

对象

（可选） Elasticsearch 的资源要求

storage

对象

（可选） Elasticsearch 数据节点的存储规格

容限（tolerations）

数组

资源

对象

limits

对象

（可选） 限制描述了允许的最大计算资源量。

requests

对象

（可选） 请求描述了所需的最少计算资源。

limits

对象

（可选） 限制描述了允许的最大计算资源量。

requests

对象

（可选） 请求描述了所需的最少计算资源。

size

对象

要置备的节点的最大存储容量。

storageClassName

字符串

（可选） 用于创建节点的 PVC 的存储类的名称。

格�

字符串

更改格式将：有关 Reonicalize 的评论信息

d

对象

如果 d.Dec != nil, d 是 inf.Dec 表单的数量

i

int

如果 d.Dec == nil，i 是 int64 扩展形式的数量

s

字符串

s 是生成的这个数量的值，以避免重新计算

Dec

对象

scale

int

unscaled

对象

abs

Word

sign

neg

bool

scale

int

value

int

effect

字符串

（可选） 效果表示要匹配的污点效果。空意味着匹配所有污点效果。

key

字符串

（可选） key 是容限应用到的污点键。empty 表示与所有污点键匹配。

operator

字符串

（可选） Operator 代表键与值的关系。

tolerationSeconds

int

（可选） TolerationSeconds 代表容限的期间（必须是

value

字符串

（可选） 值是容限匹配的污点值。

name

字符串

LokiStack 资源的名称。

application

对象

audit

对象

Infra

对象

diskThresholdPercent

int

（可选） 一个 ES 磁盘用量的阈值，当达到这个阈值时应该删除旧索引（如 75）

maxAge

字符串

（可选）

namespaceSpec

数组

（可选） 每个命名空间规格，用于删除超过给定最小年龄的文档

pruneNamespacesInterval

字符串

（可选） 运行新修剪命名空间作业的频率

minAge

字符串

（可选） 删除与这个 MinAge 旧的命名空间匹配的记录（例如 1d）

namespace

字符串

目标命名空间删除早于 MinAge 的日志（默认为 7d）

diskThresholdPercent

int

（可选） 一个 ES 磁盘用量的阈值，当达到这个阈值时应该删除旧索引（如 75）

maxAge

字符串

（可选）

namespaceSpec

数组

（可选） 每个命名空间规格，用于删除超过给定最小年龄的文档

pruneNamespacesInterval

字符串

（可选） 运行新修剪命名空间作业的频率

minAge

字符串

（可选） 删除与这个 MinAge 旧的命名空间匹配的记录（例如 1d）

namespace

字符串

目标命名空间删除早于 MinAge 的日志（默认为 7d）

diskThresholdPercent

int

（可选） 一个 ES 磁盘用量的阈值，当达到这个阈值时应该删除旧索引（如 75）

maxAge

字符串

（可选）

namespaceSpec

数组

（可选） 每个命名空间规格，用于删除超过给定最小年龄的文档

pruneNamespacesInterval

字符串

（可选） 运行新修剪命名空间作业的频率

minAge

字符串

（可选） 删除与这个 MinAge 旧的命名空间匹配的记录（例如 1d）

namespace

字符串

目标命名空间删除早于 MinAge 的日志（默认为 7d）

kibana

对象

Kibana 视觉化组件的规格

type

字符串

要配置的可视化类型

nodeSelector

对象

定义 Pod 调度到哪些节点上。

proxy

对象

Kibana Proxy 组件的规格

replicas

int

为 Kibana 部署部署的实例数量

资源

对象

（可选） Kibana 的资源要求

容限（tolerations）

数组

资源

对象

limits

对象

（可选） 限制描述了允许的最大计算资源量。

requests

对象

（可选） 请求描述了所需的最少计算资源。

limits

对象

（可选） 限制描述了允许的最大计算资源量。

requests

对象

（可选） 请求描述了所需的最少计算资源。

effect

字符串

（可选） 效果表示要匹配的污点效果。空意味着匹配所有污点效果。

key

字符串

（可选） key 是容限应用到的污点键。empty 表示与所有污点键匹配。

operator

字符串

（可选） Operator 代表键与值的关系。

tolerationSeconds

int

（可选） TolerationSeconds 代表容限的期间（必须是

value

字符串

（可选） 值是容限匹配的污点值。

集合

对象

（可选）

conditions

对象

（可选）

curation

对象

（可选）

logStore

对象

（可选）

visualization

对象

（可选）

logs

对象

（可选）

fluentdStatus

对象

（可选）

clusterCondition

对象

（可选）

daemonSet

字符串

（可选）

节点

对象

（可选）

pods

字符串

（可选）

curatorStatus

数组

（可选）

clusterCondition

对象

（可选）

cronJobs

字符串

（可选）

调度

字符串

（可选）

暂停

bool

（可选）

elasticsearchStatus

数组

（可选）

cluster

对象

（可选）

clusterConditions

对象

（可选）

clusterHealth

字符串

（可选）

clusterName

字符串

（可选）

部署

数组

（可选）

nodeConditions

对象

（可选）

nodeCount

int

（可选）

pods

对象

（可选）

replicaSets

数组

（可选）

shardAllocationEnabled

字符串

（可选）

statefulSets

数组

（可选）

activePrimaryShards

int

Elasticsearch 集群的活跃主分片数量

activeShards

int

Elasticsearch 集群的活跃分片数量

initializingShards

int

Elasticsearch 集群的 Initializing Shards 数量

numDataNodes

int

Elasticsearch 集群的数据节点数量

numNodes

int

Elasticsearch 集群的节点数量

pendingTasks

int

relocatingShards

int

Elasticsearch 集群的重定位分片的数量

status

字符串

Elasticsearch 集群的当前状态

unassignedShards

int

Elasticsearch 集群的未分配的分片数量

kibanaStatus

数组

（可选）

clusterCondition

对象

（可选）

部署

字符串

（可选）

pods

字符串

（可选） Visualization 组件的每个 Kibana Pod 的状态

replicaSets

数组

（可选）

replicas

int

（可选）