1syntax = "proto3";
2
3package envoy.config.filter.http.router.v2;
4
5import "envoy/config/filter/accesslog/v2/accesslog.proto";
6
7import "google/protobuf/wrappers.proto";
8
9import "udpa/annotations/migrate.proto";
10import "udpa/annotations/status.proto";
11import "validate/validate.proto";
12
13option java_package = "io.envoyproxy.envoy.config.filter.http.router.v2";
14option java_outer_classname = "RouterProto";
15option java_multiple_files = true;
16option go_package = "github.com/envoyproxy/go-control-plane/envoy/config/filter/http/router/v2;routerv2";
17option (udpa.annotations.file_migrate).move_to_package = "envoy.extensions.filters.http.router.v3";
18option (udpa.annotations.file_status).package_version_status = FROZEN;
19
20// [#protodoc-title: Router]
21// Router :ref:`configuration overview <config_http_filters_router>`.
22// [#extension: envoy.filters.http.router]
23
24// [#next-free-field: 7]
25message Router {
26  // Whether the router generates dynamic cluster statistics. Defaults to
27  // true. Can be disabled in high performance scenarios.
28  google.protobuf.BoolValue dynamic_stats = 1;
29
30  // Whether to start a child span for egress routed calls. This can be
31  // useful in scenarios where other filters (auth, ratelimit, etc.) make
32  // outbound calls and have child spans rooted at the same ingress
33  // parent. Defaults to false.
34  bool start_child_span = 2;
35
36  // Configuration for HTTP upstream logs emitted by the router. Upstream logs
37  // are configured in the same way as access logs, but each log entry represents
38  // an upstream request. Presuming retries are configured, multiple upstream
39  // requests may be made for each downstream (inbound) request.
40  repeated accesslog.v2.AccessLog upstream_log = 3;
41
42  // Do not add any additional *x-envoy-* headers to requests or responses. This
43  // only affects the :ref:`router filter generated *x-envoy-* headers
44  // <config_http_filters_router_headers_set>`, other Envoy filters and the HTTP
45  // connection manager may continue to set *x-envoy-* headers.
46  bool suppress_envoy_headers = 4;
47
48  // Specifies a list of HTTP headers to strictly validate. Envoy will reject a
49  // request and respond with HTTP status 400 if the request contains an invalid
50  // value for any of the headers listed in this field. Strict header checking
51  // is only supported for the following headers:
52  //
53  // Value must be a ','-delimited list (i.e. no spaces) of supported retry
54  // policy values:
55  //
56  // * :ref:`config_http_filters_router_x-envoy-retry-grpc-on`
57  // * :ref:`config_http_filters_router_x-envoy-retry-on`
58  //
59  // Value must be an integer:
60  //
61  // * :ref:`config_http_filters_router_x-envoy-max-retries`
62  // * :ref:`config_http_filters_router_x-envoy-upstream-rq-timeout-ms`
63  // * :ref:`config_http_filters_router_x-envoy-upstream-rq-per-try-timeout-ms`
64  repeated string strict_check_headers = 5 [(validate.rules).repeated = {
65    items {
66      string {
67        in: "x-envoy-upstream-rq-timeout-ms"
68        in: "x-envoy-upstream-rq-per-try-timeout-ms"
69        in: "x-envoy-max-retries"
70        in: "x-envoy-retry-grpc-on"
71        in: "x-envoy-retry-on"
72      }
73    }
74  }];
75
76  // If not set, ingress Envoy will ignore
77  // :ref:`config_http_filters_router_x-envoy-expected-rq-timeout-ms` header, populated by egress
78  // Envoy, when deriving timeout for upstream cluster.
79  bool respect_expected_rq_timeout = 6;
80}
81