Files
APIPark/module/dynamic-module/driver/embed/kafka-access-log/README.md
T
2024-08-12 21:38:09 +08:00

3.3 KiB
Raw Blame History

Kafka日志

基本介绍

日志是用来暴露系统内部状态的一种手段,好的日志可以帮助开发人员快速定位问题所在,然后找到合适的方式解决掉问题。该插件支持将节点访问日志输出到Kafka中。

功能特性

Kafka日志:能够将程序运行中产生的日志内容输出到指定Kafka集群队列中。

  • 支持多种请求协议,包括TCP、UDP、UNIX
  • 支持设置Syslog输出日志等级
  • 支持日志输出格式类型
  • 支持自定义日志格式化配置

功能演示

新建Kafka日志配置

1、点击左侧导航栏系统管理 -> Kafka日志,进入 Kafka日志列表页面,点击新建Kafka日志

2、填写Kafka日志配置

配置说明

字段名称 说明
版本 Kafka版本
服务器地址 Kafka服务地址,多个地址用英文逗号分隔
Topic Kafka服务Topic信息
Partition Type partition的选择方式,默认采用hash,选择hash时,若partition_key为空,则采用随机选择random
Partition Partition Type为manual时,该项指定分区号
Partition Key Partition Type为hash时,该项指定hash值
请求超时时间 超时时间,单位为second
输出格式 输出日志内容格式,支持单行、Json格式输出
格式化配置 输出格式模版,配置教程点此进行跳转

示例格式化配置

{
   "fields": [
      "$time_iso8601",
      "$request_id",
      "@request",
      "@proxy",
      "@response",
      "@status_code",
      "@time"
   ],
   "request": [
      "$request_method",
      "$scheme",
      "$request_uri",
      "$host",
      "$header",
      "$remote_addr"
   ],
   "proxy": [
      "$proxy_method",
      "$proxy_scheme",
      "$proxy_uri",
      "$proxy_host",
      "$proxy_header",
      "$proxy_addr"
   ],
   "response": [
      "$response_header"
   ],
   "status_code": [
      "$status",
      "$proxy_status"
   ],
   "time": [
      "$request_time",
      "$response_time"
   ]
}

3、点击确定后,Kafka日志添加完成

发布到集群

1、点击列表右侧小飞机按钮,将Kafka日志配置发布上线

2、选择其中需要发布上线的环境,点击上线

3、上线成功后,列表会实时显示相应集群的发布状态

更新日志

V1.02023-6-19

  • 插件上线