配置

昆仑中间件将运行配置存储于环境变量中，环境变量可以非常方便地在不同的部署间做修改（无需改动代码）。 与一些传统的解决配置问题的机制（比如 Java 的属性配置文件）相比，环境变量与语言和系统无关。

kunlun-proxy

TIP

配置文件路径为：/etc/default/kunlun-proxy

• JAVA_OPTS
  • 说明：Java 运行时的相关配置参数
  • 默认值：" -Djdk.tls.rejectClientInitiatedRenegotiation=true -Dvertx.disableTCCL=true -Dvertx.disableWebsockets=true -Duser.timezone=Asia/Shanghai -Duser.language=zh -Duser.region=CN -XX:+HeapDumpOnOutOfMemoryError -XX:InitiatingHeapOccupancyPercent=30"
  • 可选值：无
• JAVA_HOME
  • 说明：Java 安装目录的环境变量
  • 默认值：无
  • 可选值：无
• SERVER_GRPC_BIND_HOST
  • 说明：gRPC 服务绑定的主机地址
  • 默认值：0.0.0.0
  • 可选值：无
• SERVER_GRPC_BIND_PORT
  • 说明：gRPC 服务绑定的端口
  • 默认值：19080
  • 可选值：无
• SERVER_GRPC_CA_FILE
  • 说明：gRPC 服务的 CA 文件路径
  • 默认值：无
  • 可选值：无
• SERVER_GRPC_KEY_FILE
  • 说明：gRPC 服务的密钥文件路径
  • 默认值：无
  • 可选值：无
• SERVER_GRPC_CERT_FILE
  • 说明：gRPC 服务的证书文件路径
  • 默认值：无
  • 可选值：无
• SERVER_HTTP_BIND_HOST
  • 说明：HTTP 服务监听地址
  • 默认值：0.0.0.0
  • 可选值：无
• SERVER_HTTP_BIND_PORT
  • 说明：HTTP 服务监听端口
  • 默认值：9080
  • 可选值：无
• SERVER_HTTP_ACCEPT_BACKLOG
  • 说明：HTTP 服务的接受队列长度
  • 默认值：-1
  • 可选值：无
• SERVER_HTTP_MAX_HEADER_SIZE
  • 说明：HTTP 服务的最大头部大小
  • 默认值：8192
  • 可选值：无
• SERVER_HTTP_MAX_CHUNK_SIZE
  • 说明：HTTP 服务的最大分块大小
  • 默认值：8192
  • 可选值：无
• SERVER_HTTP_MAX_IDLE_TIMEOUT
  • 说明：HTTP 服务的最大空闲超时时间
  • 默认值：75000
  • 可选值：无
• SERVER_HTTP_USE_PROXY_PROTOCOL
  • 说明：是否使用代理协议
  • 默认值：off
  • 可选值：on | off
• SERVER_HTTP_PROXY_PROTOCOL_TIMEOUT
  • 说明：代理协议超时时间
  • 默认值：10000
  • 可选值：无
• SERVER_HTTP_LOG_DATA_ACTIVITY
  • 说明：是否记录 HTTP 服务的数据活动日志
  • 默认值：on
  • 可选值：on | off
• SERVER_HTTP_LOG_DATA_FORMAT
  • 说明：HTTP 服务的日志数据格式
  • 默认值：simple
  • 可选值：hexdump | simple
• SERVER_HTTPS_BIND_HOST
  • 说明：HTTPS 服务监听地址
  • 默认值：0.0.0.0
  • 可选值：无
• SERVER_HTTPS_BIND_PORT
  • 说明：HTTPS 服务监听端口
  • 默认值：9443
  • 可选值：无
• SERVER_HTTPS_ACCEPT_BACKLOG
  • 说明：HTTPS 服务的接受队列长度
  • 默认值：-1
  • 可选值：无
• SERVER_HTTPS_MAX_HEADER_SIZE
  • 说明：HTTPS 服务的最大头部大小
  • 默认值：8192
  • 可选值：无
• SERVER_HTTPS_MAX_CHUNK_SIZE
  • 说明：HTTPS 服务的最大分块大小
  • 默认值：8192
  • 可选值：无
• SERVER_HTTPS_MAX_IDLE_TIMEOUT
  • 说明：HTTPS 服务的最大空闲超时时间
  • 默认值：75000
  • 可选值：无
• SERVER_HTTPS_SSL_USE_WORKER_THREAD
  • 说明：是否使用 SSL 工作线程
  • 默认值：off
  • 可选值：on | off
• SERVER_HTTPS_SSL_HANDSHAKE_TIMEOUT
  • 说明：SSL 握手超时时间
  • 默认值：10000
  • 可选值：无
• SERVER_HTTPS_SSL_CLIENT_HELLO_MAX_LENGTH
  • 说明：SSL 客户端问候的最大长度
  • 默认值：4096
  • 可选值：无
• SERVER_HTTPS_SSL_CLIENT_AUTH
  • 说明：是否进行 SSL 客户端认证
  • 默认值：on
  • 可选值：on | off
• SERVER_HTTPS_SSL_FORBIDDEN_PROTOCOLS
  • 说明：禁止的 SSL 协议
  • 默认值：TLSv1,TLSv1.1
  • 可选值：无
• SERVER_HTTPS_USE_ALPN
  • 说明：是否使用 ALPN
  • 默认值：on
  • 可选值：on | off
• SERVER_HTTPS_USE_PROXY_PROTOCOL
  • 说明：是否使用代理协议
  • 默认值：off
  • 可选值：on | off
• SERVER_HTTPS_PROXY_PROTOCOL_TIMEOUT
  • 说明：代理协议超时时间
  • 默认值：10000
  • 可选值：无
• SERVER_HTTPS_LOG_DATA_ACTIVITY
  • 说明：是否记录 HTTPS 服务的数据活动日志
  • 默认值：on
  • 可选值：on | off
• SERVER_HTTPS_LOG_DATA_FORMAT
  • 说明：HTTPS 服务的日志数据格式
  • 默认值：simple
  • 可选值：hexdump | simple
• SERVER_HTTP2_MAX_FRAME_SIZE
  • 说明：HTTP2 的最大帧大小
  • 默认值：16384
  • 可选值：无
• SERVER_HTTP2_MAX_HEADER_LIST_SIZE
  • 说明：HTTP2 的最大头部列表大小
  • 默认值：8192
  • 可选值：无
• SERVER_HTTP2_INITIAL_WINDOW_SIZE
  • 说明：HTTP2 的初始窗口大小
  • 默认值：65535
  • 可选值：无
• CLIENT_HTTP_SHARED
  • 说明：是否共享 HTTP 客户端
  • 默认值：on
  • 可选值：on | off
• CLIENT_HTTP_MAX_POOL_SIZE
  • 说明：HTTP 客户端的最大池大小
  • 默认值：1024
  • 可选值：无
• CLIENT_HTTP_MAX_WAIT_QUEUE_SIZE
  • 说明：HTTP 客户端的最大等待队列大小
  • 默认值：256
  • 可选值：无
• CLIENT_HTTP_IDLE_TIMEOUT
  • 说明：HTTP 客户端的空闲超时时间
  • 默认值：300000
  • 可选值：无
• CLIENT_HTTP_CONNECT_TIMEOUT
  • 说明：HTTP 客户端的连接超时时间
  • 默认值：3000
  • 可选值：无
• CLIENT_HTTP_VERIFY_HOST
  • 说明：是否验证主机
  • 默认值：off
  • 可选值：on | off
• CLIENT_HTTP2_SHARED
  • 说明：是否共享 HTTP2 客户端
  • 默认值：off
  • 可选值：on | off
• CLIENT_HTTP2_MAX_POOL_SIZE
  • 说明：HTTP2 客户端的最大池大小
  • 默认值：256
  • 可选值：无
• CLIENT_HTTP2_MAX_WAIT_QUEUE_SIZE
  • 说明：HTTP2 客户端的最大等待队列大小
  • 默认值：1024
  • 可选值：无
• CLIENT_HTTP2_IDLE_TIMEOUT
  • 说明：HTTP2 客户端的空闲超时时间
  • 默认值：300000
  • 可选值：无
• CLIENT_HTTP2_CONNECT_TIMEOUT
  • 说明：HTTP2 客户端的连接超时时间
  • 默认值：3000
  • 可选值：无
• CLIENT_HTTP2_VERIFY_HOST
  • 说明：是否验证主机
  • 默认值：off
  • 可选值：on | off
• CLIENT_WS_SHARED
  • 说明：是否共享 WebSocket 客户端
  • 默认值：on
  • 可选值：on | off
• CLIENT_WS_MAX_POOL_SIZE
  • 说明：WebSocket 客户端的最大池大小
  • 默认值：65535
  • 可选值：无
• CLIENT_WS_MAX_WAIT_QUEUE_SIZE
  • 说明：WebSocket 客户端的最大等待队列大小
  • 默认值：1024
  • 可选值：无
• CLIENT_WS_IDLE_TIMEOUT
  • 说明：WebSocket 客户端的空闲超时时间
  • 默认值：300000
  • 可选值：无
• CLIENT_WS_CONNECT_TIMEOUT
  • 说明：WebSocket 客户端的连接超时时间
  • 默认值：3000
  • 可选值：无
• CLIENT_WS_VERIFY_HOST
  • 说明：是否验证主机
  • 默认值：off
  • 可选值：on | off
• REGISTRY_BACKEND
  • 说明：注册中心后端类型
  • 默认值：zookeeper
  • 可选值：etcd | zookeeper
• REGISTRY_NAMESPACE
  • 说明：注册中心的命名空间
  • 默认值：/io/kunlun
  • 可选值：无
• REGISTRY_SERVERS
  • 说明：注册中心服务器地址
  • 默认值：127.0.0.1:2181
  • 可选值：无
• REGISTRY_USERNAME
  • 说明：注册中心用户名
  • 默认值：无
  • 可选值：无
• REGISTRY_PASSWORD
  • 说明：注册中心密码
  • 默认值：无
  • 可选值：无
• OTEL_TRACE_ENABLED
  • 说明：是否启用跟踪
  • 默认值：off
  • 可选值：on | off
• OTEL_TRACE_PROPAGATORS
  • 说明：跟踪传播器
  • 默认值：tracecontext,baggage
  • 可选值：无
• OTEL_TRACE_SAMPLE_RATIO
  • 说明：跟踪采样率
  • 默认值：0.01
  • 可选值：无
• OTEL_TRACE_OTLP_ENDPOINT
  • 说明：OTLP 跟踪端点
  • 默认值：无
  • 可选值：无
• OTEL_TRACE_OTLP_HEADERS
  • 说明：OTLP 跟踪头部
  • 默认值：无
  • 可选值：无
• OTEL_TRACE_OTLP_TIMEOUT
  • 说明：OTLP 跟踪超时时间
  • 默认值：无
  • 可选值：无
• OTEL_TRACE_ZIPKIN_ENDPOINT
  • 说明：Zipkin 跟踪端点
  • 默认值：无
  • 可选值：无
• OTEL_TRACE_ZIPKIN_TIMEOUT
  • 说明：Zipkin 跟踪超时时间
  • 默认值：10s
  • 可选值：无
• OTEL_METRICS_ENABLED
  • 说明：是否启用指标
  • 默认值：off
  • 可选值：on | off
• OTEL_METRICS_PROMETHEUS_HOST
  • 说明：Prometheus 地址
  • 默认值：无
  • 可选值：无
• OTEL_METRICS_PROMETHEUS_PORT
  • 说明：Prometheus 端口
  • 默认值：无
  • 可选值：无
• OTEL_METRICS_PROMETHEUS_ENDPOINT
  • 说明：Prometheus 端点
  • 默认值：/metrics
  • 可选值：无
• ACCESS_LOG_DIR
  • 说明：访问日志目录
  • 默认值：/var/log/kunlun-proxy
  • 可选值：无
• ACCESS_LOG_AGE
  • 说明：访问日志保留时间
  • 默认值：15d
  • 可选值：无
• ACCESS_LOG_LEXER
  • 说明：访问日志解析器
  • 默认值：无
  • 可选值：nginx | apache
• ACCESS_LOG_FORMAT
  • 说明：访问日志格式
  • 默认值：无
  • 可选值：json | text
• ERROR_LOG_LEVEL
  • 说明：错误日志级别
  • 默认值：info
  • 可选值：无
• ERROR_LOG_DIR
  • 说明：错误日志目录
  • 默认值：/var/log/kunlun-proxy
  • 可选值：无
• ERROR_LOG_AGE
  • 说明：错误日志保留时间
  • 默认值：15d
  • 可选值：无

kunlun-pilot

TIP

配置文件路径为：/etc/default/kunlun-pilot

• JAVA_OPTS
  • 说明：Java 运行时的相关配置参数
  • 默认值：" -Duser.timezone=Asia/Shanghai -Duser.language=zh -Duser.region=CN -XX:+UseG1GC -XX:G1HeapRegionSize=16m -XX:G1ReservePercent=25 -XX:InitiatingHeapOccupancyPercent=30"
  • 可选值：无
• JAVA_HOME
  • 说明：Java 安装目录的环境变量
  • 默认值：无
  • 可选值：无
• HTTP_HOST
  • 说明：HTTP 服务的主机地址
  • 默认值：0.0.0.0
  • 可选值：无
• HTTP_PORT
  • 说明：HTTP 服务的端口
  • 默认值：9000
  • 可选值：无
• HTTP_CONTEXT
  • 说明：HTTP 服务的上下文路径
  • 默认值：/
  • 可选值：无
• HTTP_SECRET
  • 说明：HTTP 服务的密钥
  • 默认值：无
  • 可选值：无
• HTTP_BANNER
  • 说明：HTTP 服务的横幅信息
  • 默认值：无
  • 可选值：无
• HTTP_SESSION_MAX_AGE
  • 说明：HTTP 会话的最大存活时间
  • 默认值：30m
  • 可选值：无
• SERVICE_LOG
  • 说明：服务日志级别
  • 默认值：info
  • 可选值：无
• SERVICE_NAME
  • 说明：服务名称
  • 默认值：kunlun-pilot
  • 可选值：无
• SERVICE_PIDFILE_PATH
  • 说明：服务的 PID 文件路径
  • 默认值：/dev/null
  • 可选值：无
• SERVER_ERROR_LOG
  • 说明：服务器错误日志是否启用
  • 默认值：on
  • 可选值：on | off
• SERVER_ERROR_LOG_VERBOSE
  • 说明：服务器错误日志是否详细
  • 默认值：on
  • 可选值：on | off
• SECURITY_HASH_ITERATIONS
  • 说明：安全哈希的迭代次数
  • 默认值：16
  • 可选值：无
• SECURITY_HASH_SALT
  • 说明：安全哈希的盐值
  • 默认值：无
  • 可选值：无
• DB_DRIVER
  • 说明：数据库驱动类型
  • 默认值：mysql
  • 可选值：mysql | postgres
• DB_MYSQL_URL
  • 说明：MySQL 数据库的连接 URL
  • 默认值："jdbc:mysql://localhost:3306/kunlun?PublicKeyRetrieval=true&useSSL=false&user=kunlun&password=kunlun"
  • 可选值：无
• DB_MYSQL_ISOLATION
  • 说明：MySQL 数据库的隔离级别
  • 默认值：READ_COMMITTED
  • 可选值：无
• DB_POSTGRES_URL
  • 说明：PostgreSQL 数据库的连接 URL
  • 默认值："jdbc:postgresql://127.0.0.1:5432/kunlun"
  • 可选值：无
• DB_POSTGRES_ISOLATION
  • 说明：PostgreSQL 数据库的隔离级别
  • 默认值：READ_COMMITTED
  • 可选值：无
• DB_THREADS
  • 说明：数据库连接的线程数
  • 默认值：128
  • 可选值：无
• DB_MIN_CONNECTIONS
  • 说明：数据库的最小连接数
  • 默认值：16
  • 可选值：无
• DB_MAX_CONNECTIONS
  • 说明：数据库的最大连接数
  • 默认值：128
  • 可选值：无
• DB_IDLE_TIMEOUT
  • 说明：数据库连接的空闲超时时间
  • 默认值：5m
  • 可选值：无
• DB_MAX_LIFETIME
  • 说明：数据库连接的最大存活时间
  • 默认值：10m
  • 可选值：无
• DB_CONNECTION_TIMEOUT
  • 说明：数据库连接的超时时间
  • 默认值：3s
  • 可选值：无
• DB_TABLE_SETUP
  • 说明：数据库表的设置状态
  • 默认值：off
  • 可选值：on | off
• DB_TABLE_SCHEMA
  • 说明：数据库表的模式
  • 默认值：kunlun
  • 可选值：无

kunlun-dapr

TIP

配置文件路径为：/etc/default/kunlun-dapr

• JAVA_OPTS
  • 说明：Java 运行时的相关配置参数
  • 默认值：" -Djdk.tls.rejectClientInitiatedRenegotiation=true -Dvertx.disableTCCL=true -Dvertx.disableWebsockets=true -Duser.timezone=Asia/Shanghai -Duser.language=zh -Duser.region=CN -XX:+HeapDumpOnOutOfMemoryError -XX:InitiatingHeapOccupancyPercent=30"
  • 可选值：无
• JAVA_HOME
  • 说明：Java 安装目录的环境变量
  • 默认值：无
  • 可选值：无
• SERVER_NAMESPACE
  • 说明：服务的命名空间
  • 默认值：default
  • 可选值：无
• SERVER_BIND_HOST
  • 说明：服务监听地址
  • 默认值：0.0.0.0
  • 可选值：无
• SERVER_BIND_PORT
  • 说明：服务监听端口
  • 默认值：12345
  • 可选值：无
• SERVER_PUBLIC_HOST
  • 说明：服务暴露地址
  • 默认值：无
  • 可选值：无
• SERVER_PUBLIC_PORT
  • 说明：服务暴露端口
  • 默认值：12345
  • 可选值：无
• SERVER_SOCKET_ENABLED
  • 说明：是否启用服务套接字
  • 默认值：off
  • 可选值：on | off
• SERVER_SOCKET_FILE
  • 说明：服务套接字文件路径
  • 默认值：/run/kunlun-dapr/server.sock
  • 可选值：无
• SERVER_LOG_DATA_ACTIVITY
  • 说明：是否记录服务的日志数据活动
  • 默认值：on
  • 可选值：on | off
• SERVER_LOG_DATA_FORMAT
  • 说明：服务日志数据格式
  • 默认值：hexdump
  • 可选值：hexdump | simple
• SERVER_CA_FILE
  • 说明：服务的 CA 文件路径
  • 默认值：无
  • 可选值：无
• SERVER_KEY_FILE
  • 说明：服务的密钥文件路径
  • 默认值：无
  • 可选值：无
• SERVER_CERT_FILE
  • 说明：服务的证书文件路径
  • 默认值：无
  • 可选值：无
• ENGINE_HEARTBEAT_THRESHOLD
  • 说明：引擎心跳阈值
  • 默认值：10.0
  • 可选值：无
• ENGINE_HEARTBEAT_INTERVAL
  • 说明：引擎心跳间隔
  • 默认值：5000
  • 可选值：无
• ENGINE_MAX_HEARTBEAT_SAMPLE_SIZE
  • 说明：引擎最大心跳样本大小
  • 默认值：128
  • 可选值：无
• ENGINE_ACCEPTABLE_HEARTBEAT_PAUSE
  • 说明：引擎可接受的心跳暂停时间
  • 默认值：10000
  • 可选值：无
• ENGINE_MAX_INBOUND_HEADER_SIZE
  • 说明：引擎最大入站头部大小
  • 默认值：8192
  • 可选值：无
• ENGINE_MAX_INBOUND_FRAME_SIZE
  • 说明：引擎最大入站帧大小
  • 默认值：8388608
  • 可选值：无
• ENGINE_LOCAL_PREFERRED
  • 说明：是否优先本地引擎
  • 默认值：on
  • 可选值：on | off
• ENGINE_LOCAL_BOOST
  • 说明：本地引擎的提升值
  • 默认值：2.0
  • 可选值：无
• REGISTRY_BACKEND
  • 说明：注册中心后端类型
  • 默认值：无
  • 可选值：etcd | zookeeper
• REGISTRY_NAMESPACE
  • 说明：注册中心的命名空间
  • 默认值：无
  • 可选值：无
• REGISTRY_SERVERS
  • 说明：注册中心服务器地址
  • 默认值：无
  • 可选值：无
• REGISTRY_USERNAME
  • 说明：注册中心用户名
  • 默认值：无
  • 可选值：无
• REGISTRY_PASSWORD
  • 说明：注册中心密码
  • 默认值：无
  • 可选值：无
• OTEL_TRACE_ENABLED
  • 说明：是否启用跟踪
  • 默认值：off
  • 可选值：on | off
• OTEL_TRACE_PROPAGATORS
  • 说明：跟踪传播器
  • 默认值：tracecontext,baggage
  • 可选值：无
• OTEL_TRACE_SAMPLE_RATIO
  • 说明：跟踪采样率
  • 默认值：0.01
  • 可选值：无
• OTEL_TRACE_OTLP_ENDPOINT
  • 说明：OTLP 跟踪端点
  • 默认值：无
  • 可选值：无
• OTEL_TRACE_OTLP_HEADERS
  • 说明：OTLP 跟踪头部
  • 默认值：无
  • 可选值：无
• OTEL_TRACE_OTLP_TIMEOUT
  • 说明：OTLP 跟踪超时时间
  • 默认值：无
  • 可选值：无
• OTEL_TRACE_ZIPKIN_ENDPOINT
  • 说明：Zipkin 跟踪端点
  • 默认值：无
  • 可选值：无
• OTEL_TRACE_ZIPKIN_TIMEOUT
  • 说明：Zipkin 跟踪超时时间
  • 默认值：10s
  • 可选值：无
• OTEL_METRICS_ENABLED
  • 说明：是否启用指标
  • 默认值：off
  • 可选值：on | off
• OTEL_METRICS_PROMETHEUS_HOST
  • 说明：Prometheus 地址
  • 默认值：无
  • 可选值：无
• OTEL_METRICS_PROMETHEUS_PORT
  • 说明：Prometheus 端口
  • 默认值：无
  • 可选值：无
• OTEL_METRICS_PROMETHEUS_ENDPOINT
  • 说明：Prometheus 端点
  • 默认值：/metrics
  • 可选值：无
• ACCESS_LOG_DIR
  • 说明：访问日志目录
  • 默认值：/var/log/kunlun-dapr
  • 可选值：无
• ACCESS_LOG_AGE
  • 说明：访问日志保留时间
  • 默认值：15d
  • 可选值：无
• ACCESS_LOG_FORMAT
  • 说明：访问日志格式
  • 默认值：无
  • 可选值：json | text
• ACCESS_LOG_PATTERN
  • 说明：访问日志模式
  • 默认值：%h - [%t] "%u" "%m" "%{grpc-timeout}i" %A %s %d
  • 可选值：无
• ACCESS_LOG_BUFFER_SIZE
  • 说明：访问日志缓冲区大小
  • 默认值：128
  • 可选值：无
• ERROR_LOG_LEVEL
  • 说明：错误日志级别
  • 默认值：info
  • 可选值：debug | info | warn | error
• ERROR_LOG_DIR
  • 说明：错误日志目录
  • 默认值：/var/log/kunlun-dapr
  • 可选值：无
• ERROR_LOG_AGE
  • 说明：错误日志保留时间
  • 默认值：15d
  • 可选值：无

accesslog

占位符	说明
$scheme	请求 Scheme
$host	请求 Host
$uri	请求路径
$request_length	请求 Content-Length
$request_method	请求方法
$request_time	请求耗时
$request_uri	请求 URI
$request_id	请求 ID
$request	请求起始行
$query_string	请求查询字符串
$args	请求查询字符串
$arg_xxx	请求查询 xxx 参数值
$cookie_xxx	请求 Cookie xxx 值
$time_local	请求时间，dd/MMM/yyyy:HH:mm:ss Z 格式
$time_iso8601	请求时间，iso8601 格式
$http_x_forwarded_for	请求 X-Forwarded-For
$http_user_agent	请求 User-Agent
$http_referer	请求 Referer
$http_origin	请求 Origin
$http_host	请求 Host
$http_xxx	请求 xxx 头部
$content_length	请求 Content-Length
$content_type	请求 Content-Type
$bytes_received	暂不支持
$bytes_sent	暂不支持
$body_bytes_received	请求正文字节数
$body_bytes_sent	响应正文字节数
$status	响应状态码
$sent_http_transfer_encoding	响应 Transfer-Encoding
$sent_http_content_type	响应 Content-Type
$sent_http_location	响应 Location
$sent_http_xxx	响应 xxx 头部
$upstream_addr	上游地址
$upstream_status	上游状态码
$upstream_response_time	暂不支持
$remote_addr	客户端地址
$remote_port	客户端端口
$server_addr	服务地址
$server_name	服务地址
$server_port	服务端口
$server_protocol	服务端协议