envoy 中文参考文档
  • 首页
  • 简介
    • Envoy是什么
    • 架构介绍
      • 术语
      • 线程模型
      • 监听器
      • L3/L4网络过滤器
      • HTTP连接管理
      • HTTP过滤器
      • HTTP路由
      • gRPC
      • WebSocket支持
      • 集群管理
      • 服务发现
      • 健康检查
      • 连接池
      • 负载均衡
      • 异常检测
      • 熔断
      • 全局限速
      • TLS
      • 统计
      • 运行时配置
      • 跟踪
      • TCP代理
      • 访问日志
      • MongoDB
      • DynamoDB
      • Redis
      • 热重启
      • 动态配置
      • 初始化
      • 逐出
      • 脚本
    • 部署
    • 业界对比
    • 获得帮助
    • 历史版本
  • 编译安装
    • 编译
    • 参考配置
    • 演示沙箱
      • 前端代理
      • Zipkin跟踪
      • Jaeger跟踪
      • gRPC桥接
      • 构建Envoy Docker镜像
    • 工具
  • 配置参考
    • V1 API 概述
    • V2 API 概述
    • 监听器
    • 网络过滤器
      • TLS客户端身份认证
      • Echo
      • Mongo代理
      • 速率限制
      • Redis代理
      • TCP代理
    • HTTP连接管理器
      • 路由匹配
      • 流量转移/分流
      • HTTP头部操作
      • HTTP头部清理
      • 统计
      • 运行时设置
      • 路由发现服务
    • HTTP过滤器
      • 缓存
      • CORS过滤器
      • 故障注入
      • DynamoDB
      • gRPC HTTP/1.1 桥接
      • gRPC-JSON 转码过滤器
      • gRPC-Web 过滤器
      • 健康检查
      • 速率限制
      • 路由
      • Lua
    • 集群管理
      • 统计
      • 运行时设置
      • 集群发现服务
      • 健康检查
      • 熔断
    • 访问日志
    • 限速服务
    • 运行时配置
    • 路由表检查工具
  • 运维管理
    • 命令行选项
    • 热重启
    • 管理接口
    • 统计概述
    • 运行时配置
    • 文件系统
  • 自定义扩展示例
  • V1 API参考
    • 监听器
    • 网络过滤器
      • TLS客户端身份认证
      • Echo
      • HTTP连接管理
      • Mongo代理
      • 速率限制
      • Redis代理
      • TCP代理
    • HTTP路由配置
      • 虚拟主机
      • 路由
      • 虚拟集群
      • 速率限制配置
      • 路由发现服务
    • HTTP过滤器
      • 缓存
      • CORS过滤器
      • DynamoDB
      • 故障注入
      • gRPC HTTP/1.1 桥接
      • gRPC-JSON 转码过滤器
      • gRPC-Web 过滤器
      • 健康检查
      • Lua
      • 速率限制
      • 路由
    • 集群管理
      • 集群
        • 健康检查
        • 熔断
        • TLS上下文
        • 异常值检测
        • HASH环负载均衡配置
      • 异常检测
      • 集群发现服务
      • 服务发现服务
    • 访问日志
    • 管理接口
    • 限速服务
    • 运行时配置
    • 跟踪
  • V2 API参考
    • 启动引导
    • 监听&监听发现
    • 集群&集群发现
    • 服务发现
    • 健康检查
    • HTTP路由管理&发现
    • TLS配置
    • 通用的类型
    • 网络地址
    • 协议选项
    • 发现API
    • 限速组件
    • 过滤器
      • 网络过滤器
        • TLS客户端身份认证
        • HTTP连接管理
        • Mongo代理
        • 速率限制
        • Redis代理
        • TCP代理
      • HTTP过滤器
        • 缓存
        • 故障注入
        • 健康检查
        • Lua
        • 速率限制
        • 路由
        • gRPC-JSON转码器
      • 常见访问日志类型
      • 常见故障注入类型
  • FAQ
    • Envoy有多快?
    • 我在哪里获得二进制文件?
    • 我如何设置SNI?
    • 如何设置区域感知路由?
    • 我如何设置Zipkin跟踪?
Powered by GitBook
On this page
  • HTTP连接管理
  • filter.network.HttpConnectionManager
  • filter.network.HttpConnectionManager.Tracing
  • filter.network.HttpConnectionManager.Tracing.OperationName (Enum)
  • filter.network.HttpConnectionManager.SetCurrentClientCertDetails (Enum)
  • filter.network.HttpConnectionManager.CodecType (Enum)
  • filter.network.HttpConnectionManager.ForwardClientCertDetails (Enum)
  • filter.network.Rds
  • filter.network.HttpFilter
  • 返回

Was this helpful?

  1. V2 API参考
  2. 过滤器
  3. 网络过滤器

HTTP连接管理

PreviousTLS客户端身份认证NextMongo代理

Last updated 5 years ago

Was this helpful?

HTTP连接管理

HTTP连接管理。

filter.network.HttpConnectionManager

{
  "codec_type": "...",
  "stat_prefix": "...",
  "rds": "{...}",
  "route_config": "{...}",
  "http_filters": [],
  "add_user_agent": "{...}",
  "tracing": "{...}",
  "http_protocol_options": "{...}",
  "http2_protocol_options": "{...}",
  "server_name": "...",
  "idle_timeout": "{...}",
  "drain_timeout": "{...}",
  "access_log": [],
  "use_remote_address": "{...}",
  "generate_request_id": "{...}",
  "forward_client_cert_details": "...",
  "set_current_client_cert_details": "{...}"
}
  • 必须正确设置rds,route_config其中一个。

  • 必须正确设置rds,route_config其中一个。

filter.network.HttpConnectionManager.Tracing

{
  "operation_name": "...",
  "request_headers_for_tags": []
}

filter.network.HttpConnectionManager.Tracing.OperationName (Enum)

  • INGRESS (DEFAULT) 标记HTTP监听器用于入站/入口请求。

  • EGRESS 标记HTTP监听器用于出站/出口请求。

filter.network.HttpConnectionManager.SetCurrentClientCertDetails (Enum)

{
  "subject": "{...}",
  "san": "{...}"
}

filter.network.HttpConnectionManager.CodecType (Enum)

  • AUTO (DEFAULT) 对于每个新的连接,连接管理器将自行决定使用哪个编解码器。此模式支持TLS监听器的ALPN以及监听器明文的协议。如果ALPN数据可用,则优选,否则使用协议解析。在几乎所有情况下,这是优选的设置。

  • HTTP1 连接管理器将假定客户端使用HTTP/1.1协议。

  • HTTP2 连接管理器将假定客户端使用HTTP/2(Envoy不需要通过TLS发送HTTP/2或者使用ALPN,事先预知的)。

filter.network.HttpConnectionManager.ForwardClientCertDetails (Enum)

  • SANITIZE (DEFAULT) 不要将XFCC头部发送到下一跳。这是默认值。

  • FORWARD_ONLY 当客户端连接是mTLS(Mutual TLS)时,转发请求中的XFCC头。

  • APPEND_FORWARD 当客户端连接是mTLS时,将客户端证书信息附加到请求的XFCC头并转发它。

  • SANITIZE_SET 当客户端连接是mTLS时,使用客户端证书信息重置XFCC头,并将其发送到下一个跃点。

  • ALWAYS_FORWARD_ONLY 始终在请求中转发XFCC头,而不管客户端连接是否为mTLS。

filter.network.Rds

{
  "config_source": "{...}",
  "route_config_name": "..."
}

filter.network.HttpFilter

{
  "name": "...",
  "config": "{...}"
}

返回

codec_type () 应用与连接管理器的编解码器类型。

stat_prefix (, REQUIRED) 连接管理器发布的统计信息所使用的前缀。有关更多信息,请参阅。

rds () 通过RDS API动态加载连接管理器的路由表。

route_config () 在此属性中指定静态的连接管理器的路由表。

http_filters () 构成连接管理器请求的过滤器链,包括各个HTTP过滤器的列表。当请求发生时,将按照顺序处理过滤器。

add_user_agent () 连接管理器是否处理和头。有关更多信息,请参阅相应的链接。默认为false。

tracing () 是否定义对象,决定连接管理器是否将跟踪数据发送到已配置的跟踪服务程序中。

http_protocol_options () 传递给HTTP/1编解码器,额外的HTTP/1设置选项。

http2_protocol_options () 额外的HTTP/2设置选项,直接传递给HTTP/2编解码器。

server_name () 连接管理器将在响应头中写入响应的服务名。如果未设置,则默认为Enovy。

idle_timeout () 由连接管理器管理的连接空闲超时时长。在没有活动的请求时,持续的时间超过设定的阈值,则认为连接超时。如果没有设置,则没有空闲超时。当达到空闲超时后,连接将被关闭。如果连接是HTTP/2连接,则在关闭连接之前会发生顺序排空。看。

drain_timeout () Envoy将在发送HTTP/2“关闭通知”(GOAWAY帧与最大流ID)和最终GOAWAY帧之间等待的时间。这是为了让Envoy支持与最后GOAWAY帧竞争的新的流处理,所提供的宽限期。在这个宽限期间,Envoy将继续接受新的流。在宽限期之后,最终GOAWAY帧被发送,Envoy将开始拒绝新的流。在连接遇到空闲超时或通用服务器耗尽时都会发生排空。如果未指定此选项,则默认宽限期为5000毫秒(5秒)。

access_log () 从连接管理器发出的HTTP访问日志的配置。

use_remote_address () 如果设置为true,连接管理器将在确定内部和外部源以及操作各种头部时使用客户端连接的真实远程地址。如果设置为false或不存在,连接管理器将使用x-forwarded-forHTTP头。有关更多信息,请参阅,和的文档。

generate_request_id () 连接管理器是否会自动生成头,如果该头不存在。默认为true。生成一个随机的UUID4(性能代价比较大),所以在高吞吐量的情况下,这个功能是不需要的,它可以被禁用。

forward_client_cert_details () 如何处理(XFCC)HTTP头。

set_current_client_cert_details () 只有在为APPEND_FORWARD或SANITIZE_SET且客户端连接为mTLS时,此字段才有效。它指定要转发的客户端证书中的字段。请注意,在头中,始终设置Hash,并在客户端证书显示SAN值时始终设置By。

operation_name () span名将由此字段生成。

request_headers_for_tags () 用于为活动span创建标签的标题名称列表。该标题名用于填充span标记名,标题值用于填充span标记值。如果指定头的名称出现在请求头中,则会创建该标签。

subject () 是否转发客户端证书的标题。默认为false。

san () 是否转发客户端证书的SAN。默认为false。

如何处理(XFCC)HTTP头。

config_source (, REQUIRED) RDS的配置源描述符。

route_config_name (, REQUIRED) 配置的路由名称。这个名字将被传递给RDS API。这允许配置多个HTTP监听器(和关联的HTTP连接管理器)使用不同的路由配置。

name (, REQUIRED) 要实例化的过滤器的名称。该名称必须与支持的过滤器匹配。内置的过滤器有:

config () 指定的过滤器配置,这取决于被实例化的过滤器。有关更多文档,请参阅支持的过滤器。

string
统计文档
RouteConfiguration
string
Duration
filter.network.HttpConnectionManager.Tracing proto
string
filter.network.HttpConnectionManager.Tracing.OperationName proto
filter.network.HttpConnectionManager.SetCurrentClientCertDetails proto
BoolValue
BoolValue
filter.network.HttpConnectionManager.CodecType proto
filter.network.HttpConnectionManager.ForwardClientCertDetails proto
filter.network.Rds proto
string
filter.network.HttpFilter proto
string
envoy.buffer
envoy.cors
envoy.fault
envoy.http_dynamo_filter
envoy.grpc_http1_bridge
envoy.grpc_json_transcoder
envoy.grpc_web
envoy.health_check
envoy.lua
envoy.rate_limit
envoy.router
Struct
上一级
首页目录
配置概述
filter.network.HttpConnectionManager proto
filter.network.HttpConnectionManager
filter.network.HttpConnectionManager.Tracing
filter.network.HttpConnectionManager.Tracing.OperationName (Enum)
filter.network.HttpConnectionManager.SetCurrentClientCertDetails
filter.network.HttpConnectionManager.CodecType (Enum)
filter.network.HttpConnectionManager.ForwardClientCertDetails (Enum)
filter.network.Rds
filter.network.HttpFilter
filter.network.HttpConnectionManager.CodecType
filter.network.Rds
filter.network.HttpFilter
filter.network.HttpConnectionManager.Tracing
Http1ProtocolOptions
Http2ProtocolOptions
Duration
drain_timeout
filter.accesslog.AccessLog
filter.network.HttpConnectionManager.Tracing.OperationName
x-forward-client-cert
ConfigSource
BoolValue
BoolValue
BoolValue
filter.network.HttpConnectionManager.ForwardClientCertDetails
filter.network.HttpConnectionManager.SetCurrentClientCertDetails
forward_client_cert_details
user-agent
x-envoy-downstream-service-cluster
x-forwarded-for
x-envoy-internal
x-envoy-external-address
x-request-id
x-forward-client-cert
x-forwarded-client-cert