登录
目录
当前位置： 首页 > 文档资料 > EnvoyProxy 智能代理中文参考文档 >

1.8.13.1.2 HTTP连接管理

优质
小牛编辑
137浏览
2023-12-01

HTTP连接管理配置概述。

filter.network.HttpConnectionManager

filter.network.HttpConnectionManager proto

{
  "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": "{...}"
}

  • codec_type
    (filter.network.HttpConnectionManager.CodecType) 应用与连接管理器的编解码器类型。

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

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

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

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

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

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

  • add_user_agent
    (BoolValue) 连接管理器是否处理user-agent和x-envoy-downstream-service-cluster头。有关更多信息，请参阅相应的链接。默认为false。

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

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

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

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

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

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

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

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

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

  • forward_client_cert_details
    (filter.network.HttpConnectionManager.ForwardClientCertDetails) 如何处理x-forward-client-cert（XFCC）HTTP头。

  • set_current_client_cert_details
    (filter.network.HttpConnectionManager.SetCurrentClientCertDetails) 只有在forward_client_cert_details为APPEND_FORWARD或SANITIZE_SET且客户端连接为mTLS时，此字段才有效。它指定要转发的客户端证书中的字段。请注意，在x-forwarded-client-cert头中，始终设置Hash，并在客户端证书显示SAN值时始终设置By。

filter.network.HttpConnectionManager.Tracing

filter.network.HttpConnectionManager.Tracing proto

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

  • operation_name
    (filter.network.HttpConnectionManager.Tracing.OperationName) span名将由此字段生成。

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

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

filter.network.HttpConnectionManager.Tracing.OperationName proto

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

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

filter.network.HttpConnectionManager.SetCurrentClientCertDetails (Enum)

filter.network.HttpConnectionManager.SetCurrentClientCertDetails proto

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

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

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

filter.network.HttpConnectionManager.CodecType (Enum)

filter.network.HttpConnectionManager.CodecType proto

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

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

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

filter.network.HttpConnectionManager.ForwardClientCertDetails (Enum)

filter.network.HttpConnectionManager.ForwardClientCertDetails proto

如何处理x-forward-client-cert（XFCC）HTTP头。

  • 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

filter.network.Rds proto

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

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

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

filter.network.HttpFilter

filter.network.HttpFilter proto

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

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

    • 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

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

返回

  • 上一级
免责声明： 以上内容版权归原作者所有，如有侵犯您的原创版权请告知，我们将尽快删除相关内容。感谢每一位辛勤著写的作者，感谢每一位的分享。
@小牛知识库 xnip.cn