Merge pull request #20 from loggie-io/feat-lgc-enhance

Feat lgc enhance

docs/reference/discovery/kubernetes/logconfig.md

@@ -70,17 +70,31 @@
     ```
     表示将配置的Pipelines下发至带有`nodepool: test`的所有node上。
 
+### type: loggie
+下发Pipeline配置至某个Loggie集群，通常需要配合`cluster`字段指定集群名使用。  
+
+!!! example 
+    ```yaml
+    spec: 
+      cluster: aggregator
+      selector:
+        type: loggie
+          
+    ```
+    表示将配置的Pipelines下发至`cluster`为aggregator的Loggie集群。
+
 
 ### cluster
 
 |    `字段`   |    `类型`    |  `是否必填`  |  `默认值`  |  `含义`  |
 | ---------- | ----------- | ----------- | --------- | -------- |
-| cluster | string  |    非必填    |  ""    | 表示配置指定下发的Loggie集群。当部署多套Loggie时，和全局配置`discovery.kubernetes.cluster`配套使用 |
+| cluster | string  |    非必填    |  ""    | 表示配置指定下发的Loggie集群。当部署多套Loggie时，和全局系统配置`discovery.kubernetes.cluster`配套使用 |
 
 
 
 ## spec.pipelines
-和在配置文件中Pipelines的区别在：
+和在配置文件中Pipelines的区别在：  
+
 - sources为实际为string，在yaml中使用`｜`表示保留换行符，同时增加了几个特殊的参数。
 - 没有sink，只有sinkRef，表示引用的Sink CRD实例
 - 没有interceptors，只有interceptorsRef，表示引用的Interceptors CRD实例

docs/reference/discovery/kubernetes/overview.md

@@ -4,7 +4,7 @@
 Loggie定义了3个CRD用于在Kubernetes集群环境里下发配置：  
 
 ## [`LogConfig`](logconfig.md)
-namespace级别，表示一个Pipeline配置，包括采集Pods的容器日志，采集Node节点上的日志等  
+namespace级别，表示一个Pipeline配置，包括采集Pods的容器日志，采集Node节点上的日志，将pipeline配置下发至指定cluster的Loggie集群  
   
 ## [`Sink`](sink.md)
 cluster级别，表示一个sink配置，可以在LogConfig中引用该Sink  

docs/reference/global/args.md

@@ -12,6 +12,7 @@
 
 - `-log.level`: 日志级别，默认为info，可配置为debug、info、warn和error
 - `-log.jsonFormat`: 是否将日志输出为json格式，默认为true
+- `-log.enableStdout`: 是否输出标准输出日志，默认为true
 - `-log.enableFile`: 是否输出日志文件，默认为false，即不输出日志文件，默认打印到标准输出
 - `-log.directory`: 日志文件的路径，默认为/var/log，当log.enableFile=true时生效
 - `-log.filename`: 日志文件的名称，默认为loggie.log，一般同log.directory搭配使用

docs/reference/global/monitor.md

@@ -23,6 +23,14 @@
 | logger | map  |    非必填    |      | 控制监控指标metrics输出到Loggie本身的日志中 |
 | logger.enabled | bool  |    非必填    |  false    | 是否开启 |
 | logger.period | time.Duration  |    非必填    |  10s    | 指标打印的时间间隔，数据量较大时建议将间隔延长，如30s、5m |
+| logger.pretty | bool  |    非必填    |  false    | 打印的指标json是否需要友好展示 |
+| logger.additionLogEnabled | bool  |    非必填    |  false    | 是否需要将打印的指标单独输出到另外的日志文件中，在数据量比较多的情况下，如果我们配置的打印时间间隔较短，可以打开该开关，避免太多的metrics日志干扰 |
+| logger.additionLogConfig |   |    非必填    |      | 额外输出的日志配置参数 |
+| logger.additionLogConfig.directory | bool  |    非必填    |  /data/loggie/log    | 额外输出的日志目录 |
+| logger.additionLogConfig.maxBackups | int  |    非必填    |  metrics.log    | 日志轮转最多保留的文件个数，默认为3 |
+| logger.additionLogConfig.maxSize | int  |    非必填    |  1024    | 日志轮转的时候，最大的文件大小，单位为MB |
+| logger.additionLogConfig.maxAge | int  |    非必填    |  14    | 日志轮转最大保留的天数 |
+| logger.additionLogConfig.timeFormat | string  |    非必填    |  2006-01-02 15:04:05    | 每行日志输出的时间格式 |
 
 
 ## listeners  

nav.yml

@@ -54,7 +54,7 @@ nav:
       - Overview: reference/index.md
       - 启动参数: reference/global/args.md
       - 系统配置: 
-        - overview: reference/global/system.md
+        - Overview: reference/global/system.md
         - monitor: reference/global/monitor.md
         - discovery: reference/global/discovery.md
         - reload: reference/global/reload.md
@@ -85,9 +85,9 @@ nav:
         - memeory: reference/pipelines/queue/memory.md
       - Kubernetes CRD: 
         - Overview: reference/discovery/kubernetes/overview.md
-        - LogConfig: reference/discovery/kubernetes/logconfig.md
-        - Sink: reference/discovery/kubernetes/sink.md
-        - Interceptor: reference/discovery/kubernetes/interceptors.md
+        - logConfig: reference/discovery/kubernetes/logconfig.md
+        - sink: reference/discovery/kubernetes/sink.md
+        - interceptor: reference/discovery/kubernetes/interceptors.md
       
     - 开发手册:
       - Overview: developer-guide/index.md