配置 Sōzu¶

在深入了解代理的配置部分之前，如果您还没有阅读入门文档，建议您先阅读一下。

配置文件¶

配置文件使用 .toml 格式。

Sōzu 配置过程涉及 3 个主要参数来源：

global 部分，用于设置进程范围的参数。
https、http、tcp 等协议的定义。
[clusters]下的集群部分。

全局参数¶

全局部分中的参数允许您定义主进程和工作进程共享的全局设置（例如日志级别）：

参数	描述	可能的值
`saved_state`	sozu 启动时尝试加载其状态的路径
`log_level`	可能的值为	`debug`、`trace`、`error`、`warn`、`info`
`log_target`	可能的值为	`stdout, tcp or udp address`
`access_logs_target`	可能的值为（如果激活，则将访问日志发送到单独的目标）	`stdout`、`tcp` 或 `udp address`
`command_socket`	unix 命令套接字的路径
`command_buffer_size`	主进程用于处理命令的缓冲区大小（以字节为单位）。
`max_command_buffer_size`	主进程用于处理命令的缓冲区的最大大小。
`worker_count`	工作进程数
`worker_automatic_restart`	如果激活，则重新启动出现紧急情况或崩溃的工作进程（默认激活）
`handle_process_affinity`	将工作进程绑定到 cpu 内核。
`max_connections`	最大同时/打开的连接数
`max_buffers`	用于代理的最大缓冲区数
`min_buffers`	为代理预分配的最小缓冲区数
`buffer_size`	工作进程使用的请求缓冲区大小（以字节为单位）
`ctl_command_timeout`	命令行等待命令完成的最长时间
`pid_file_path`	将 pid 存储在特定文件位置
`front_timeout`	前端套接字的最长不活动时间
`connect_timeout`	请求连接的最长不活动时间
`request_timeout`	请求的最长不活动时间
`zombie_check_interval`	僵尸会话检查之间的持续时间
`activate_listeners`	自动启动监听器

示例：

command_socket = "./command_folder/sock"
saved_state = "./state.json"
log_level = "info"
log_target = "stdout"
command_buffer_size = 16384
worker_count = 2
handle_process_affinity = false
max_connections = 500
max_buffers = 500
buffer_size = 16384
activate_listeners = true

监听器¶

listener 部分描述了一组接受客户端连接的侦听套接字。您可以根据需要定义任意数量的侦听器。它们遵循以下格式：

通用参数：

[[listeners]]
# 可能的值是 http、https 或 tcp
protocol = "http"
# 监听地址
address = "0.0.0.0:8080"
# address = "[::]:8080"

# 为日志和转发的标头指定一个不同于套接字所见的 IP
# public_address = "1.2.3.4:80

# 配置客户端套接字以接收 PROXY 协议标头
# expect_proxy = false

HTTP 和 HTTPS 侦听器的特定选项¶

从 1.0.0 版本开始，Sōzu 允许为 HTTP 和 HTTPS 侦听器定义自定义 HTTP 应答。

这些应答是可定制的：

301 永久移动
400 错误请求
401 未经授权
404 未找到
408 请求超时
413 负载过大
502 错误网关
503 服务不可用
504 网关超时
507 存储空间不足

这些应答应以任何扩展名的纯文本文件提供（为清晰起见，我们建议使用 .http），并且可能如下所示：

HTTP/1.1 404 Not Found
Cache-Control: no-cache
Connection: close
Sozu-Id: %REQUEST_ID

<style>pre{background:#EEE;padding:10px;border:1px solid #AAA;border-radius: 5px;}</style>
<h1>404 Not Found</h1>

<p>在此处插入您的自定义文本，实际上，所有 HTML 都是可更改的，包括 CSS。</p>

<pre>
{
    "route": "%ROUTE",
    "request_id": "%REQUEST_ID",
}
</pre>
<footer>这是 Sozu 的自动应答。</footer>",

有许多可用的模板变量，例如 REQUEST_ID 或 CLUSTER_ID，在生成错误时，代理逻辑将替换它们。

要创建您自己的自定义 HTTP 应答，我们强烈建议您首先复制 lib/src/protocol/kawa_h1/answers.rs 中存在的默认应答，然后根据自己的喜好进行更改。为清晰起见，请随时删除默认字符串的 \r 换行符。 Sōzu 将解析您的文件并替换您使用的任何换行符。

然后，对于每个侦听器，提供每个自定义应答的绝对路径。

# 当 sozu 不知道请求的域或路径时，将发送 404 响应
answer_404 = "/path/to/my-404-answer.http"
# 如果没有可用的后端服务器，则发送 503 响应
answer_503 = "/path/to/my-503-answer.http"
# answer_507 = ...

如果前端具有 sticky_session，则粘性名称在侦听器级别定义。

# 定义粘性会话 cookie 的名称，如果 `sticky_session` 被激活
# a cluster。默认为“SOZUBALANCEID”
sticky_name = "SOZUBALANCEID"

HTTPS 侦听器的特定选项¶

# 支持的 TLS 版本。可能的值为“SSL_V2”、“SSL_V3”、
# “TLS_V12”、“TLS_V13”。默认为“TLS_V12”和“TLS_V13”
tls_versions = ["TLS_V12", "TLS_V13"]

基于 Rustls 的 HTTPS 侦听器的特定选项¶

# 基于 rustls 的 HTTPS 侦听器的特定选项
cipher_list = [
    # TLS 1.3 密码套件
    "TLS13_AES_256_GCM_SHA384",
    "TLS13_AES_128_GCM_SHA256",
    "TLS13_CHACHA20_POLY1305_SHA256",
    # TLS 1.2 密码套件
    "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384",
    "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256",
    "TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256",
    "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384",
    "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256",
    "TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256",
]

集群¶

您可以在 [clusters] 部分下声明您的 clusters 列表。它们遵循以下格式：

强制参数：

[clusters]

[clusters.NameOfYourCluster]
# 可能的值是 http 或 tcp
# https 代理将在此处使用 http
protocol = "http"

# 每个集群的负载均衡算法。可能的值是
# “roundrobin”和“random”。默认为“roundrobin”
# load_balancing_policy="roundrobin"

# 强制集群将 http 流量重定向到 https
# https_redirect = true

frontends = [
  { address = "0.0.0.0:8080", hostname = "lolcatho.st" },
  { address = "0.0.0.0:8443", hostname = "lolcatho.st", certificate = "../lib/assets/certificate.pem", key = "../lib/assets/key.pem", certificate_chain = "../lib/assets/certificate_chain.pem" }
]
# 前端的其他选项：sticky_session（布尔值）

backends  = [
  { address = "127.0.0.1:1026" }
]

指标¶

Sōzu 通过 UDP 套接字向另一个网络组件报告其自身状态。主进程和工作进程负责发送其状态。我们实现 statsd 协议以发送统计信息。然后，任何理解 statsd 协议的服务都可以从 Sōzu 收集指标。

配置指标¶

在您的 config.toml 中，您可以通过添加以下内容来定义外部服务的地址和端口：

[metrics]
address = "127.0.0.1:8125"
# 使用 InfluxDB 的 statsd 协议风格添加标签
# tagged_metrics = false
# 指标键前缀
# prefix = "sozu"

目前，我们无法更改发送消息的频率。

外部服务示例¶

statsd
grad

PROXY 协议¶

当网络流通过代理时，后端服务器只能看到代理用作客户端地址的 IP 地址和端口。真正的源 IP 地址和端口只能被代理看到。由于此信息对于日志记录、安全性等很有用，因此开发了 PROXY 协议以将其传输到后端服务器。使用此协议，在连接到后端服务器后，代理将首先发送一个小的标头，指示客户端 IP 地址和端口，以及代理的接收 IP 地址和端口，然后将发送来自客户端的流。

Sōzu 在三种配置中支持 version 2 of the PROXY protocol：

“send”协议：Sōzu，在 TCP 代理模式下，会将标头发送到后端服务器
“expect”协议：Sōzu 从代理接收标头，为其自身的日志记录和指标解释它，并在 HTTP 转发标头中使用它
“relay”协议：Sōzu，在 TCP 代理模式下，可以接收标头，并将其传输到后端服务器

更多信息在这里：proxy-protocol spec

配置 Sōzu 以 expect PROXY 协议标头¶

在从套接字读取客户端发送的任何字节之前，配置面向客户端的连接以接收 PROXY 协议标头。

                           发送 PROXY                    期望 PROXY
                           协议头                        协议头
    +--------+
    | 客户端 |
    |        |             +---------+                   +------------+      +-----------+
    +--------+  ---------> | 代理    |                   | Sozu       |      | 上游      |
   /        /              |         |  ---------------> |            |------| 服务器    |
  /________/               +---------+                   +------------+      +-----------+

它受 HTTP、HTTPS 和 TCP 代理支持。

配置：

[[listeners]]
address = "0.0.0.0:80"
expect_proxy = true

将 Sōzu 配置为向上游后端发送 PROXY 协议标头¶

通过建立到集群中声明的后端的任何连接发送 PROXY 协议标头。

                           发送 PROXY
    +--------+             协议头
    | 客户端 |             +---------+
    |        |             | Sozu    |                +-----------------+
    +--------+  ---------> |         |  ------------> | 代理/上游       |
   /        /              |         |                | 服务器          |
  /________/               +---------+                +-----------------+

配置：

[[listeners]]
address = "0.0.0.0:81"

[clusters]
[clusters.NameOfYourTcpCluster]
send_proxy = true
frontends = [
  { address = "0.0.0.0:81" }
]

注意：仅适用于 TCP 集群（HTTP 和 HTTPS 代理将使用转发标头）。

配置 Sōzu 以将 PROXY 协议标头中继到上游¶

Sōzu 将从客户端连接接收 PROXY 协议标头，检查其有效性，然后将其转发到上游后端。这允许反向代理链而不会丢失客户端连接信息。

                           发送 PROXY                       期望 PROXY               发送 PROXY
                           协议头                           协议头                     协议头
    +--------+
    | 客户端 |
    |        |             +---------+                      +------------+             +-------------------+
    +--------+  +--------> | 代理    |                      | Sozu       |             | 代理/上游         |
   /        /              |         |                      |            | +---------> | 服务器            |
  /________/               +---------+                      +------------+             +-------------------+

配置：

这仅涉及 TCP 集群（HTTP 和 HTTPS 代理可以直接在 expect 模式下工作，并将使用转发标头）。

[[listeners]]
address = "0.0.0.0:80"
expect_proxy = true

[clusters]

[clusters.NameOfYourCluster]
send_proxy = true
frontends = [
  { address = "0.0.0.0:80" }
]

配置 Sōzu¶

配置文件¶

全局参数¶

监听器¶

HTTP 和 HTTPS 侦听器的特定选项¶

HTTPS 侦听器的特定选项¶

基于 Rustls 的 HTTPS 侦听器的特定选项¶

集群¶

指标¶

配置指标¶

外部服务示例¶

PROXY 协议¶

配置 Sōzu 以 expect PROXY 协议标头¶

将 Sōzu 配置为向 上游后端 发送 PROXY 协议标头¶

配置 Sōzu 以将 PROXY 协议标头 中继 到上游¶

将 Sōzu 配置为向上游后端发送 PROXY 协议标头¶

配置 Sōzu 以将 PROXY 协议标头中继到上游¶